PHP hooks

us_{asset_name}_get_used_assets #

Filter. Filters the list of used assets. {asset_name} here is the feature name, like auto_optimize_assets.

  • $used_assets (array) - array of used assets

us_{asset_name}_run #

Action. Fires after each iteration of the auto-optimisation or the used icons check. {asset_name} in this hook is the feature name, like auto_optimize_assets or used_icons.

  • $this (object) - US_Auto_Optimize_Assets object

us_404_content #

Filter. Filters the default 404 page content.

  • $the_content (string) - 404 page HTML content

us_acf_tta_section_content #

Filter. Filters the Accordion and Tabs elements section content when it fetches data from ACF Repeater.

  • $section_content (string) - full section content
  • $row (array) - ACF Repeater row subfields as array

us_activate_plugin #

Action. Fires after an Addon plugin is activated.

  • $plugin_slug (string) - plugin slug

us_after_404 #

Action. Fires after the default 404 page content, just before the .l-section-h div closes.

us_after_archive #

Action. Fires after the default archive template, just before the .l-section-h div closes.

us_after_footer #

Action. Fires after the closing </footer> tag when the page is not in an iframe or pagination via an AJAX request.

us_after_header #

Action. Fires after the closing </header> tag on the front-end, does not fire if there is no header on the given page.

us_after_js_composer_mappings #

Action. Fires after applying theme-related changes to WPBakery, but does not fire if the plugin is not active.

us_after_page #

Action. Fires after page content, just before the closing </main> tag on single pages, search, home, and 404 pages.

us_after_template:{file_path} #

Action. Fires after the specified template file is loaded, called for most of the theme templates, including internal. {file_path} in this hook is a path to a template, like us_after_template:templates/content.

us_allow_guest_favs #

Filter. Filters switch controlling whether guest favourites are allowed for the Add to Favourites element.

  • $allowGuests (bool) - whether to allow guest favs

us_apply_filtering_tax_query_item #

Filter. Filters List Filter element item data during AJAX request.

  • $tax_query_item (array) - item data
  • $source_name (string) - taxonomy name to filter by

us_apply_filtering_to_list_query #

Filter. Filters List query args during AJAX request from List Filter.

  • $query_args (array) - target list query args
  • $name (string) - filtering source, such as taxonomy name or meta key
  • $values (array) - applied filtering parameters

us_apply_orderby_to_list_query #

Filter. Filters query arguments for the List when it is being sorted according to its settings or List Order AJAX requests.

  • $query_args (array) - target list query args
  • $orderby (string) - sorting parameter name

us_before_404 #

Action. Fires before the default 404 page content, right after the opening .l-section-h div.

us_before_archive #

Action. Fires before the default archive template, right after the opening .l-section-h div.

us_before_canvas #

Action. Fires just before the .l-canvas top-level div.

us_before_closing_head_tag #

Action. Fires just before the closing </head> tag, much like the default wp_head WordPress action.

us_before_footer #

Action. Fires just before the opening <footer> tag, when a page is not in an iframe or pagination via an AJAX request.

us_before_header #

Action. Fires just before the opening <header> tag on the front-end, does not fire if there is no header on the given page.

us_before_js_composer_mappings #

Action. Fires before applying theme-related changes to WPBakery. Does not fire if the plugin is not active.

us_before_page #

Action. Fires right after the <main> tag opens on single pages, search, home, and 404 pages.

us_before_template:{file_path} #

Action. Fires before the specified template file is loaded, called for most of the theme templates, including internal. {file_path} in this hook is a path to a template, like us_after_template:templates/content.

us_carousel_js_options #

Filter. Filters OwlCarousel2 JavaScript parameters for all carousels except Image Slider and Content Carousel.

  • $js_options (array) - array of OwlCarousel2 JS parameters
  • $vars (array) - template variables such as selected design settings

us_comment_form_fields #

Filter. Filters comment form fields just before they are displayed.

  • $fields (array) - form field data

us_conditional_param_options #

Filter. Filters display logic options, allowing to add a custom one, see the documentation for examples.

  • $options (array) - array of available conditions

us_conditional_param_result #

Filter. Filters display logic execution results after all checks are done. Might be used to process a custom condition, see this article for examples.

  • $condition_result (bool) - whether the check succeeded
  • $condition_param (string) - condition parameter name to distinguish them
  • $current_id (int) - current object ID

us_conditions_custom_field_acf_format #

Filter. Filters control the value that determines whether to apply the ACF format to a value during custom-fields-based conditions matching, with TRUE by default.

  • $acf_format (bool) - whether to apply ACF format or retrieve raw value
  • $meta_key (string) - custom field name
  • $current_id (int) - current object ID

us_config_{file_path} #

Filter. Filters full config data when UpSolution Core retrieves a config for the front end or to display editable options in the builder. Dynamic {file_path} in this hook is a config name, e.g., us_config_elements/post_image.

  • $config (array) - full config data

us_content_carousel_items_html #

Filter. Filters the full Content Carousel element HTML content.

  • $content (string) - HTML content with shortcodes expanded

us_content_carousel_js_options #

Filter. Filters OwlCarousel2 JavaScript parameters for the Content Carousel element.

  • $js_options (array) - array of OwlCarousel2 JS parameters

us_content_template_the_content #

Filter. Filters Page Template content, preserving shortcodes.

  • $content (string) - the Page Template content

us_cookie_notice_btn_atts #

Filter. Filters Cookie Notice accept button arguments, allowing to add a custom one.

  • $cookie_btn_atts (array) - cookie notice html attributes

us_doing_ajax_in_admin #

Filter. Filters a condition, used to separate editor and front-end functions for better performance.

  • $result (bool) - whether the current AJAX request is admin-only 

us_edit_atts_fallback_us_{elm_name} #

Filter. Filters theme elements' fallback options in Grid Layout and Header Builder. {elm_name} in this hook is the element name without prefixes, like us_edit_atts_fallback_us_post_title

  • $elm_options (array) - all element settings

us_fallback_atts_{shortcode_base} #

Filter. Filters shortcode attributes to apply fallbacks. {shortcode_base} in this hook is the shortcode base, like us_fallback_atts_us_post_list

  • $atts (array) - shortcode attributes
  • $content (string) - shortcode content

us_fallback_atts_us_{elm_name} #

Filter. Filters specific elements settings to apply fallbacks in the header and for the Optimize JS & CSS option. {elm_name} in this hook is the element name, e.g., us_fallback_atts_us_popup

  • $elm_data (array) - full element settings

us_fallback_metabox_value #

Filter. Filters theme metabox values in Live Builder, such as page Header and Footer metaboxes.

  • $field_key (string) - meta name
  • $field (array) - raw value
  • $meta_value (mixed) - formatted value

us_file_paths #

Filter. Filters an array later filled with found files, e.g., theme PHP configs. Might be used to add a custom file path.

  • $us_file_paths (array) - array of all found files

us_files_search_paths #

Filter. Filters paths, known to the theme. Might be used to include a custom plugin to search locations.

  • $us_files_search_paths (array) - an array of paths known to the theme

us_filter_{asset_name}_callbacks #

Filters an array of callback functions that check whether assets of a certain type are used. {asset_name} in this hook is the feature name, like auto_optimize_assets or used_icons.

  • $callbacks (array) - an array of functions deciding whether optimisation is needed

us_filter_indexer_complete #

Action. Fires whenever faceted filter indexing is completed.

us_filter_indexer_index_all #

Action. Fires when faceted filter indexing for all posts(as opposed to a single post) begins.

us_filter_indexer_index_post #

Action. Fires when single post indexing happens.

  • $post_id (int) - post id

us_filter_indexer_insert_indexes #

Filter. Filters Faceted Filtering indexes array just before inserting the indexes into the database, allowing for adding your own.

  • $indexes (array) - array of indexes
  • $defaults (array) - default values to fill in indexes if needed

us_filter_indexer_is_post_indexing #

Filter. Filters post ID to decide whether to skip the post if the filter returns a value that is considered empty.

  • $post_id (int) - post id indexer processes

us_filter_indexer_meta_value #

Filter. Filters the meta value when the faceted filter indexer indexes a post, by post meta.

  • $val (string) - meta value
  • $source_name (string) - meta name

us_filter_indexer_query_args #

Filter. Filters WP_Query arguments when the faceted filter indexer collects post IDs to index all eligible posts.

  • $query_args (array) - WP_Query arguments array

us_filter_indexer_remote_post_args #

Filter. Filters remote request arguments when faceted filter resumes stalled indexing.

  • $post_args (array) - POST request args

us_filter_indexer_use_bigint #

Filter. Filters a control value that decides whether the faceted filtering database table should use INT or BIG INT.

  • $int (bool) - whether to use INT or BIG INT

us_filter_posts_by_language #

Filter. Filters the list of posts retrieved for admin metaboxes and theme options like headers and footers, if language was explicitly specified by the translation plugin or other hooks.

  • $posts (array) - array of posts to filter.

us_footer_atts #

Filter. Filters footer tag attributes on the front end.

  • $footer_atts (array) - associative array of attributes
  • $footer_id (int) - footer ID

us_footer_post_content #

Filter. Filters the content of the reusable block, assigned as a footer.

  • $post_content (string) - footer post content
  • $footer_id (int) - footer ID

us_form_captcha_end #

Action. Fires right after the built-in Contact Form captcha field <input> tag on the front end.

  • $vars (array) - captcha field settings

us_form_captcha_start #

Action. Fires just before the built-in Contact Form captcha field <input> tag on the front end.

  • $vars (array) - captcha field settings

us_form_field_end #

Action. Fires after the built-in Contact Form field tag, like <input> or <textarea>, is printed on the front end.

  • $vars (array) - contact form field settings

us_form_field_start #

Action. Fires before the built-in Contact Form field tag, like <input> or <textarea>, is printed on the front end.

  • $vars (array) - contact form field settings

us_form_html_atts #

Filter. Filters form HTML attributes for theme forms, such as Login or Contact form.

  • $_atts (array) - preset HTML attributes
  • $vars (array) - form settings

us_gallery_img_title #

Filter. Filters Gallery element images text titles, if the Show Title of Images option is ON.

  • $title (string) - title text
  • $img_post (WP_Post) - image post object
  • $_atts (array) - array of parent gallery attributes

us_gallery_orderby_options #

Filter. Filters Gallery element orderby options.

  • $orderby_options (array) - available orderby options

us_gallery_query_args #

Filter. Filters Gallery element WP_Query arguments.

  • $query_args (array) - WP_Query arguments
  • $_atts (array) - full element settings

us_generate_link_atts #

Filter. Filters HTML attributes, generated for link fields based on provided link field settings.

  • $link_atts (array) - link HTML attributes
  • $link (string) - link URL
  • $additional_data (array) - additional data needed to generate attributes

us_get_current_id #

Filter. Filters post ID in a variety of theme functions.

  • $current_id (int) - current ID

us_get_current_meta_type #

Filter. Filters meta type (where look for it) - either post, term, or user.

  • $meta_type (string) - currently computed meta type

us_get_custom_field #

Filter. Filters the value of a custom field in any context.

  • $value (mixed) - meta value
  • $name (string) - meta key
  • $current_id (mixed) - current object ID or string value of 'option'
  • $current_meta_type (string) - current object type, either post, term, or user.
  • $acf_format (bool) - whether to apply ACF format or get the raw value

us_get_edit_post_link #

Filter. Filters the URL of a link to edit a certain post.

  • $url (string) - admin URL
  • $post_id (int) - ID of the post to edit
  • $post_type (string) - post type of the post to edit

us_get_faceted_filter_post_ids_args #

Filter. Filters arguments of the query, retrieving only post IDs by the provided arguments and List Filters.

  • $query_args (array) - WP_Query arguments

us_get_ip #

Filter. Filters IP retrieved from the external request. Used in the contact form.

  • $ip (string) - computed IP

us_get_list_filter_params #

Filter. Filters List Filter pre-defined parameters.

  • $params (array) - List Filter params

us_get_list_orderby_params #

Filter. Filters List Order pre-defined parameters.

  • $params (array) - List Order params

us_get_loop_post_types #

Filter. Filters post types available in Lists, Carousels, and Filters of the List-system.

  • $post_types (array) - available post types

us_get_page_area_id #

Filter. Filters page area ID when it is retrieved.

  • $area_id (int) - computed area ID
  • $area (string) - area name
  • $page_args (array) - page parameters such as post type or purpose

us_get_post_preview #

Filter. Filters part of the current post that can be used as the post's preview. Currently applied to Gallery, Audio, and Video post formats.

  • $preview_html (string) - generated HTML
  • $id (int) - post ID

us_get_taxonomies #

Filter. Filters taxonomies, available in theme elements.

  • $result (array) - taxonomies array
  • $public_only (bool) - whether to get public taxonomies only
  • $show_slug (bool) - whether to add taxonomy slug to name
  • $output (string) - command string that might exclude WooCommerce taxonomies or show WooCommerce taxonomies only

us_global_theme_options_js #

Filter. Filters global theme options exposed to JS, such as Disable Effects Width.

  • $html (string) - script tag with JS code

us_grid_filter_item_value_html #

Filter. Filters deprecated Grid Filter items' values output.

  • $item_value_html (string) - original HTML semantics for Filter item value
  • $item_value (object) - item value params

us_grid_filter_main_query_args #

Filter. Filters query arguments used to retrieve posts count in the deprecated Grid Filter.

  • $query_args (array) - WP_Query arguments to filter
  • $grids_found (array) - array of Grids settings

us_grid_item_classes #

Filter. Filters CSS-classes assigned to Grid and List items.

  • $classes (string) - current Grid item classes
  • $term_id (int) - term ID

us_grid_layout_settings #

Filter. Filters Grid Layout settings on the front end.

  • $result (array) - Grid Layout settings and content

us_grid_listing_post #

Filter. Filters full loop item markup for post in the List or Carousel.

  • $item_html (string) - full HTML of the loop item

us_grid_listing_term #

Filter. Filters full loop item markup for a term in the List or Carousel.

  • $item_html (string) - full HTML of the loop item

us_grid_listing_user #

Filter. Filters full loop item markup for a user in the List or Carousel.

  • $item_html (string) - full HTML of the loop item

us_header_atts #

Filter. Filters the <header> tag HTML attributes on the front end.

  • $header_atts (array) - predefined attributes
  • $header_id (int) - header ID

us_html_dynamic_values #

Filter. Filters dynamic values available in the HTML-type fields in admin, e.g., in the Custom HTML element.

  • $predefined_dynamic_values (array) - default dynamic values

us_icon_class #

Filter. Filters icon name in various theme elements on the front end.

  • $icon (string) - Font Awesome icon name

us_icon_tag #

Filter. Filters icon HTML tag in various theme elements.

  • $icon_tag (string) - full icon HTML

us_iconbox_svg_output #

Filter. Filters SVG image code in the Icon Box element.

  • $icon_html (string) - full SVG code
  • $img (int) - attachment ID

us_image_dynamic_values #

Filter. Filters dynamic values, available in Image-type fields in both editors in admin.

  • $predefined_dynamic_values (array) - default dynamic values

us_image_sizes_select_values #

Filter. Filters registred image sizes, available for selection in theme elements.

  • $image_size (array) - registred image sizes

us_image_slider_js_options #

Filter. Filters Royal Slider library JavaScript options for the Image Slider element.

  • $js_options (array) - array of JS options

us_image_slider_query_args #

Filter. Filters Image Slider query args for the query that fetches posts for the element.

  • $query_args (array) - WP_Query arguments

us_is_output_design_css_for_content #

Filter. Filters a switch that can cancel printing Design settings styles from all sources on the front-end page if FALSE is returned.

  • $allow (bool) - whether to output styles or not

us_is_valid_ajax_referer #

Filter. Filters a function that checks whether an AJAX HTTP referer domain matches the site domain.

  • $result (bool) - check result

us_layout_after_init #

Action. Fires after the theme layout object is constructed.

  • $layout (US_Layout) - constructed layout object

us_layout_before_init #

Action. Fires before the theme layout object is constructed.

  • $layout (US_Layout) - layout object filled with defaults

us_link_dynamic_values #

Filter. Filters Link-type dynamic values in admin editor dynamic value popups.

  • $predefined_dynamic_values (array) - predefined dynamic values

us_list_filter_author_args #

Filter. Filters arguments of the query retrieving users to filter by in the List Filter elements.

  • $author_args (array) - WP_User_Query arguments

us_list_filter_datepicker_options #

Filter. Filters JQuery UI Date Picker widget JS options for date-based List Filter fields on the front end. 

  • $datepicker_options (array) - array of Date Picker JS options
  • $_name (string) - field name equal to the value of the "Fields to Show" option

us_list_filter_post_types #

Filter. Filters post types available for selection in the List Filter in builders.

  • $post_type_options (array) - associative array of detected post types

us_list_filter_range_input_options #

Filter. Filters Range Input-type fields' JavaScript options in List Filter.

  • $slider_opts (array) - slider options
  • $item_name (string) - filter item name

us_list_filter_range_slider_options #

Filter. Filters jQuery UI Range Slider JavaScript options in relevant fields in List Filter. 

  • $slider_opts (array) - slider options
  • $item_name (string) - filter item name

us_list_filter_source_options #

Filter. Filters source options available for selection in the List Filter element in admin editors.

  • $source_options (array) - array of available sources

us_list_filter_terms_args #

Filter. Filters query arguments used to retrieve available terms for the List Filter element on the front end and in the Live Builder preview.

  • $terms_args (array) - WP_Term_Query args
  • $filter_item (string) - item name

us_list_filter_value_html_atts #

Filter. Filters List Filter item HTML attributes on the front end.

  • $_atts (array) - array of computed HTML attributes
  • $item_value (array) - array of List Filters item settings
  • $item_name (string) - List Filter item name

us_list_filter_value_label #

Filter. Filters List Filter item label text on the front end and Live Builder preview.

  • $_label (string) - label text
  • $item_value (array) - array of List Filters item settings
  • $item_name (string) - List Filter item name

us_list_filter_values_output_limit #

Filter. Filters the limit of checkboxes/radio buttons/options a single List Filter item can show, set for browser performance reasons.

  • $limit (int) - current limit

us_load_header_settings #

Filter. Filters header settings for each responsive state on the front end and Live Builder preview.

  • $us_header_settings (array) - header settings array

us_maps_js_options #

Filter. Filters Google Maps or Open Street Maps JS options depending on the relevant Map element settings.

  • $map_options (array) - JS options array
  • $id (int) - current post ID
  • $el_id (string) - element HTML ID

us_media_category_update_count_callback #

Action. Fires when the count of posts with media category assigned changes.

us_meta_tags #

Filter. Filters HTML meta tags on the front end, both general and SEO-related, if the relevant function is enabled.

  • $meta_tags (array) - generated meta tags

us_mobile_menu_icon_html #

Filter. Filters additional markup for the Menu element in mobile layout.

  • $html (string) - additional menu markup
  • $mobile_icon_style (string) - menu style selected in the element settings

us_mobile_menu_icon_styles #

Filter. Filters available for mobile layout (burger) Menu styles in the Header Builder.

  • $mobile_menu_icon_styles (array) - available mobile menu styles

us_output_design_css #

Filter. Filters Design settings CSS, before it is printed.

  • $jsoncss_collection (array) - design settings detected on the page

us_output_design_css_include_ids #

Filter. Filters a collection of additional post IDs to include in the design CSS search, such as popups displaying Reusable Blocks.

  • $include_ids (array) - additional post IDs to pull Design settings from

us_page_block_the_content #

Filter. Filters Reusable Block content in various theme elements.

  • $page_block_content (string) - full Reusable Block content

us_pass_header_settings_to_js #

Filter. Filters script tag with header settings as executable JavaScript.

  • $output (string) - header settings

us_portfolio_category_label #

Filter. Filters Portfolio category label.

  • $label (string) - current portfolio category label

us_portfolio_tags_label #

Filter. Filters Portfolio tag label.

  • $label (string) - current portfolio tag label

us_post_image #

Filter. Filters the Post Image element HTML output.

  • $output (string) - full post image HTML
  • $_post_preview (string) - image or preview HTML without link
  • $link_atts (array) - link HTML attributes array

us_post_list_orderby_options #

Filter. Filters orderby options in Post List config, both on the front end and back end.

  • $orderby_options (array) - available orderby options

us_post_list_query_args #

Filter. Filters Post List element query arguments to allow for altering the selection of posts it shows.

  • $query_args (array) - WP_Query arguments
  • $filled_atts (array) - element settings

us_post_list_query_args_unfiltered #

Filter. Filters Post List element query arguments before applying the orderby and filter params to allow for altering the selection of posts it shows.

  • $query_args (array) - WP_Query arguments
  • $filled_atts (array) - element settings

us_post_list_source_options #

Filter. Filters sources available for selection in the Post List element.

  • $source_options (array) - array of available sources

us_post_taxonomy_terms #

Filter. Filters Post Taxonomy element fetched terms collection.

  • $terms (array) - fetched terms
  • $_atts (array) - element HTML attributes

us_product_list_orderby_options #

Filter. Filters orderby options in Product List config, both on the front end and back end.

  • $orderby_options (array) - available orderby options

us_product_list_query_args #

Filter. Filters Product List element query arguments that affects products selection.

  • $query_args (array) - WP_Query arguments
  • $filled_atts (array) - element settings

us_product_list_source_options #

Filter. Filters sources available for selection in the Product List element.

  • $source_options (array) - array of available sources

us_recent_sales_order_args #

Filter. Filters query arguments used to fetch orders that count towards product sales for the "Sales for the last X days" orderby option in Product List.

  • $order_args (array) - WC_Order_Query arguments

us_regenerate_thumbnails_is_enabled #

Filter. Filters a control switch that allows or disallows regenerating thumbnails after editing image sizes in theme options.

  • $save (bool) - control switch

us_rel_canonical #

Filter. Filters theme's canonical link tag used instead of the default WordPress one.

  • $canonical (string) - full link tag code

us_replace_dynamic_value #

Filter. Filters dynamic values in {{specific_format}}, allowing for adding your own.

  • $matches (string) - dynamic value text with brackets
  • $current_id (int) - current object id

us_replace_dynamic_value_term_separator #

Filter. Filters taxonomy term separator in {{tax|taxonomy_name}} dynamic value output.

  • $separator (string) - term separator

us_replace_dynamic_value_thumbnail #

Filter. Filters post thumbnail ID returned by {{the_thumbnail}} dynamic value.

  • $id (string) - computed id

us_replace_variable_color_with_value #

Filter. Filters Design options CSS data for a single element in the header, post content, and Grid Layouts.

  • $css_options (array) - found CSS options

us_sharing_item_title #

Filter. Filters Sharing Buttons element items tooltip text, and aria-labels.

  • $provider_text (string) - current Sharing Buttons items text
  • $provider (string) - provider name

us_shortcode_atts #

Filter. Filters combined default shortcode attributes and passed ones for a certain shortcode on the front end and in the Live Builder.

  • $atts (array) - shortcode attributes
  • $shortcode (string) - shortcode name

us_show_privacy_block #

Filter. Filters control value, which decides whether to show the privacy notice in the Map and Video elements showing third-party content.

  • $show_privacy_block (bool) - show privacy notice or not
  • $provider (string) - provider name

us_socials_item_title #

Filter. Filters the Social Links element item title.

  • $title (string) - item title like 'Facebook' or 'TikTok'

us_template_not_found:{file_path} #

Action. Fires if the specified template is not found. {file_path} in this hook is the template name and path, like us_template_not_found:templates/footer.

  • $vars (array) - variables passed to the template

us_template_vars:{file_path} #

Filter. Filters template variables for the specific template. {file_path} in this hook is the template name and path, like us_template_vars:templates/us_grid/listing.

  • $vars (array) - variables passed to the template

us_term_list_orderby_options #

Filter. Filters orderby options in Term List config, both on the front end and the back end.

  • $orderby_options (array) - available orderby options

us_term_list_query_args #

Filter. Filters Term List element query arguments to alter the selection of terms it shows.

  • $query_args (array) - WP_Term_Query arguments
  • $filled_atts (array) - element settings

us_term_list_source_options #

Filter. Filters sources available for selection in the Term List element.

  • $source_options (array) - array of available sources

us_text_dynamic_values #

Filter. Filters dynamic values, available in the Text-type fields in the admin editor.

  • $predefined_dynamic_values (array) - default dynamic values

us_textarea_dynamic_values #

Filter. Filters dynamic values, available in Text Area-type fields in the admin editor.

  • $predefined_dynamic_values (array) - default dynamic values

us_theme_icon #

Action. Fires after printing admin styles.

us_theme_name #

Filter. Filters the theme display name across various places in the admin.

  • $themename (string) - theme display name

us_tr_current_language #

Filter. Filters the current language in various theme elements, both on the front end and in the admin for translation plugins to correct it.

  • $empty_value (mixed) - default value

us_tr_default_language #

Filter. Filters the default language in various theme elements, both on the front end and in the admin for translation plugins to correct it.

  • $empty_value (mixed) - default value

us_tr_get_post_language_code #

Filter. Filters the post language code for a specific post.

  • $id (mixed) - an ID of the post to get the language code for

us_tr_home_url #

Filter. Filters the home URL for translation plugins to correct it.

  • $default_value (bool) - default value

us_tr_object_id #

Filter. Filters a translated post ID or term ID for translation plugins to handle it.

  • $elm_id (int) - object ID to translate
  • $post_type (string) - post type of the object
  • $return_original_if_missing (bool) - control switch
  • $lang_code (mixed) - language code

us_tr_selected_lang_page #

Filter. Filters selected language on the page.

  • $default_value (bool) - default value

us_tr_setting #

Filter. Filters translation settings requested from the translation plugins.

  • $key (string) - setting name
  • $default (mixed) - default value

us_tr_switch_language #

Action. Fires in deprecated Grid element AJAX requests, when a language is explicitly specified to allow for switching it in translation plugins.

  • $lang (string) - language to switch to

us_tta_source_options #

Filter. Filters data source options in Tabs and Accordion elements.

  • $source_options (array) - current options

us_user_list_orderby_options #

Filter. Filters orderby options in User List config, both on the front end and the back end.

  • $orderby_options (array) - available orderby options

us_user_list_query_args #

Filter. Filters the User List element query arguments to alter the selection of users it shows.

  • $query_args (array) - WP_User_Query arguments
  • $filled_atts (array) - element settings

us_user_list_source_options #

Filter. Filters sources available for selection in the User List element.

  • $source_options (array) - array of available sources

us_user_profile_html #

Filter. Filters user profile HTML in the Login element.

  • $output (string) - full HTML output
  • $logout_redirect (string) - path to redirect to on logout
  • $hidden (bool) - whether the element should be hidden

us_vc_row_bg_img_html #

Filter. Filters the HTML code of the Row Background Image.

  • $bg_img_html (string) - background image HTML

us_vc_row_bg_overlay_html #

Filter. Filters the HTML code of the Row Background Overlay.

  • $bg_overlay_html (string) - background overlay HTML

us_vc_row_bg_shape_html #

Filter. Filters the HTML code of the Row Shape Divider.

  • $bg_shape_html (string) - shape divider HTML markup

us_vc_row_bg_slider_html #

Filter. Filters Row element Show on background > Image Slider feature HTML.

  • $bg_slider_html (string) - slider HTML markup

us_vc_row_bg_video_html #

Filter. Filters Row element Show on background > Video feature HTML.

  • $bg_video_html (string) - video HTML markup

us_vc_tta_tabs_content #

Filter. Filters Tabs/Accordion/Vertical tabs content with shortcodes not expanded.

  • $content (string) - Tabs/Accordion/Vertical tabs nested shortcodes
  • $filled_atts (array) - element settings

us_video_player_embed_html #

Filter. Filters the Video Player element video markup generated depending on the video source.

  • $embed_html (string) - HTML of the video
  • $atts (array) - filled settings

us_vimeo_video_params_row #

Filter. Filters Vimeo video player settings in the Row element background video.

  • $video_params (array) - Vimeo video player settings

us_youtube_video_params_row #

Filter. Filters YouTube player settings in the Row element background video.

  • $video_params (array) - YouTube player parameters

usb_admin_footer_scripts #

Action. Fires in the Live Builder, just before the closing </body> tag, allowing for printing scripts.

usb_before_render_shortcode #

Action. Fires in the Live Builder before rendering a shortcode, e.g., when an element was just placed.

  • $content (string) - shortcode as text

usb_config_elm_titles #

Filter. Filters the array of additional Live Builder shortcode titles, even those that are not supported.

  • $titles (array) - array of additional shortcode titles

usb_enqueue_assets_for_builder #

Action. Fires before outputting builder and theme files after the <body> tag.

usb_get_panel_content #

Filter. Filters the full Live Builder side panel HTML content.

  • $content (string) - Live Builder side panel HTML

usb_get_panel_title #

Filter. Filters Live Builder side panel title.

  • $title (string) - panel title text

usb_is_builder_page #

Filter. Filters control value, which determines whether the page is considered a builder page.

  • $is_builder_page (bool) - current computed value of the switch

usb_main_menu_items #

Filter. Filters Live Builder main menu items.

  • $menu_items (array) - current set of menu items
  • $post_id (int) - current post ID
  • $post_type (string) - current post type

usb_output_post_custom_css #

Filter. Filters page custom CSS in Live Builder on page load.

  • $post_custom_css (string) - full page custom CSS code
  • $post_id (int) - current post ID

usb_shortcode_preparate_text #

Filter. Filters post content, optimised for display in Live Builder before displaying it in said editor.

  • $content (string) - full page content with shortcodes preserved