Hooks reference
Hooks let you add or change something in Reign without editing its files. Reign fires several hundred of them. This page lists the ones a site builder or add-on developer is most likely to use, grouped by where they fire. Internal hooks are left out. Every name below comes straight from the theme’s code.
Page skeleton (layout)
Section titled “Page skeleton (layout)”header.php and footer.php wrap every page in this order, top to bottom:
| Hook | Fires |
|---|---|
reign_html_before |
Before the opening <html> tag |
reign_head_top |
Start of <head>, before wp_head() |
reign_head_bottom |
End of <head>, after wp_head() |
reign_body_top |
Start of <body>, before wp_body_open() |
reign_before_page |
Before the #page wrapper div |
reign_before_masthead |
Before the #masthead header element |
reign_begin_masthead / reign_end_masthead |
Inside #masthead, wrapping the header content |
reign_after_masthead |
After the header element closes |
reign_before_content |
Before #content |
reign_content_top / reign_content_bottom |
Inside #content, wrapping the page’s main output |
reign_after_content |
After #content closes |
reign_before_footer / reign_footer / reign_after_footer |
Around the footer output |
reign_after_page |
After #page closes |
reign_body_bottom |
End of <body>, before wp_footer() |
reign_html_class (filter) adds classes to the <html> element.
Print a notice strip above the header on every page.
add_action( 'reign_before_masthead', function () { echo '<div class="my-top-banner">Free delivery on every order this week.</div>';} );Common changes has this and other tested recipes, with the CSS to style them.
Header
Section titled “Header”Since 8.1.0 Reign prints one header for every screen size, so each header hook fires once per page. Before 8.1.0 the desktop and phone headers were two copies, and some hooks fired twice. Anything you print here shows at every width. To show it on phones or desktop only, add your own breakpoint CSS. Phone is max-width: 1024.98px and desktop is min-width: 1025px.
| Hook | Fires |
|---|---|
reign_before_reign_mobile_nav_top / reign_after_reign_mobile_nav_top |
Around the header row, in every layout v1 through v4 |
reign_before_header_icons / reign_after_header_icons |
Around the icon group (search, cart, notifications) |
reign_after_mobile_header_icons |
After the icon group, right after reign_after_header_icons |
reign_user_profile_menu |
Where the logged-in user menu renders |
reign_header_v4_middle_section_html |
Middle section of header layout v4 |
reign_before_reign_mobile_main_menu / reign_after_reign_mobile_main_menu |
Around the main menu inside the slide-out drawer |
reign_before_reign_mobile_panel_menu / reign_after_reign_mobile_panel_menu |
Around the left-panel menu inside the drawer |
reign_header_legacy_overrides (filter) |
string[] $templates. Pre-8.1.0 header templates the child theme overrides; a non-empty list keeps the pre-8.1.0 header. Added in 8.1.0 |
Add a Help link after the header icons.
add_action( 'reign_after_header_icons', function () { echo '<a class="my-header-help" href="' . esc_url( home_url( '/help/' ) ) . '">Help</a>';} );Footer
Section titled “Footer”| Hook | Fires |
|---|---|
reign_footer_copyright_text (filter) |
The copyright line text, before it is echoed |
The page-skeleton reign_before_footer / reign_footer / reign_after_footer
actions above are also where most footer-area customization happens.
Add a Privacy link to the end of the copyright line. The filter receives the finished HTML, after [current_year], [site_title] and [theme_author] are replaced.
add_filter( 'reign_footer_copyright_text', function ( $text ) { return $text . ' | <a href="' . esc_url( home_url( '/privacy-policy/' ) ) . '">Privacy</a>';} );Member and community screens
Section titled “Member and community screens”These fire from the BuddyPress templates in both the bp-nouveau and bb-buddypress directories. A callback you register once covers BuddyPress and BuddyBoss Platform sites.
| Hook | Fires |
|---|---|
reign_begin_member_profile_sidebar / reign_end_member_profile_sidebar |
Around the sidebar on a member’s profile and on a single group |
reign_begin_group_index_sidebar / reign_end_group_index_sidebar |
Around the content of the groups directory sidebar. The members and activity directories have the same pair with member_index and activity_index in the name |
wbtm_after_cover_imager_container |
After the cover image container on a member’s profile header |
reign_member_extra_info_section |
The counts row in a member’s header (friends), after the name and details |
reign_group_extra_info_section |
The counts row in a group’s header (posts, members), before the organisers |
reign_before_member_avatar_member_directory |
Before each avatar in a members-loop grid |
reign_before_group_avatar_group_directory |
Before each avatar in a groups-loop grid |
reign_bp_nouveau_directory_members_item |
Inside each member card in a directory or friends-request loop |
reign_bp_before_displayed_user_mentionname |
Before the @mentionname on a member’s profile |
Show when the member was last active, in the counts row of their profile header.
add_action( 'reign_member_extra_info_section', function () { $active = bp_get_last_activity( bp_displayed_user_id() ); echo '<span class="my-member-active">' . wp_kses_post( $active ) . '</span>';} );Icons for a plugin’s profile and group tabs
Section titled “Icons for a plugin’s profile and group tabs”With Icon + Label navigation, Reign draws an icon for each BuddyPress tab, such as Activity, Profile and Friends. A tab that a plugin adds shows a generic icon. The plugin can name its own icon with the reign_bp_nav_icons filter. Map the tab’s slug to a Reign icon name or any Lucide icon name. The slug is the tab’s CSS id without -personal-li or -groups-li. Added in 8.1.0.
// Give a "Courses" profile and group tab the graduation cap icon.add_filter( 'reign_bp_nav_icons', function ( $icons ) { $icons['courses'] = 'graduation-cap'; return $icons;} );Sign-in and registration forms (template-parts/form-login.php,
template-parts/form-register.php) also expose
reign_login_form_top / reign_login_form_bottom and
reign_register_form_top / reign_register_form_bottom.
Useful filters
Section titled “Useful filters”| Filter | Purpose |
|---|---|
reign_excerpt_length |
Word count for auto-generated excerpts |
reign_excerpt_more |
The “read more” ellipsis text on excerpts |
reign_breadcrumbs_separator |
The separator markup between breadcrumb items |
reign_breadcrumbs_home_title |
The label for the Home breadcrumb |
reign_sidebar_id_for_left_sidebar |
Which registered sidebar ID renders in the left-sidebar slot |
reign_sidebar_layout |
string $layout. The layout of the current screen: right_sidebar, left_sidebar, both_sidebar, full_width or stretched_view. Use it to give a plugin’s content type its own default, for example is_singular( 'event' ) ? 'full_width' : $layout |
reign_set_sidebar_id / reign_set_left_sidebar_id |
Which widget area fills the right or left sidebar on the current screen. The Forums Sidebar uses these on forum pages |
reign_render_fallback_page_header |
Whether the fallback page-header banner renders on a given request |
reign_show_breadcrumbs |
bool $show, string $place. Return false to stop breadcrumbs printing. $place is banner (inside the sub header) or bar (under the site header) |
reign_show_archive_title_prefix |
Default false: archive titles drop the “Category:”, “Tag:” and “Author:” prefix. Return true to bring the prefix back |
reign_title_context |
array $context. The decision on where a page shows its title (In content, Sub header or Hidden). Change it to override the title style for one request |
reign_header_default_icons |
The default header icon set, as an array of icon keys, used until the site owner orders the icons in the Customizer |
reign_lostpassword_url |
The “Lost your password?” link in the login form and popup |
reign_after_login_success (action) |
Fires after a sign-in from the popup succeeds. Arguments: the WP_User and the redirect URL |
reign_bp_member_tiles |
array $tiles, int $user_id. A member’s stat chips on the directory card and profile header. Add your own count; each chip takes label, url, icon and class. Added in 8.1.0 |
reign_customize_classic_widgets |
Default true: widget areas in the Customizer use classic widget forms. Return false to restore block widgets there |
reign_record_photo_activity |
Whether a photo change posts to the activity stream. BuddyPress and BuddyBoss post nothing for these, so Reign adds the post. Second argument: member_cover, group_avatar or group_cover. Default: off (or the old Community setting a site saved before 8.1.0) |
Shorter excerpts with your own ending. These two run while Customize > Blog > Advanced Excerpt is on (the default), and win over its Excerpt Length setting.
add_filter( 'reign_excerpt_length', function () { return 12;} );add_filter( 'reign_excerpt_more', function () { return ' ... keep reading';} );Turn on all three photo posts.
add_filter( 'reign_record_photo_activity', '__return_true' );Post only group cover changes.
add_filter( 'reign_record_photo_activity', function ( $record, $type ) { return 'group_cover' === $type ? true : $record;}, 10, 2 );Group posts are never recorded for hidden groups. Change that with reign_excluded_group_types_for_cover_activity and reign_excluded_group_types_for_avatar_activity. Both default to array( 'hidden' ). The other automated posts come from BuddyPress or BuddyBoss. They are new member, new profile photo, friendships and group joins. BuddyBoss switches each one on or off in BuddyBoss > Settings > Activity.
The card under automatic posts
Section titled “The card under automatic posts”Several automatic posts show one card, on BuddyPress and BuddyBoss alike. They are new member, new profile or group photo, new cover, new friendship, profile update, and joined or created group. The card comes from template-parts/content-user-preview.php. The post’s header already names the member or group, so the card never repeats the name. Each card shows:
- photo: the new photo, large, over the current cover.
- cover: the new cover.
- member: cover, photo, “Joined October 2026 · 12 friends”, then Add Friend (or View profile).
- group: cover, photo, “Public Group · 12 members”, then Join Group (or Visit group).
| Filter | Purpose |
|---|---|
reign_activity_preview_args |
The card’s data before it prints: kind, url, cover, photo, alt, facts (plain-text strings) and action (button HTML). Second argument: the activity (activity_id, user_id, item_id, secondary_item_id, component, type) |
Add the new member’s location to new-member cards.
add_filter( 'reign_activity_preview_args', function ( $card, $activity ) { if ( 'new_member' === $activity['type'] ) { $card['facts'][] = xprofile_get_field_data( 'Location', (int) $activity['user_id'] ); } return $card;}, 10, 2 );Hide the button on every card.
add_filter( 'reign_activity_preview_args', function ( $card ) { $card['action'] = ''; return $card;} );Plugin stylesheets and scripts
Section titled “Plugin stylesheets and scripts”With Customize > General > Smart Performance on, Reign loads each integration’s CSS and JS only on the pages that use it. These filters let you change that choice. Each receives and returns a boolean.
| Filter | Purpose |
|---|---|
reign_bypass_conditional_assets |
Return true to load every integration’s assets on every page. The Smart Performance switch uses this filter |
reign_load_woocommerce_assets, reign_load_woocommerce_css, reign_load_woocommerce_js |
Load the WooCommerce stylesheet and script on a page Reign did not recognise |
reign_load_buddypress_assets, reign_load_bbpress_assets, reign_load_learndash_assets, reign_load_events_calendar_assets, reign_load_wp_job_manager_assets |
Load that plugin’s styles on a page Reign did not recognise |
reign_load_lifterlms_assets |
Load the LifterLMS styles. Receives $found, whether the page content uses a LifterLMS shortcode or block |
reign_load_header_icons_css, reign_load_blog_css, reign_load_slick |
Load the header dropdown stylesheet, the blog listing stylesheet or the Slick slider script |
LifterLMS also loads its styles late. This happens when a LifterLMS shortcode or block renders on a page that did not load them up front. Examples are a page builder widget, a widget area or a template. WordPress prints the styles in the footer. The reign_lifterlms_late_assets action fires then, with no arguments. An add-on can use it to enqueue its own LifterLMS stylesheet at the same moment.
// Load the WP Job Manager styles on a landing page that prints a job list through a template.add_filter( 'reign_load_wp_job_manager_assets', function ( $load ) { return $load || is_page( 'careers' );} );
// Add your own sheet whenever LifterLMS output appears late.add_action( 'reign_lifterlms_late_assets', function () { wp_enqueue_style( 'my-lifterlms-tweaks' );} );Page builders
Section titled “Page builders”Reign treats every page builder the same way. A post made with a builder prints its content as the builder made it. It has no Reign title, meta or sub-header. It gets the body class reign-page-builder-active. Elementor, Beaver Builder and Divi posts are detected automatically.
| Filter | Purpose |
|---|---|
reign_is_builder_page |
bool $built, int $post_id. Return true to give a post made with any other page builder the same full-content, no-title, no-sub-header treatment. Added in 8.1.0 |
// Treat posts built with a custom builder as builder pages.add_filter( 'reign_is_builder_page', function ( $built, $post_id ) { if ( get_post_meta( $post_id, '_my_builder_enabled', true ) ) { return true; } return $built;}, 10, 2 );Search filters
Section titled “Search filters”Added in 8.0.8. All search filters run on front-end searches only.
| Filter | Purpose |
|---|---|
reign_search_exclude_post_types |
Post types to drop from search results. Receives an empty array and the WP_Query. Wins over the include list |
reign_search_post_types |
Restrict search to exactly these post types. Receives an empty array and the WP_Query. Can also force in a type registered with exclude_from_search |
reign_searchable_post_types |
The list of searchable post types with labels |
reign_search_scope_excluded_post_types |
Infrastructure post types hidden from that list (Elementor library and landing pages, attachments) |
reign_search_federation |
Default true. Return false to turn off the plugin result sections on the search page |
reign_search_federation_providers |
Add, remove or reorder result sections. Built-in ids: jetonomy, eventonomy, mediaverse, learnomy (BuddyNext adds its own community results link) |
reign_search_federation_excluded_providers |
Array of provider ids to hide, for example ['mediaverse'] |
reign_use_buddynext_header_search |
Whether the header search opens BuddyNext’s community search. Return true or false to override the theme setting |
A URL that sets post_type (for example a plugin’s own search form) bypasses
both scope filters.
// Keep WooCommerce products out of the site search.add_filter( 'reign_search_exclude_post_types', function ( $types ) { $types[] = 'product'; return $types;} );
// Hide the MediaVerse section from search results.add_filter( 'reign_search_federation_excluded_providers', function ( $ids ) { $ids[] = 'mediaverse'; return $ids;} );Template positions
Section titled “Template positions”Actions that print markup at a fixed place in a template. Hook a function that echoes what you want shown. Hooks with no arguments pass nothing.
| Hook | Fires |
|---|---|
reign_masthead |
Inside #masthead, between reign_begin_masthead and reign_end_masthead. Reign prints the header here at priority 20. Use a lower or higher priority to place your markup before or after it |
reign_before_content_section / reign_after_content_section |
Around the main content area of pages, posts, archives, search, 404, BuddyPress, bbPress, LearnDash course archives and The Events Calendar. Reign prints the left sidebar on the first and the right sidebar on the second |
reign_post_content_begins |
At the top of a page’s <article>, before its title and content |
reign_post_content_after |
After a single post’s content, before the navigation and comments |
reign_post_comment_before |
After a single post’s content and navigation, just before the comments are loaded |
reign_extra_info_on_single_post_start |
In the post meta row under a single post’s title (posts only), after the author and date line |
reign_extra_info_on_single_post_end |
After a single post’s content, inside the post <article> (single posts only) |
reign_rg_post_content_after |
After the content of a post in a listing or a single post, and after the “nothing found” message |
reign_render_additional_post_meta |
Right after the category links in the post meta |
reign_page_header_extra |
In the page header banner, after the breadcrumbs |
reign_before_user_menu_item / reign_after_user_menu_item |
At the start and end of the member menu list in the header |
reign_before_comment_replay |
int $comment_id, WP_Comment $comment. Before the reply and action links of a comment |
reign_after_comment_replay |
int $comment_id, WP_Comment $comment. After them |
reign_breadcrumbs_last_element |
Inside the breadcrumb list, after the last item, so you can print one more <li> |
reign_bbpress_before_content / reign_bbpress_after_content |
Around the content of a bbPress page |
reign_bp_nouveau_before_content |
Before the content column of a single member profile and a single group |
reign_single_post_comment_section |
At the end of the main column of a single course page, where a comments area can go |
reign_recaptcha_after_login_form |
In the sign-in form, after the password row and before the submit button. Reign’s reCAPTCHA support hooks it to print the captcha field |
Add a note after every blog post’s content.
add_action( 'reign_post_content_after', function () { echo '<p class="my-post-note">Thanks for reading. Questions? Leave a comment below.</p>';} );Layout and content filters
Section titled “Layout and content filters”| Filter | Purpose |
|---|---|
reign_alter_display_right_sidebar |
bool $display, default true. Return false to leave the right sidebar out of a request |
reign_plugin_page_layout |
string $layout. Default layout for a plugin’s own pages (account, dashboard, list). Return right_sidebar, left_sidebar, both_sidebar or full_width. A layout saved on the page itself wins |
reign_sidebar_groups |
array $groups. The content groups that get a widget area, each key => array( 'name', 'types', 'area' ). Add one so a plugin’s post types get their own sidebar; set 'area' => false for a group that brings its own sidebar. The widget area id is <key>-sidebar |
reign_site_content_grid_class |
string $class. The class on the content grid wrapper, default wb-grid site-content-grid |
reign_title_plugin_owned |
bool $owned. Return true when a plugin prints the page’s own <h1>, so Reign adds no second title |
reign_page_header_section_title |
string $title. The title printed in the page header banner |
reign_post_categories |
string $html. The category links in the post meta |
reign_post_tags |
string $html. The tag links under a single post |
reign_enable_masonry |
string $layout. Receives the Blog Listing Layout. Return masonry-view to load the masonry script on a listing that does not use that layout |
alter_reign_display_posts_args |
array $args. The query arguments (posts_per_page, cat, paged) of the [reign_display_posts] shortcode, before it runs |
reign_search_result_type_label |
string $label, WP_Post $post. The post type badge on a search result |
reign_breadcrumbs_custom_taxonomy |
string $taxonomy, default product_cat. The taxonomy shown in the breadcrumb trail for a custom post type |
alter_reign_breadcrumbs |
bool $replace, default false. Return true to replace Reign’s breadcrumb trail with your own, printed on the reign_breadcrumbs action |
reign_breadcrumb_post_type_link |
string $url, string $post_type. The link on a custom post type’s breadcrumb. Return an empty string to print the label without a link |
reign_user_profile_menu_toggler |
bool $show. Whether the member menu shows in the header. Defaults to whether the visitor is logged in |
reign_header_topbar_default_info_links / reign_header_topbar_default_social_links |
array $links. The topbar’s starting info and social links, used until the site owner adds their own |
reign_mobile_header_default_icons |
array $icons. The default icon set of the phone header, used until the site owner orders them |
reign_theme_author |
array $author with theme_name and theme_author_url. What the [theme_author] placeholder in the copyright text prints |
reign_featured_image_position_post_types |
string[] $post_types, default array( 'post' ). The post types that get the Featured Image Layout panel in the block editor |
reign_customizer_supported_post_types |
array $post_types. The post types that get a pair of Content Layouts sections in the Customizer |
reign_exclude_post_types_to_support |
string[] $post_types. Post types left out of Content Layouts, such as landing page and announcement types |
wbcom_content_width |
int $width, default 640. The $content_width global WordPress uses for embeds |
wbcom_custom_background_args |
array $args. The arguments Reign passes to the custom-background theme support |
Make single blog posts full width.
add_filter( 'reign_sidebar_layout', function ( $layout ) { return is_singular( 'post' ) ? 'full_width' : $layout;} );Colours, fonts, icons and assets
Section titled “Colours, fonts, icons and assets”| Filter | Purpose |
|---|---|
reign_selector_set_to_apply_theme_color |
string $selectors. A comma-separated CSS selector list that gets the Theme Color as its text colour. Append your own selectors; the list starts empty |
reign_selector_set_to_apply_theme_color_to_background |
string $selectors. Selectors that get the Theme Color as a background |
reign_selector_set_to_apply_theme_color_to_border |
string $selectors. Selectors that get the Theme Color as a border colour |
reign_selector_set_to_apply_section_bg_color |
string $selectors. Selectors that get the Sections Background Color |
reign_selector_set_to_apply_secondary_bg_color |
string $selectors. Selectors that get the Secondary Background Color |
reign_selector_set_to_apply_border_color |
string $selectors. Selectors that get the Border Color |
reign_variation_is_dark_scheme |
bool|null $is_dark, string $variation_slug. Tell Reign whether a style variation is dark. Return null to let Reign decide |
reign_color_setup_default_scheme |
string $slug, default reign_clean. The colour scheme a fresh install starts with |
reign_google_fonts |
array $fonts. The Google Fonts Reign loads, as font name => variants[] |
reign_deferred_style_handles |
string[] $handles. Stylesheet handles to load without blocking the first paint. Only safe for styles whose above-the-fold rules are covered elsewhere |
reign_icon_registry |
array $registry. Icon key to Lucide icon name. Add keys for your own icons |
reign_fa_icon_map |
array $map. Font Awesome class name to Lucide icon name, used to render saved Font Awesome icons |
reign_menu_icons_fallback_locations |
string[] $locations. The menu locations whose items get a generic icon when they have none, for the icon-only left panel |
Give links in your own block the Theme Color.
add_filter( 'reign_selector_set_to_apply_theme_color', function ( $selectors ) { return $selectors . ',.my-post-note a';} );Reign caches the CSS these reign_selector_set_* filters build, for up to a day. After you add or change one, open Appearance > Customize and click Publish, or run wp transient delete reign_theme_color_css_v2.
Plugin integrations
Section titled “Plugin integrations”| Filter | Plugin | Purpose |
|---|---|---|
reign_loop_button_wrap_classes |
WooCommerce | string[] $classes. Classes on the wrapper around a product card’s button |
reign_off_canvas_filter_button_output |
WooCommerce | string $html. The Filter button on the shop page |
reign_tec_token_map |
The Events Calendar | array $map. The --tec-* variable to Reign colour map |
reign_bbp_user_identity_items |
bbPress | array $items, int $user_id. The topic and reply counts under a member’s name on a forum profile |
reign_member_header_types_layout_options / reign_group_header_types_layout_options |
BuddyPress | array $options. The header layouts offered in Reign Settings > Community |
reign_member_header_allowed_types |
BuddyPress | string[] $types. The member header layouts Reign accepts as a saved value |
wbtm_restore_avatar_settings_tab |
BuddyBoss | array $tabs, slug => label. The Community Settings tabs after Reign hid Avatar Settings, because BuddyBoss manages its own avatars and covers. Add avatar_settings back to show it |
reign_show_wordpress_default_avatar |
BuddyPress | bool $show, default false. Return true to keep the default avatar WordPress or the avatar plugin supplies |
reign_get_user_social_array |
BuddyPress | array $socials, int $user_id. The social networks list: the networks shown in Community Settings and a member’s links before they print |
reign_user_header_view |
BuddyPress | array $header_view, int $user_id. A member’s saved profile header view before the profile edit screen shows it |
reign_bp_is_current_action |
BuddyPress | bool $match. Return true for an extra member screen that should get the settings-style layout |
wbtm_rth_manage_member_header_class / wbtm_rth_manage_group_header_class |
BuddyPress | string $layout. The cover header layout class (wbtm-cover-header-type-1 to -4) after Reign and BuddyBoss Platform Pro’s Header Style have chosen |
reign_buddypress_member_send_message_button_url |
BuddyPress | string $url, int $user_id. Where a member’s Message button points. Defaults to the compose screen |
reign_add_feature_image_blog_post_as_activity_content |
BuddyPress | string $html, int $post_id. Markup for the featured image in the activity item of a new blog post |
reign_bp_thread_excerpt_scan_cap |
BuddyPress | int $cap, default 30. How many messages of a thread Reign reads to find the last one with text in the header messages dropdown |
reign_ld_default_course_img_url |
LearnDash | string $url. The image used for a course with no featured image |
reign_ld_default_course_image_html |
LearnDash | string $html. The markup for that default image |
reign_learndash_course_card_parts |
LearnDash | array $parts, int $course_id. Which parts a course card shows: badge, excerpt, progress, meta and instructor, each true or false |
reign_learndash_course_card_user |
LearnDash | int $user_id, int $course_id. The member a course card’s progress is shown for |
reign_wpjm_get_jobs_page_id, reign_wpjm_get_jobs-dashboard_page_id, reign_wpjm_get_post-a-job_page_id |
WP Job Manager | int $page_id. The page Reign treats as the job listings, job dashboard or Post a job page. Defaults to the page chosen in WP Job Manager’s settings; -1 when none is set |
reign_group_features_in_tab |
LearnDash | array $features. The feature rows on a LearnDash group page |
Send the Message button on member cards to your own contact page.
add_filter( 'reign_buddypress_member_send_message_button_url', function ( $url, $user_id ) { return home_url( '/contact/?member=' . $user_id );}, 10, 2 );Reign Settings, for add-on developers
Section titled “Reign Settings, for add-on developers”These hooks add to the Reign Settings screens. Reign add-ons use them; a site-specific plugin can too.
| Hook | Purpose |
|---|---|
alter_reign_admin_tabs (filter) |
array $tabs. Add a tab, as slug => label. It appears under Reign Settings > Integrations. Render its content on render_theme_options_page_for_<slug> |
reign_licensed_products (filter) |
array $addons. Register an add-on so it gets a row on Reign Settings > License. Each entry needs name, item_id, version and file (the main plugin file) |
reign_other_premium_addon_license_panel (action) |
Prints extra licence boxes at the bottom of the License screen |
reign_install_catalog (filter) |
array $catalog, slug => entry. The plugins the one-click installer on the Extend screen and the Home Set up your site card can install. An entry with github (owner/repo) installs the latest release zip first, with the store as the fallback |
reign_family_products (filter) |
array $products. The cards on the Extend screen, each with name, slug, logo, desc and url |
reign_options_promo_groups (filter) |
array $groups. Extra add-on groups on the Extend screen, each with an items list |
reign_admin_search_index (filter) |
array $entries, each with label, context, url and type. The entries the Reign Settings search finds |
wbcom_metabox_add_vertical_tab (filter) |
array $tabs. Add a tab to the Reign Custom Settings box on pages and posts. Print its fields on render_wbcom_metabox_content_for_<slug> |
Add a tab under Reign Settings > Integrations and print its content.
add_filter( 'alter_reign_admin_tabs', function ( $tabs ) { $tabs['my-extras'] = 'My extras'; return $tabs;} );add_action( 'render_theme_options_page_for_my-extras', function () { echo '<p>Settings for my extras go here.</p>';} );The tab content prints inside the Reign Settings form.
More filters and actions
Section titled “More filters and actions”Hooks for the Customizer, the widget-aware asset loader, the member and group cards, and the dark mode image settings.
| Hook | Receives and returns |
|---|---|
reign_customizer_field_args (filter) |
array $args, WP_Customize_Manager $manager. One Reign Customizer field’s arguments (settings, label, description, default, transport and so on) just before it is registered. Return the changed array |
reign_customizer_field_type_map (filter) |
array $map, type => array( setting class, control class, is custom control ). The field types Reign’s Customizer can register. Add a type, or point an existing one at your own control class |
reign_customizer_support_post_type_is_single (filter) |
bool $single, default true. Return false to give custom post types only an Archive section in Content Layouts, with no Single section |
reign_remove_background_image_section (filter) |
bool $remove, default true. Reign removes WordPress’s Background Image Customizer section. Return false to keep it |
reign_inactive_sidebar_ids_for_current_request (filter) |
string[] $ids. Widget areas that do not print on this page. Reign skips their widgets when it decides which plugin CSS and JS to load. Add the id of your own conditional widget area |
reign_kses_post_with_icons_allowed_html (filter) |
array $allowed. The wp_kses() allow-list (post HTML plus SVG icon tags) used for icon markup such as the breadcrumb separator |
reign_bp_directory_groups_data (action) |
No arguments. Inside each group card in the groups directory, before the group organisers. Runs in the group loop, so bp_get_group_*() functions work |
reign_buddypress_member_send_message_button_call (action) |
No arguments. Prints the Message button in the card footer of member layouts 2 to 4. Reign attaches reign_bp_member_message_button here |
wbtm_wbcom-dark-mode-settings_vertical_tabs (filter) |
array $tabs, slug => label. The sub-tabs of Reign Settings > Dark Mode Image Settings. Print a tab’s content on render_theme_options_for_<slug> |
wbcom_essential_theme_slug (filter) |
string $slug, default reign. The prefix of the <slug>_wbcom_metabox_data post meta Reign reads for a page’s own sidebar choice |
reign_learndash_owner_colors (action) |
No arguments. Fires once after Reign adds its text-colour fixes to LearnDash’s inline CSS. Reign checks did_action() on it so the fixes are added only once |
reign_alter_theme_options_quick_links (filter) |
Removed in 8.1.1, with the old Getting Started screen it fed. The Set up your site card on Reign Settings > Home replaced that screen |
reign_options_sidebar (action) |
Deprecated in 8.1.1. No arguments. The sidebar of that same fallback settings screen; the current Reign Settings panel never fires it. Hooking it shows a deprecation notice with WP_DEBUG on |
reign_header_topbar_fields_on_hold (filter) |
Deprecated in 8.1.1, use reign_customizer_field_args. The Top Bar fields and colours are registered before it runs, so it never changed them. Hooking it shows a deprecation notice with WP_DEBUG on |
Add a note to one Customizer field’s description.
add_filter( 'reign_customizer_field_args', function ( $args ) { if ( 'reign_footer_copyright_text' === $args['settings'] ) { $args['description'] = 'Ask the web team before changing this.'; } return $args;} );Keep WordPress’s Background Image section in the Customizer.
add_filter( 'reign_remove_background_image_section', '__return_false' );Tell the asset loader that your own widget area only prints on blog posts. Widgets in it then do not load their plugin’s CSS on other pages.
add_filter( 'reign_inactive_sidebar_ids_for_current_request', function ( $ids ) { if ( ! is_singular( 'post' ) ) { $ids[] = 'my-post-sidebar'; } return $ids;} );Allow the stroke-width attribute on SVG circles in icon markup.
add_filter( 'reign_kses_post_with_icons_allowed_html', function ( $allowed ) { $allowed['circle']['stroke-width'] = true; return $allowed;} );Show when each group was last active on its directory card.
add_action( 'reign_bp_directory_groups_data', function () { echo '<span class="my-group-active">' . esc_html( bp_get_group_last_active() ) . '</span>';} );Remove the Message button from member cards.
add_action( 'init', function () { remove_action( 'reign_buddypress_member_send_message_button_call', 'reign_bp_member_message_button' );} );Add a sub-tab to the Dark Mode Image Settings screen.
add_filter( 'wbtm_wbcom-dark-mode-settings_vertical_tabs', function ( $tabs ) { $tabs['my_dark_extra'] = 'My dark images'; return $tabs;} );add_action( 'render_theme_options_for_my_dark_extra', function () { echo '<p>Dark logos for partner pages.</p>';} );Hooks carried over from the Reign add-ons era
Section titled “Hooks carried over from the Reign add-ons era”Before Reign 8, header/footer/sidebar customizations went through hooks
prefixed wbcom_ and wbtm_, fired by the separate Reign add-ons.
inc/reign-deprecated-hooks.php keeps those working: every current
reign_* layout hook also re-fires its old equivalent, so code written
against the legacy names still runs. For example, reign_before_content
still triggers wbcom_before_content, and reign_member_extra_info_section
still triggers wbtm_member_extra_info_section. New code should hook the
reign_* names directly.
Three older filters of the Reign - Profile Completion widget were also case-sensitive, and that broke silently. BP_reign_user_progress, BP_reign_user_progress_formatted and BP_reign_profile_completion_form_update are now lowercase. They are bp_reign_user_progress, bp_reign_user_progress_formatted and bp_reign_profile_completion_form_update. Both names still work. Write new code against the lowercase names.
One bridge was removed outright in 8.0.5: the wbcom_kirki_theme_customizer_loaded
compatibility action. Its trigger had no firer since Kirki was removed in
8.0.0, so it could never run. There is no replacement hook for it, and
Kirki itself is gone from Reign 8. Register Customizer fields through
Panel::add() / Section::add() / Field::add() in the theme’s own
Customizer Framework instead, documented alongside the code in
inc/Customizer_Framework/.

