Hooks: Page Header
Hook | Return | Usage |
---|---|---|
wpex_post_subheading |
string | Alters or adds a new subheading under the main page header title. |
wpex_has_fixed_header |
bool | Whether the header should be fixed on scroll or not. |
wpex_page_header_title_args |
array | Returns an array for the page header title arguments – html_tag, string, schema_markup |
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_page_header_styles |
array | Returns an array of choices for the page header styles. |