Filter & Action Hook Reference - Page 4

← Back to all hooks
Hook Return Usage
wpex_topbar_split_breakpoint string

The breakpoint at which point the topbar should switch from a left/right layout to a top/bottom layout (sm, md, lg, xl). Default is md.

wpex_topbar_wrap_class array

Array of classes to be added to the top bar main wrapper.

wpex_topbar_class array

Array of classes to be added to the inner top bar element.

wpex_topbar_social_class array

Array of classes to be added to the top bar element holding the social profile links.

wpex_topbar_social_alt_content string

Returns the alternative content to display instead of the social links in the Top Bar.

wpex_topbar_social_style string

Returns the style name to be used for the Top Bar social profile link icons. Default is “flat-color-rounded”.

wpex_topbar_social_link_attrs array

Returns and array of attributes to be added to the Top Bar social profile links.

wpex_topbar_social_links_output string

HTML output for the Top Bar social links.

wpex_display_page_header bool

Whether the page header should display or not.

wpex_page_header_breakpoint string

Breakpoint at which the page header would switch from a left/right layout to a top/bottom layout (sm, md, lg, xl). Default is md.

wpex_page_header_style string

The style to be used for the page header which get’s added as a classname to the page header in the format style-{name}. Default is “default”.

wpex_page_header_class array

Returns array of classes to be added to the page header element.

wpex_page_header_inner_class array

Returns array of classes to be added to the page-header-inner element.

wpex_page_header_content_class array

Returns array of classnames to be added to the page-header-content element.

wpex_page_header_aside_class array

Returns array of classes to be added to the page-header-aside element.

wpex_has_page_header_title bool

Check if the page header title should display inside the page header element.

wpex_page_header_title_class array

Returns array of classes to be added to the page-header-title element.

wpex_page_header_subheading_class array

Returns array of classes to be added to the page-header-subheading element.

wpex_page_header_has_subheading bool

Check if the page header should display the subheading (if a subheading is defined).

wpex_post_subheading string

Returns the string to display for the page header subheading.

wpex_page_header_background_image string/int

Returns the background image to be used for the page header element. This can be a URL to an image or an image attachment id.

wpex_page_header_background_image_style string

Returns the page header background image style (cover or fixed). Default is “cover”.

wpex_page_header_overlay_style string

Returns the overlay style to be used for the page header when set to the “Background Image” style (none or dark). Default is dark.

wpex_get_page_header_overlay_pattern string

Returns the pattern style to be used for the page header overlay when set to the “Background Image” style (dotted or dashed). Default is “none”.

wpex_page_header_overlay_opacity string

Returns a custom opacity for the overlay color when the page header is set to the “Background Image” style and an overlay is enabled.

wpex_page_header_overlay_class array

Returns array of classnames to be added to the page header overlay when set to the “Background Image” style.

wpex_page_header_overlay string

Returns the html output for the overlay element when enabled and using the “Background Image” page header style.

wpex_page_header_background_position string

Returns a custom position for the page header background image to inserted into inline css. Default is “50% 0”.

wpex_sidebar_class array

Returns array of classnames to be added to the #sidebar element.

wpex_sidebar_class array

Returns array of classes to be added to the sidebar-inner element.

wpex_get_sidebar string

Returns the name of the sidebar to use for the main sidebar area in the theme as defined by register_sidebar.

wpex_register_sidebars_array array

Returns array of sidebars to be registered by the theme. You can hook into this function to register a new sidebar location to ensure it follows the theme’s standards rather then using the core register_sidebar function. Each item in the array should be composed of a key equal to the sidebar name and a value equal to the label to display in the widgets panel.

wpex_register_footer_sidebars array

Returns an array of wigetized areas (sidebars) to be used in the footer-widgets element.

wpex_ms_global_menu bool

Check’s if the theme should be displaying the main menu assigned to the primary site in a Multi-site installation. Default is false.

wpex_has_header_menu bool

Checks if the header menu should display or not.

wpex_main_menu_location string

Returns the registered menu location to be used for the header. Default is “main_menu”.

wpex_has_sticky_header_menu bool

Check if the header has a sticky menu. By default returns true for header styles two, three and four.

wpex_header_menu_wrap_classes array

Returns array of classnames to be used for the #site-navigation-wrap element.

wpex_header_menu_classes array

Returns array of classnames to be used for the #site-navigation element.

wpex_header_menu_ul_classes array

Returns array of classnames to be used for the .main-navigation-ul element.