Helper Functions

The addon defines a set of shared helper functions in includes/reign-sensei-functions.php. They are procedural (no namespace) and are available once the addon has loaded. This page lists the ones useful to theme and addon developers.

Settings access

`reign_get_sensei_settings( $keys = '', $default_value = '' )`

Reads the addon’s settings out of the theme’s reign_options['sensei'] store. Pass a dot-separated key path (or an array of keys) to read a nested value, with a default when the key is not set. Returns the full settings array when no key is passed. The result passes through the reign_get_Sensei_settings filter.

`reign_sensei_group_integration_enable( $default_value = 0 )`

Returns a boolean for whether group integration is enabled (enable_group_integration). Filterable via reign_sensei_group_integration_enable.

`reign_sensei_course_visibility( $default_value = 0 )`

Returns a boolean for whether course visibility is enabled (enable_course_visibility). Filterable via reign_sensei_course_visibility.

`reign_sensei_manage_tab()`

Returns true only when group integration and course visibility are both on and the current user is an administrator or a Sensei teacher. This is the gate used for the course picker and its AJAX search.

Courses and activities

`reign_sensei_get_courses( $args = array() )`

Runs a WP_Query for published courses with sensible defaults (10 per page, newest first) merged over your $args. Args pass through reign_sensei_get_courses_args; the result passes through reign_get_sensei_courses.

`reign_sensei_course_activities( $keys = array() )`

Returns the map of group course-activity types (enrol, complete course, complete lesson, finish quiz) with their labels. Pass keys to get a subset.

`reign_sensei_get_group_course_activities( $group_id )`

Returns the enabled course-activity types stored on a group (reign-sensei-groups-courses-activities).

`reign_sensei_group_courses_is_enable( $group_id )`

Returns whether course activity is enabled for a group (reign-sensei-group-course-is-enable).

`reign_sensei_group_course_activity_enable( $group_id, $key )`

Returns whether a specific activity type is enabled for a group, checking both the global toggle and the per-group setting.

Course data

`reign_sensei_course_teacher_coteacher_ids( $course_id )`

Returns the teacher and co-teacher user IDs for a course (co-teachers are users with the sensei_coteaching meta for the course). Filterable via reign_sensei_course_teacher_coteacher_id.

Reviews

`wb_ld_get_course_reviews_analytics( $post_id = null )`

Returns the review analytics for a course: total reviews, average rating, the per-star breakdown, and the average percentage. The result is memoized per request, per course.

Cross-version URL helpers

`reign_sensei_group_url( $group )`

Returns a group URL that works across BuddyPress versions (uses bp_get_group_url on 12.0+, bp_get_group_permalink below). Filterable via reign_sensei_group_url.

`reign_sensei_get_user_url( $author_id )`

Returns a member profile URL for BuddyBoss or BuddyPress. Filterable via reign_sensei_get_user_url.

Data keys reference

For code that reads or writes the addon’s data directly:

Settings: reign_options['sensei'][<key>] (see Configuring settings for the key list).
Course meta: _course_cover_image_id, _course_cover_background_color, reign-sensei-groupid.
Group meta: reign-sensei-courses, reign-sensei-group-course-is-enable, reign-sensei-groups-courses-activities.
Comment meta (reviews): rating, title.