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/logo | string | Returns the HTML for the header logo. |
totaltheme/header/logo/has_scroll_top_link | bool | Check if the header logo should scroll to the top of the site when clicked. |
totaltheme/header/logo/icon | string | Returns the HTML for the header logo icon if enabled. |
totaltheme/header/logo/image | string | Returns the HTML for the header logo image. |
totaltheme/header/logo/image_attributes | array | Returns an array of attributes for the header logo image. |
totaltheme/header/logo/image_height | int | Returns the logo image width to be used for the height attribute. |
totaltheme/header/logo/image_id | string | Returns the attachment ID for your header logo image. |
totaltheme/header/logo/image_width | int | Returns the logo image width to be used for the width attribute. |
totaltheme/header/logo/inner_class | array | Returns an array of classes added to the header logo-inner element. |
totaltheme/header/logo/is_image_svg | bool | Check if the header logo is using an SVG based image. |
totaltheme/header/logo/link_url | string | Returns the URL for the header logo link. |
totaltheme/header/logo/retina_image_id | int | Returns the attachment ID for the logo retina image. |
totaltheme/header/logo/text | string | The header logo text. If you are using an image based logo this is used for the alt attribute. |
totaltheme/header/logo/text_class | array | Returns an array of classes to be added to the text based header logo element. |
totaltheme/header/logo/wrapper_class | array | Returns an array of classes for the header logo wrapper div. |
totaltheme/header/menu/has_flush_dropdowns | bool | Check if the header menu should have "flush" dropdowns, in other words the header menu is the same height as the header. |
totaltheme/header/menu/is_custom | bool | Check if the header menu is using the theme's menu or a custom menu such as UberMenu. |
totaltheme/header/menu/is_enabled | bool | Checks if the header menu should display or not. |
totaltheme/header/menu/multisite_check | 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. |
totaltheme/header/menu/search/form | string | Returns the search form to be used for the header. Default is get_search_form() or get_product_search_form(). |
totaltheme/header/menu/search/icon_choices | array | Returns an array of icons allowed to be selected for the header search icon. |
totaltheme/header/menu/search/icon_label | string | Returns the text added to the header menu search link toggle. This text is hidden by default as it's primarily used for screen readers. |
totaltheme/header/menu/search/is_enabled | bool | Checks if the header menu has the search icon enabled or not. |
totaltheme/header/menu/search/is_supported | bool | Checks if the menu search functionality can be enabled for the header. Note: if the search style is set to disabled this filter will not override. |
totaltheme/header/menu/search/placeholder | string | Returns the placeholder text to be used for the header menu search form. |
totaltheme/header/menu/search/style | string | Returns the menu search style. Accepts disabled, drop_down, overlay or header_replace. |
totaltheme/header/menu/theme_location | string | Returns the registered menu location to be used for the header. Default is "main_menu". |
totaltheme/header/menu/wp_menu | varied | Returns the ID of a custom menu to be used for the header menu. Accepts a menu ID, slug, name, or object. |
totaltheme/header/overlay/is_enabled | bool | Check if the header overlay (transparent) header is enabled. |
totaltheme/header/overlay/is_global | bool | Check if the overlay/transparent header has been enabled globally as opposed to via the theme settings metabox. |