Settings keys and stored data
Reign LifterLMS Addon overviewPremiumGet Reign LifterLMS Addon →
Where the add-on keeps its data, the key of every setting, and who may do what. Use it for WP-CLI, migrations and support checks.
Where settings are saved
Section titled “Where settings are saved”All settings live in one array, reign_options['lifterlms'], inside the reign_options option that holds the Reign theme’s own settings. Only values you changed from the default are saved; a value equal to its default is not stored and keeps following the default. Nothing is written when the add-on is activated. A saved choice that no longer exists (a layout a later version dropped) reads as the default and is not rewritten.
Read what a site has saved:
wp option pluck reign_options lifterlmsChange a default for the whole site with the reign_llms_default_settings filter. See Hooks and filters.
Setting keys
Section titled “Setting keys”| Card | Key | Screen label | Values | Default |
|---|---|---|---|---|
| Course page | course_layout |
Layout | reign, spotlight |
reign |
| Related courses | related_enabled |
Show related courses | on, off |
on |
| Related courses | related_title |
Heading | text | Related Courses |
| Related courses | related_count |
Courses shown | 1 to 12 | 3 |
| Course catalog | card_style |
Card style | reign, detail |
reign |
| Course catalog | columns_courses |
Courses per row | 1 to 4 | 3 |
| Course catalog | columns_memberships |
Memberships per row | 1 to 4 | 3 |
| Student dashboard | dashboard_icons |
Section icons | on, off |
on |
| Student dashboard | columns_dashboard |
Courses per row | 1 to 4 | 3 |
| Reviews | star_ratings |
Star ratings | on, off |
on |
| Lesson reading | reader_default |
Open lessons in reading mode | on, off |
on |
| Community | profile_tab |
Courses tab on profiles | on, off |
on |
| Community | groups |
Link courses to groups | on, off |
on |
| Community | activity |
Post to the activity feed when a member | enrolled, course_done, lesson_done, certificate, achievement, quiz_passed, quiz_failed |
enrolled, course_done, certificate |
The Community card shows only while BuddyPress, BuddyBoss or PeepSo is active. A hidden card keeps its saved values. Heading and Courses shown are hidden while Show related courses is off. Keys written by 2.6.0 stay in the option, unread.
Other stored data
Section titled “Other stored data”| Key | Where | What it holds |
|---|---|---|
reign_bp_group_field |
Course post meta | ID of the linked community group. Protected meta: it does not show under Custom Fields. |
course_rating |
Review post meta | The 1 to 5 stars of a review. |
_reign_llms_prev_content |
Post meta | A post’s content before [reign_lifterlms_courses] became [lifterlms_courses]. wp reign-lifterlms upgrade --revert-shortcodes restores it. |
reign_llms_upgrade_log |
Option | One line per finished update step. The Update status card shows it. |
rllmsReader |
Browser local storage | A student’s reading mode choice. |
Pages and query variables
Section titled “Pages and query variables”| Variable | Used for |
|---|---|
llms_s |
The catalog search box. |
rllms_rp |
Paging of the reviews on a course. |
rllms_ip |
Paging of the instructor directory. |
rllms_cp |
Paging of the profile Courses tab. |
rllms_review |
The result of a review submit, shown as a notice once. |
rllms_sync |
The result of a group sync click, shown as a notice once. |
Form actions
Section titled “Form actions”The add-on has no REST routes and no AJAX. Two forms post to admin-post.php:
| Action | Who | Does |
|---|---|---|
reign_llms_review |
A logged-in member LifterLMS allows to review (guests are sent to log in) | Saves a review with its stars. |
reign_llms_group_sync |
A user with manage_lifterlms who can edit the course |
Adds the next 200 enrolled students to the linked group. |
Who can do what
Section titled “Who can do what”| Action | Needs |
|---|---|
| Open the LifterLMS settings screen, save or reset a card | manage_options |
| See the “paused” notice | activate_plugins |
| Pick a community group on a course | edit_post for the course, and either bp_moderate, manage_options, or being an administrator of that group |
| See all hidden and private groups in the picker | bp_moderate or manage_options |
| Click Add enrolled students to the group | manage_lifterlms and edit_post for the course |
| Write a review | LifterLMS’s own rule for the course (LLMS_Reviews::current_user_can_write_review) |
Visitors need no capability to see the catalog, the course page, the instructor directory or the Courses tab. The Courses tab also follows the reign_llms_courses_tab_visible filter.

