Skip to content

Hooks and Filters

Reign Sensei Addon exposes actions and filters so you can adjust its layout, reviews, group linking, and activity without editing the plugin. Every hook below is fired by the addon’s own code.

Filter Arguments Purpose
reign_sensei_course_loop_column_number int $columns Number of columns in the course loop (default 3).
reign_sensei_set_excerpt_length int $length Word length for the trimmed course excerpt (default 10), used on archive and My Courses surfaces.
reign_sensei_course_excerpt_length int $length Word length applied through the excerpt_length filter (default 10).
reign_sidebar_id_for_left_sidebar string $id Sidebar ID used for the left course sidebar (default left).
learnmate_modify_course_features_in_tab array $course_features The lessons/quizzes/students/certificate list in the single course sidebar.
lm_filter_course_author_url string $url, int $teacher_id Teacher/author link URL in the single course header.
Filter Arguments Purpose
reign_sensei_locate_template string $template, string $template_name, string $template_path The resolved template path.
Action Arguments Purpose
reign_sensei_before_template_part $template_name, $template_path, $located Fires before a plugin template is included.
reign_sensei_after_template_part $template_name, $template_path, $located Fires after a plugin template is included.

See Templates for the override paths.

These fire while rendering each review and the review list.

Hook Type Purpose
reign_sensei_course_before_comments_list action Before the review list (renders the ratings overview).
reign_sensei_course_review_before action Start of a review row (renders the avatar).
reign_sensei_course_review_meta action Review meta block.
reign_sensei_course_review_before_comment_meta action Before the comment meta (renders rating, then title).
reign_sensei_course_review_comment_text action Renders the review text.
wb_ld_course_review_before_comment_text action Before the review text.
wb_ld_course_review_after_comment_text action After the review text.
wb_ld_course_review_gravatar_size filter Avatar size for a review (default 60).
wb_ld_course_product_get_rating_html filter The star-rating HTML for a review ($html, $rating, $count).
wb_ld_course_review_analytics_exception filter Handle ratings outside the 1 to 5 range in the analytics tally.
reign-sensei_product_review_comment_form_args filter Comment/review form arguments.
reign-sensei_product_review_list_args filter wp_list_comments arguments for the review list.
learnmate_ld_star_review_color filter Star color for the rating widget (default #ffb606).

Fired around the group create, manage, and wp-admin settings saves.

Action Arguments
reign_sensei_create_group_screen_before_save int $group_id
reign_sensei_create_group_screen_after_save int $group_id
reign_sensei_group_manage_screen_before_save int $group_id
reign_sensei_group_manage_screen_after_save int $group_id
reign_sensei_group_admin_screen_before_save int $group_id
reign_sensei_group_admin_screen_after_save int $group_id
Filter Purpose
reign_sensei_courses_group_tab_name The group Courses tab label.
reign_sensei_get_courses_args WP_Query args for the course picker/search.
reign_get_sensei_courses The course query result.
reign_sensei_group_url Resolved group URL ($group_link, $group).
reign_sensei_get_user_url Resolved user profile URL ($url, $author_id).

Each learning event fires a before/after action and an args filter.

Event Before / after actions Args filter
Enrol reign_sensei_group_activity_after_enroll_before / _after reign_sensei_group_activity_after_enroll_args
Course complete reign_sensei_group_activity_completes_course_before / _after reign_sensei_group_activity_completes_course_args
Lesson complete reign_sensei_group_activity_complete_lesson_before / _after reign_sensei_group_activity_completed_lesson_args
Quiz finished reign_sensei_group_activity_quiz_finished_before / _after reign_sensei_group_activity_quiz_finished_args

Publishing activity action strings can be filtered with:

  • reign_sensei_create_course_activity_action
  • reign_sensei_lesson_create_activity_action (used for both lesson and quiz publishing action text)
Filter Purpose
reign_get_Sensei_settings The resolved Sensei settings ($settings, $keys, $default). Note the mixed-case name is intentional and kept for back-compatibility.
reign_sensei_group_integration_enable Boolean result of the group integration check.
reign_sensei_course_visibility Boolean result of the course visibility check.
reign_sensei_course_activities The enabled course-activity list.
reign_sensei_course_teacher_coteacher_id Teacher and co-teacher IDs for a course.
wbtm_sensei_vertical_tabs The settings sub-tabs shown on the Sensei LMS options tab.
get_default_reign_sensei_activity_content The default activity content templates.
Hook Purpose
reign_sensei_publish_course_activity Single scheduled event that posts a course publishing activity a couple of seconds after publish, so a course without a thumbnail at publish time still gets its image.