Below you will find a reference of filters available in the Total theme. Filters can be used to modify default theme options, values or output (learn more). You can use the search above to try and locate specific filters. This reference is intended to help you quickly locate a filter name. Once you locate a filter that you think may be useful you can then search the theme files for the filter to see how it’s being used to assist you in your custom code.
Important: This is a manually created list so there may be filters available not yet listed.
Filter by:
| Name | Return | Usage |
|---|---|---|
totaltheme/header/overlay/is_global | bool | Check if the overlay/transparent header has been enabled globally as opposed to via the theme settings metabox. |
totaltheme/header/overlay/logo_image_id | int | Returns the image ID for the overlay/transparent header logo if you are displaying a different logo then the default site logo. |
totaltheme/header/overlay/style | string | Returns the current overlay header style. Choices are: white, light, dark, core. |
totaltheme/header/overlay/style_choices | array | Returns array of header overlay styles (white, light, dark or core). |
totaltheme/header/sticky/breakpoint | int | Filters the breakpoint for the sticky header. |
totaltheme/header/sticky/is_enabled | bool | Whether the header should be fixed on scroll or not. |
totaltheme/header/style | string | Returns the header style. Default is "one". |
totaltheme/header/vertical/position | string | Returns the position for the vertical header (left or right). |
totaltheme/header/wrapper_class | array | Returns a list of classes to be added to the main header wrap. |
totaltheme/integration/wpbakery/remove_elements/blacklist | array | Returns the array of WPBakery elements that get removed by the theme. |
totaltheme/integration/wpbakery/slim_mode/is_enabled | bool | Check if WPBakery slim mode is enabled. |
totaltheme/integration/wpbakery/video_backgrounds/video_attributes | array | Returns an array of attributes to add to self hosted video elements. |
totaltheme/integration/yoast_seo/pagination_fix/is_enabled | bool | Check whether the theme should fix the Yoast SEO plugin issues related to paginated page canonicals and titles. |
totaltheme/lightbox/l10n | array | Returns an array of settings for the themes lightbox that is passed via wp_localize_script to the javasript file. |
totaltheme/mobile/menu/breakpoint | int | Returns a numerical value for the mobile menu breakpoint, which is the screen width at which the main header menu becomes hidden and the mobile menu toggle becomes visible. |
totaltheme/mobile/menu/is_enabled | bool | Check if the header menu has a mobile menu version. If you are using a custom header you could potentially set this filter to __return_true so that the theme inserts the mobile menu code onto the page and then you can make use of it via a custom toggle button with the classname "mobile-menu-toggle". |
totaltheme/mobile/menu/sidr/source | array | Returns an array of element classnames or ID's to be appended to the Sidebar style mobile menu. |
totaltheme/mobile/menu/style | string | Returns the current mobile menu style. Options: sidr, full_screen or toggle. |
totaltheme/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. |
totaltheme/page/header/has_subheading | bool | Check if the page header should display the subheading (if a subheading is defined). |
totaltheme/page/header/has_title | bool | Check if the page header title should display inside the page header element. |
totaltheme/page/header/is_enabled | bool | Whether the page header should display or not. |
totaltheme/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". |
totaltheme/page/header/subheading | string | Returns the string to display for the page header subheading. |
totaltheme/pagination/load_more/button_text | string | Filters the default load more button text. |
totaltheme/post_gallery/include_featured_image | bool | Returns true or false if the post gallery should include the featured image. |
totaltheme/replace_vars/is_enabled | bool | Checks if the Replace_Vars class should run which is the class that parses "Dynamic Variables". |
totaltheme/replace_vars/vars | array | Returns the array of replacement vars. |
totaltheme/restrict_content/restrictions | array | Returns an array of functions whitelisted for the theme's wpex_user_can_access() function which is used in options such as the WPBakery Row Access setting. |
totaltheme/sidebars/primary/insert_hook_name | string | Returns the hook name for inserting the primary sidebar area. |