| Server IP : 85.214.239.14 / Your IP : 18.220.63.83 Web Server : Apache/2.4.62 (Debian) System : Linux h2886529.stratoserver.net 4.9.0 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.18 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /var/www/wordpress/wp-content/themes/Divi/includes/builder/ |
Upload File : |
<?php
/**
* Base class for all builder elements.
*
* @package Divi
* @subpackage Builder
* @since 1.0
*/
if ( ! defined( 'ET_BUILDER_OPTIMIZE_TEMPLATES' ) ) {
define( 'ET_BUILDER_OPTIMIZE_TEMPLATES', true );
}
define( 'ET_BUILDER_AJAX_TEMPLATES_AMOUNT', apply_filters( 'et_pb_templates_loading_amount', ET_BUILDER_OPTIMIZE_TEMPLATES ? 20 : 10 ) );
add_action( 'init', array( 'ET_Builder_Element', 'set_media_queries' ), 11 );
add_action( 'wp_footer', array( 'ET_Builder_Element', 'enqueue_scroll_effects_fields' ), 11 );
/**
* Base class for all builder elements.
*
* @since 1.0
*/
class ET_Builder_Element {
/**
* Module name.
*
* @var string
*/
public $name;
/**
* Module plural name.
*
* @var string
*/
public $plural;
/**
* Module slug.
*
* @var string
*/
public $slug;
/**
* Module type e.g child.
*
* @var string
*/
public $type;
/**
* Child module slug.
*
* @var string
*/
public $child_slug;
/**
* Set true if module use raw content e.g Code module.
*
* @var bool
*/
public $use_raw_content = false;
/**
* Modules fields.
*
* @var array
*/
public $fields = array();
/**
* Modules advanced fields.
*
* @var mixed
*/
public $advanced_fields;
/**
* Whether module has advanced fields.
*
* @var bool
*/
public $has_advanced_fields;
/**
* Cached translations.
*
* @since 4.4.9
*
* @var array[]
*/
protected static $i18n;
/**
* See {@see deprecations.php}
*
* @var array[]
*/
protected static $_deprecations;
/**
* Unprocessed attributes.
*
* @since 3.17.2
*
* @var mixed[]
*/
protected $attrs_unprocessed = array();
/**
* Unprocessed content.
*
* @since 3.17.2
*
* @var string
*/
protected $content_unprocessed = '';
/**
* Settings used to render the module's output.
*
* @since 3.1 Renamed from `$shortcode_atts` to `$props`.
* @since 1.0
*
* @var array
*/
public $props = array();
/**
* What appears inside the element. For structure elements, this will contain children
* elements. For parent modules, this will include child modules.
*
* @since 3.1 Renamed from `$shortcode_content` to `$content`.
* @since 1.0
*
* @var string
*/
public $content;
/**
* Configuration for module's wrapper and inner wrapper
*
* @since 3.1
*
* @var array
*/
public $wrapper_settings = array();
/**
* Unique field definitions that are used in each modules.
*
* @var array
*/
public $fields_unprocessed = array();
/**
* Main css selector of element.
*
* @var string
*/
public $main_css_element;
/**
* Custom css fields of module.
*
* @var array|mixed
*/
public $custom_css_fields = array();
/**
* Child item label var. e.x `admin_title` field var.
*
* @var string
*/
public $child_title_var;
/**
* Child item label fallback var.
*
* @var string
*/
public $child_title_fallback_var;
/**
* Divi Builder enabled Post Types.
*
* @var array|mixed|void
*/
public $post_types = array();
/**
* Main modules tabs. e.g `Content`, `Design` and `Advanced`
*
* @var array|mixed|void
*/
public $main_tabs = array();
/**
* BB :: Main modules tabs. e.g `general`, `advanced` and `custom_css`
*
* @var array
*/
public $used_tabs = array();
/**
* Whether module support custom css options e.g `Advanced > Custom CSS` toggle.
*
* @var bool
*/
public $custom_css_tab;
/**
* Whether module support visual builder. e.g `on` or `off`.
*
* @var string
*/
public $vb_support = 'off';
/**
* Options list to not replace %22 with double quotes while rendering.
*
* @var array
*/
public $dbl_quote_exception_options = array( 'et_pb_font_icon', 'et_pb_button_one_icon', 'et_pb_button_two_icon', 'et_pb_button_icon', 'et_pb_content' );
/**
* Module's settings modal custom tabs.
*
* @var array|array[]
*/
public $settings_modal_tabs = array();
/**
* Module's settings modal toggles. e.x `background`, `custom css`.
*
* @var array|mixed
*/
public $settings_modal_toggles = array();
/**
* Whether module support post featured image background.
*
* @var bool
*/
public $featured_image_background = false;
/**
* All CSS classes name the module has.
*
* @var array
*/
public $classname = array();
/**
* Module's help video configuration array.
*
* @var array
*/
public $help_videos = array();
/**
* Whether `ET_Builder_Module_Settings_Migration` class initialized.
*
* @var bool
*/
public static $settings_migrations_initialized = false;
/**
* Unused var. @todo Remove this unused var.
*
* @var bool
*/
public static $setting_advanced_styles = false;
/**
* An array of modules where `module_classname()` used.
*
* @var array
*/
public static $uses_module_classname = array();
/**
* Unique field definitions across all modules.
*
* @var array
*/
protected static $_fields_unprocessed = array();
/**
* Default props of each modules.
*
* @var array
*/
protected static $_default_props = array();
/**
* Slugs of modules for which an option template has been rebuilt.
*
* @var array
*/
protected static $_has_rebuilt_option_template = array();
/**
* Modules cache.
*
* @var bool
*/
private static $_cache = false;
/**
* Keys map of unique BB templates.
*
* @var array
*/
private static $_unique_bb_keys_map = array();
/**
* List of unique BB templates.
*
* @var array
*/
private static $_unique_bb_keys_values = array();
/**
* List of tabs/newlines characters.
*
* @var array
*/
private static $_unique_bb_strip = array( "\t", "\r", "\n" );
/**
* Scroll effects fields of all modules.
*
* @var array
*/
public static $_scroll_effects_fields = array(
'desktop' => array(),
'tablet' => array(),
'phone' => array(),
);
/**
* Sticky element configuration
*
* @since 4.6.0
*
* @var array
*/
public static $sticky_elements = array();
/**
* Number of times {@see self::render()} has been executed.
*
* @var int
*/
private $_render_count;
/**
* Number of times {@see self::render()} has been executed for the shop module.
*
* @var int
*/
private static $_shop_render_count = 0;
/**
* Slug of a module whose render count should also be bumped when this module's is bumped.
*
* @var string
*/
protected $_bumps_render_count;
/**
* Priority number applied to some CSS rules.
*
* @var int
*/
protected $_style_priority;
/**
* Nnly needed for BB + hover.
*
* @var bool
*/
protected $is_background = false;
/**
* Whether module is official divi module.
*
* @var bool
*/
private $_is_official_module;
/**
* Whether module is woocommerce module.
*
* @var bool
*/
private $_is_woocommerce_module;
/**
* Uses for ligatures disabling at elements with letter-spacing CSS property.
*
* @var array
*/
private $letter_spacing_fix_selectors = array();
/**
* Holds module styles for the current request.
*
* @var array
*/
private static $styles = array();
/**
* Holds internal module styles for the current module.
* e.x In the Blog post module, {@see $internal_modules_styles} will hold style of all posts.
*
* @var array
*/
private static $internal_modules_styles = array();
/**
* Whether to save styles to the {@see $internal_modules_styles}.
*
* @var bool
*/
private static $prepare_internal_styles = false;
/**
* Internal modules counter.
*
* @var int
*/
private static $internal_modules_counter = 10000;
/**
* Media queries key value pairs. {@see get_media_quries()}
*
* @var array
*/
private static $media_queries = array();
/**
* List of all modules instance that extends this class.
*
* @var array
*/
private static $modules = array();
/**
* List of all parent modules instance that extends this class.
* e.x Accordion, BarCounters.
*
* @var array
*/
private static $parent_modules = array();
/**
* List of all child modules instance that extends this class.
* e.x AccordionItem, BarCountersItems.
*
* @var array
*/
private static $child_modules = array();
/**
* List of all woocommerce modules instance that extends this class.
*
* @var array
*/
private static $woocommerce_modules = array();
/**
* Hold current module index while loading backbone templates in batch.
*
* @var int
*/
private static $current_module_index = 0;
/**
* List of all structure modules objects.
* e.x Section, Row, Row Inner, Columns.
*
* @var array
*/
private static $structure_modules = array();
/**
* List of all structure modules slugs.
*
* @var array
*/
private static $structure_module_slugs = array();
/**
* List of all modules slugs by post type.
*
* @var array
*/
private static $_module_slugs_by_post_type = array();
/**
* Module Icons displayed in Add Module modals.
*
* @var array
*/
private static $module_icons = array();
/**
* List of all modules help videos.
*
* @var array
*/
private static $module_help_videos = array();
/**
* Parent module's motion/scroll effects options settings.
*
* @var array
*/
private static $parent_motion_effects = array();
/**
* A stack of the current active theme builder layout post type.
*
* @var string[]
*/
protected static $theme_builder_layout = array();
/**
* Compile list of modules that has rich editor option.
*
* @var array
*/
protected static $has_content_modules = array();
/**
* Whether loading backbone templates.
*
* @var bool
*/
private static $loading_backbone_templates = false;
/**
* Instance of `ET_Core_Data_Utils`.
*
* @var ET_Core_Data_Utils
*/
protected static $_ = null;
/**
* `ET_Core_PageResource` class instance.
*
* @var ET_Core_PageResource
*/
public static $advanced_styles_manager = null;
/**
* Whether to force inline styles.
*
* @var bool
*/
public static $forced_inline_styles = false;
/**
* `ET_Core_Data_Utils` instance.
*
* @var ET_Core_Data_Utils
*/
public static $data_utils = null;
/**
* `ET_Builder_Module_Helper_OptionTemplate` instance.
*
* @var ET_Builder_Module_Helper_OptionTemplate
*/
public static $option_template = null;
/**
* Composite field dependencies settings.
* e.g `show_if`, `show_if_not`
*
* @var array
*/
public static $field_dependencies = array();
/**
* Whether element indexes can be reset or not.
*
* @var bool
*/
public static $can_reset_element_indexes = true;
const DEFAULT_PRIORITY = 10;
const HIDE_ON_MOBILE = 'et-hide-mobile';
/**
* Credits of all custom modules.
*
* @var array
*/
protected $module_credits;
/**
* Store various indices for modules etc.
*
* @since 4.0
*
* @var array $indices {
* Module Indices By Post Type
*
* @type array $post_type {
* Module Indices
*
* @type int|int[] $index_type Current index value(s) {
* Index Values By Module Slug
*
* @type int $slug Index value
* }
* }
* }
*/
protected static $_indices = array();
const INDEX_SECTION = 'section';
const INDEX_ROW = 'row';
const INDEX_ROW_INNER = 'row_inner';
const INDEX_COLUMN = 'column';
const INDEX_COLUMN_INNER = 'column_inner';
const INDEX_MODULE = 'module';
const INDEX_MODULE_ITEM = 'module_item';
const INDEX_MODULE_ORDER = 'module_order';
const INDEX_INNER_MODULE_ORDER = 'inner_module_order';
/**
* Instance of `ET_Builder_Global_Presets_Settings`.
*
* @var ET_Builder_Global_Presets_Settings
*/
protected static $global_presets_manager = null;
/**
* Flag whether the module is rendering.
*
* @var boolean
*/
protected $is_rendering = false;
/**
* Flag if current module is sticky or not
*
* @var boolean
*/
protected $is_sticky_module = false;
/**
* List of props keys that need to inherit the value
*
* Intended to be used in ET_Builder_Module_Helper_MultiViewOptions helper
*
* @since 4.0.2
*
* @var array
*/
public $mv_inherited_props = array();
/**
* Background related values generated by process_advanced_background_options()
* Disabled by default; activated by setting $save_processed_background property to true
* Only gradient related value is saved right now; more can be added later if needed
*
* @since 4.3.3
*
* @var array
*/
protected $processed_background = array();
/**
* Set true to save processed background so it can be modified & reapplied on another element.
*
* @var bool
*/
protected $save_processed_background = false;
/**
* Holds active position origin/location for all devices.
*
* @var array
*/
protected $position_locations = array();
/**
* Module settings that are exposed so layout block previewer can correctly render it
* despites tweaks performed to make block preview correctly aligned
*
* @var array
*/
protected static $layout_block_assistive_settings = array();
/**
* ET_Builder_Element constructor.
*/
public function __construct() {
self::$current_module_index++;
if ( ! self::$_deprecations ) {
self::$_deprecations = require_once ET_BUILDER_DIR . 'deprecations.php';
self::$_deprecations = self::$_deprecations['classes']['\ET_Builder_Module_Blurb'];
}
if ( ! self::$settings_migrations_initialized ) {
self::$settings_migrations_initialized = true;
require_once 'module/settings/Migration.php';
ET_Builder_Module_Settings_Migration::init();
add_filter( 'the_content', array( get_class( $this ), 'reset_element_indexes' ), 9999 );
add_filter( 'et_builder_render_layout', array( get_class( $this ), 'reset_element_indexes' ), 9999 );
}
if ( self::$loading_backbone_templates || et_admin_backbone_templates_being_loaded() ) {
if ( ! self::$loading_backbone_templates ) {
self::$loading_backbone_templates = true;
}
// phpcs:disable WordPress.Security.NonceVerification -- The `$_POST` values has not been saved in db, and is therefore not susceptible to CSRF.
$start_from = isset( $_POST['et_templates_start_from'] ) ? (int) sanitize_text_field( $_POST['et_templates_start_from'] ) : 0;
$post_type = isset( $_POST['et_post_type'] ) ? sanitize_text_field( $_POST['et_post_type'] ) : '';
// phpcs:enable
if ( 'layout' === $post_type ) {
// need - 2 to include the et_pb_section and et_pb_row modules.
$start_from = self::get_modules_count( 'page' ) - 2;
}
$current_module_index = self::$current_module_index - 1;
if ( ! ( $current_module_index >= $start_from && $current_module_index < ( ET_BUILDER_AJAX_TEMPLATES_AMOUNT + $start_from ) ) ) {
return;
}
}
if ( null === self::$advanced_styles_manager && ! is_admin() && ! et_fb_is_enabled() ) {
$result = self::setup_advanced_styles_manager();
self::$advanced_styles_manager = $result['manager'];
if ( $result['add_hooks'] ) {
// Schedule callback to run in the footer so we can pass the module design styles to the page resource.
add_action( 'wp_footer', array( 'ET_Builder_Element', 'set_advanced_styles' ), 19 );
// Add filter for the resource data so we can prevent theme customizer css from being
// included with the builder css inline on first-load (since its in the head already).
add_filter( 'et_core_page_resource_get_data', array( 'ET_Builder_Element', 'filter_page_resource_data' ), 10, 3 );
}
add_action( 'wp_footer', array( 'ET_Builder_Element', 'maybe_force_inline_styles' ), 19 );
}
if ( null === self::$data_utils ) {
self::$data_utils = ET_Core_Data_Utils::instance();
self::$_ = self::$data_utils;
}
if ( null === self::$global_presets_manager ) {
self::$global_presets_manager = ET_Builder_Global_Presets_Settings::instance();
}
if ( null === self::$option_template ) {
self::$option_template = et_pb_option_template();
}
$this->init();
$this->settings_modal_tabs = $this->get_settings_modal_tabs();
$this->settings_modal_toggles = $this->get_settings_modal_toggles();
$this->custom_css_fields = $this->get_custom_css_fields_config();
$this->_set_advanced_fields_config();
$current_class = get_class( $this );
$this->_is_official_module = self::_is_official_module( $current_class );
$this->_is_woocommerce_module = self::_is_woocommerce_module( $current_class );
$this->make_options_filterable();
if ( et_fb_is_builder_ajax() ) {
// Ensure `et_fb_is_enabled` returns true while setting fields to avoid
// 3rd party modules using the function to generate different
// definitions when they are updated via the AJAX call.
add_filter( 'et_fb_is_enabled', '__return_true' );
$this->set_fields();
remove_filter( 'et_fb_is_enabled', '__return_true' );
} else {
$this->set_fields();
}
$this->set_factory_objects();
$this->_additional_fields_options = array();
$slug = $this->slug;
// Use module cache compression only when we sure we can also decompress.
$use_compression = function_exists( 'gzinflate' ) && function_exists( 'gzdeflate' );
// Disable compression when debugging.
if ( function_exists( 'et_builder_definition_sort' ) ) {
$use_compression = false;
}
if ( ! empty( self::$_cache[ $slug ] ) ) {
// We got sum cache, let's use it.
$cache = self::$_cache[ $slug ];
$fields_unprocessed = array();
$fields_map = $cache['fields_unprocessed'];
// Since arrays in PHP 5.x require more memory, we have to rely (again)
// on COW (copy on write) to limit RAM usage....
if ( is_array( $fields_map ) ) {
// Old cache storage format (array).
foreach ( $fields_map as $field => $key ) {
$fields_unprocessed[ $field ] = self::$_fields_unprocessed[ $key ];
}
} else {
// New cache storage format (string) key1,field1\n ... keyN,fieldN
// Decompress data when possible.
if ( $use_compression ) {
$fields_map = gzinflate( $fields_map );
}
$fields_map = explode( "\n", $fields_map );
foreach ( $fields_map as $data ) {
list ( $key, $field ) = explode( ':', $data );
$fields_unprocessed[ $field ] = self::$_fields_unprocessed[ $key ];
}
}
$this->has_advanced_fields = ! empty( $cache['advanced_fields'] );
$this->advanced_fields = $cache['advanced_fields'];
$this->fields_unprocessed = $fields_unprocessed;
$this->settings_modal_toggles = $cache['settings_modal_toggles'];
$this->custom_css_fields = $cache['custom_css_fields'];
// Claim some RAM not needed anymore.
unset( self::$_cache[ $slug ] );
} else {
// Compute expensive stuff.
$this->_add_additional_fields();
$this->_add_custom_css_fields();
$this->_maybe_add_global_defaults();
$this->_finalize_all_fields();
// Consider caching only official modules.
if ( $this->_is_official_module && false !== self::$_cache ) {
// We got no cache, let's create it.
$fields_unprocessed = '';
// Since arrays in PHP 5.x require more memory, we can't store
// fields_unprocessed as is but have to replace values with hashes
// when saving the cache and reverse the process when loading it.
foreach ( $this->fields_unprocessed as $field => $definition ) {
$key = md5( serialize( $definition ) );
$fields_unprocessed .= "$key:$field\n";
}
// Trim last newline.
$fields_unprocessed = trim( $fields_unprocessed );
// Compress data when possible.
if ( $use_compression ) {
$fields_unprocessed = gzdeflate( $fields_unprocessed );
}
self::$_cache[ $slug ] = array(
'advanced_fields' => $this->advanced_fields,
'fields_unprocessed' => $fields_unprocessed,
'settings_modal_toggles' => $this->settings_modal_toggles,
'custom_css_fields' => $this->custom_css_fields,
);
}
}
if ( ! isset( $this->main_css_element ) ) {
$this->main_css_element = '%%order_class%%';
}
$this->_render_count = 0;
$this->type = isset( $this->type ) ? $this->type : '';
$this->_style_priority = (int) self::DEFAULT_PRIORITY;
if ( isset( $this->type ) && 'child' === $this->type ) {
$this->_style_priority = $this->_style_priority + 1;
} else {
// add default toggles.
$default_general_toggles = array(
'admin_label' => array(
'title' => et_builder_i18n( 'Admin Label' ),
'priority' => 99,
),
);
$this->_add_settings_modal_toggles( 'general', $default_general_toggles );
}
$this->_add_settings_modal_toggles(
'custom_css',
array(
'visibility' => array(
'title' => et_builder_i18n( 'Visibility' ),
'priority' => 99,
),
)
);
$i18n =& self::$i18n;
if ( ! isset( $i18n['toggles'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['toggles'] = array(
'scroll' => esc_html__( 'Scroll Effects', 'et_builder' ),
);
// phpcs:enable
}
$this->_add_settings_modal_toggles(
'custom_css',
array(
'scroll_effects' => array(
'title' => $i18n['toggles']['scroll'],
'priority' => 200,
),
)
);
$this->main_tabs = $this->get_main_tabs();
$this->custom_css_tab = isset( $this->custom_css_tab ) ? $this->custom_css_tab : true;
self::$modules[ $this->slug ] = $this;
$post_types = ! empty( $this->post_types ) ? $this->post_types : et_builder_get_builder_post_types();
// all modules should be assigned for et_pb_layout post type to work in the library.
if ( ! in_array( 'et_pb_layout', $post_types, true ) ) {
$post_types[] = 'et_pb_layout';
}
$this->post_types = apply_filters( 'et_builder_module_post_types', $post_types, $this->slug, $this->post_types );
foreach ( $this->post_types as $post_type ) {
if ( ! in_array( $post_type, $this->post_types, true ) ) {
$this->register_post_type( $post_type );
}
if ( ! isset( self::$_module_slugs_by_post_type[ $post_type ] ) ) {
self::$_module_slugs_by_post_type[ $post_type ] = array();
}
if ( ! in_array( $this->slug, self::$_module_slugs_by_post_type[ $post_type ], true ) ) {
self::$_module_slugs_by_post_type[ $post_type ][] = $this->slug;
}
if ( isset( $this->additional_shortcode ) && ! in_array( $this->additional_shortcode, self::$_module_slugs_by_post_type[ $post_type ], true ) ) {
self::$_module_slugs_by_post_type[ $post_type ][] = $this->additional_shortcode;
}
if ( isset( $this->additional_shortcode_slugs ) ) {
foreach ( $this->additional_shortcode_slugs as $additional_shortcode_slug ) {
if ( ! in_array( $additional_shortcode_slug, self::$_module_slugs_by_post_type[ $post_type ], true ) ) {
self::$_module_slugs_by_post_type[ $post_type ][] = $additional_shortcode_slug;
}
}
}
if ( 'child' === $this->type ) {
self::$child_modules[ $post_type ][ $this->slug ] = $this;
if ( isset( $this->additional_shortcode_slugs ) ) {
foreach ( $this->additional_shortcode_slugs as $additional_slug ) {
self::$child_modules[ $post_type ][ $additional_slug ] = $this;
}
}
} else {
self::$parent_modules[ $post_type ][ $this->slug ] = $this;
}
}
// WooCommerce modules data only deterimine whether a module is WooCommerce modules or not
// it doesn't need to be aware whether it is available in certain CPT or not.
if ( $this->_is_woocommerce_module ) {
self::$woocommerce_modules[] = $this->slug;
}
if ( ! isset( $this->no_render ) ) {
$shortcode_slugs = array( $this->slug );
if ( ! empty( $this->additional_shortcode_slugs ) ) {
$shortcode_slugs = array_merge( $shortcode_slugs, $this->additional_shortcode_slugs );
}
foreach ( $shortcode_slugs as $shortcode_slug ) {
add_shortcode( $shortcode_slug, array( $this, '_render' ) );
}
if ( isset( $this->additional_shortcode ) ) {
add_shortcode( $this->additional_shortcode, array( $this, 'additional_render' ) );
}
}
if ( isset( $this->icon ) ) {
self::$_->array_set( self::$module_icons, "{$this->slug}.icon", $this->icon );
}
if ( isset( $this->icon_path ) ) {
self::$_->array_set( self::$module_icons, "{$this->slug}.icon_path", $this->icon_path );
}
// Push module's help videos to all help videos array if there's any.
if ( ! empty( $this->help_videos ) ) {
// Automatically add design tab and library tutorial. DRY.
if ( 'et_pb_column' !== $this->slug ) {
// Adding next tabs (design & tab) helps.
$next_tabs_help = array(
'id' => '1iqjhnHVA9Y',
'name' => esc_html__( 'Design Settings and Advanced Module Settings', 'et_builder' ),
);
// Adjust row name.
if ( in_array( $this->slug, array( 'et_pb_row', 'et_pb_row_inner' ), true ) ) {
$next_tabs_help['name'] = esc_html__( 'Design Settings and Advanced Row Settings', 'et_builder' );
}
// Adjust section name.
if ( 'et_pb_section' === $this->slug ) {
$next_tabs_help['name'] = esc_html__( 'Design Settings and Advanced Section Settings', 'et_builder' );
}
$this->help_videos[] = $next_tabs_help;
// Adding Divi Library helps.
$this->help_videos[] = array(
'id' => 'boNZZ0MYU0E',
'name' => esc_html__( 'Saving and loading from the library', 'et_builder' ),
);
}
self::$module_help_videos[ $this->slug ] = $this->help_videos;
}
// Push module slug if this module has content option. These modules' content option need
// to be autop-ed during saving process to avoid unstyled body content in Divi Builder Plugin due
// to content not having <p> tag because it doesn't wrapped by newline during saving process.
if ( ! $this->use_raw_content && ! $this->child_slug && 'tiny_mce' === self::$_->array_get( $this->get_fields(), 'content.type' ) ) {
self::$has_content_modules[] = $this->slug;
}
}
/**
* Make private/protected methods readable.
*
* @param string $name Method to call.
* @param array $args Arguments to pass when calling.
* @return mixed|bool Return value of the callback, false otherwise.
*/
public function __call( $name, $args ) {
$class = get_class( $this );
$message = "You're Doing It Wrong!";
$is_deprecated = array_key_exists( $name, self::$_deprecations['methods'] );
$value = null;
$old_method_exists = method_exists( $this, $name );
if ( $old_method_exists && ! $is_deprecated ) {
// Inaccessible method (protected or private) that isn't deprecated.
et_debug( "{$message} Attempted to call {$class}::{$name}() from out of scope.", 4, false );
return $value;
}
$message .= " {$class}::{$name}()";
if ( ! $is_deprecated ) {
$message .= " doesn't exist.";
} else {
$message .= ' is deprecated.';
$new_method = self::$_deprecations['methods'][ $name ];
if ( ! is_string( $new_method ) ) {
// Default value for a method that has no replacement.
$value = $new_method;
} elseif ( method_exists( $this, $new_method ) && ! $old_method_exists ) {
$message .= " Use {$class}::{$new_method}() instead.";
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found
$value = call_user_func_array( array( $this, $new_method ), $args );
} elseif ( $old_method_exists && function_exists( $new_method ) ) {
// New method is a function.
$message .= " Use {$new_method}() instead.";
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found
$value = call_user_func_array( $new_method, $args );
} elseif ( $old_method_exists ) {
// Ensure that our current caller is not the same as the method we're about to call.
// as that would cause an infinite recursion situation. It happens when a child class
// method which has been deprecated calls itself on the parent class (using parent::)
// This also happens when we use $this->__call() to call a deprecated method from its
// replacement method so that a deprecation notice will be output.
$trace = debug_backtrace();
$callers = array(
self::$_->array_get( $trace, '1.function' ),
self::$_->array_get( $trace, '2.function' ),
);
if ( ! in_array( $name, $callers, true ) ) {
$message .= " Use {$class}::{$new_method}() instead.";
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found
$value = call_user_func_array( array( $this, $name ), $args );
}
}
}
et_debug( $message, 4, false );
return $value;
}
/**
* Makes private properties readable.
*
* @param string $name Property name.
*
* @return mixed|string|null
*/
public function &__get( $name ) {
$class = get_class( $this );
$message = "You're Doing It Wrong!";
$is_deprecated = array_key_exists( $name, self::$_deprecations['properties'] );
$value = null;
if ( property_exists( $this, $name ) && ! $is_deprecated ) {
// Inaccessible property (protected or private) that isn't deprecated.
et_debug( "{$message} Attempted to access {$class}::\${$name} from out of scope.", 4, false );
return $value;
}
$message .= " {$class}::\${$name}";
if ( ! $is_deprecated ) {
$message .= " doesn't exist.";
$should_set_value = true;
} else {
$message .= ' is deprecated.';
$new_prop = self::$_deprecations['properties'][ $name ];
if ( $new_prop && is_string( $new_prop ) && property_exists( $this, $new_prop ) ) {
$message .= " Use {$class}::\${$new_prop} instead.";
$value = &$this->$new_prop;
} elseif ( ! is_string( $new_prop ) || ! $new_prop ) {
// Default value.
$value = $new_prop;
$should_set_value = true;
}
}
if ( isset( $should_set_value ) ) {
// Create the property so we can return a reference to it which allows it to be
// used like this: $this->name[] = 'something'.
$this->$name = $value;
$value = &$this->$name;
}
et_debug( $message, 4, false );
return $value;
}
/**
* Make private properties checkable.
*
* @param string $name Property to check if set.
* @return bool Whether the property is set.
*/
public function __isset( $name ) {
$prop_name = array_key_exists( $name, self::$_deprecations['properties'] ) ? self::$_deprecations['properties'][ $name ] : $name;
if ( ! $prop_name || ! is_string( $prop_name ) ) {
return false;
}
return property_exists( $this, $prop_name );
}
/**
* Set a property's value.
*
* @param string $name Property key.
* @param mixed $value Property value.
*/
public function __set( $name, $value ) {
$class = get_class( $this );
$message = "You're Doing It Wrong!";
$is_deprecated = array_key_exists( $name, self::$_deprecations['properties'] );
$property_exists = property_exists( $this, $name );
$has_replacement = $property_exists && is_string( self::$_deprecations['properties'][ $name ] ) && self::$_deprecations['properties'][ $name ];
if ( $property_exists && ! $is_deprecated ) {
// Inaccessible property (protected or private) that isn't deprecated.
et_debug( "{$message} Attempted to access {$class}::\${$name} from out of scope.", 4, false );
return;
}
if ( ( ! $property_exists && ! $is_deprecated ) || ! $has_replacement ) {
// Always allow setting values for properties that are undeclared.
$this->$name = $value;
}
if ( ! $is_deprecated ) {
return;
}
$message = " {$class}::\${$name} is deprecated.";
$replacement = self::$_deprecations['properties'][ $name ];
if ( $replacement && is_string( $replacement ) ) {
$message .= " Use {$class}::\${$replacement} instead.";
$this->$replacement = $value;
// Unset deprecated property so next time it's updated we process it again.
unset( $this->$name );
}
et_debug( $message, 4, false );
}
/**
* Determine whether class is Divi official module or not.
*
* @param string $class_name Module class name.
*
* @return bool
*/
private static function _is_official_module( $class_name ) {
try {
$reflection = new ReflectionClass( $class_name );
$is_official = self::$_->includes( $reflection->getFileName(), ET_BUILDER_DIR_RESOLVED_PATH );
} catch ( Exception $err ) {
$is_official = false;
}
return $is_official;
}
/**
* Determine whether class is WooCommerce module or not.
*
* @param string $class_name Module class name.
*
* @return bool
*/
private static function _is_woocommerce_module( $class_name ) {
try {
$reflection = new ReflectionClass( $class_name );
$is_woocommerce = self::$_->includes( $reflection->getFileName(), ET_BUILDER_DIR_RESOLVED_PATH . '/module/woocommerce' );
} catch ( Exception $err ) {
$is_woocommerce = false;
}
return $is_woocommerce;
}
/**
* Set configuration for module's advanced fields.
*/
protected function _set_advanced_fields_config() {
$this->advanced_fields = $this->get_advanced_fields_config();
// 3rd-Party Backwards Compatability
if ( isset( $this->advanced_fields['custom_margin_padding'] ) ) {
$this->advanced_fields['margin_padding'] = $this->advanced_fields['custom_margin_padding'];
unset( $this->advanced_fields['custom_margin_padding'] );
}
}
/**
* Get whether third party post interference should be respected.
* Current use case is for plugins like Toolset that render a
* loop within a layout which renders another layout for
* each post - in this case we must NOT override the
* current post so the loop works as expected.
*
* @since 4.0.6
*
* @return boolean
*/
protected static function _should_respect_post_interference() {
$post = ET_Post_Stack::get();
return null !== $post && get_the_ID() !== $post->ID;
}
/**
* Retrieve the main query post id.
* Accounts for third party interference with the current post.
*
* @since 4.0.6
*
* @return integer|boolean
*/
protected static function _get_main_post_id() {
if ( self::_should_respect_post_interference() ) {
return get_the_ID();
}
return ET_Post_Stack::get_main_post_id();
}
/**
* Retrieve Post ID from 1 of 4 sources depending on which exists:
* - $_POST['current_page']['id']
* - $_POST['et_post_id']
* - $_GET['post']
* - get_the_ID()
*
* @since 3.17.2
*
* @return int|bool
*/
public static function get_current_post_id() {
// Getting correct post id in computed_callback request.
// phpcs:disable WordPress.Security.NonceVerification -- This function does not change any state, and is therefore not susceptible to CSRF.
if ( wp_doing_ajax() && self::$_->array_get( $_POST, 'current_page.id' ) ) {
return absint( self::$_->array_get( $_POST, 'current_page.id' ) );
}
if ( wp_doing_ajax() && isset( $_POST['et_post_id'] ) ) {
return absint( $_POST['et_post_id'] );
}
if ( isset( $_POST['post'] ) ) {
return absint( $_POST['post'] );
}
return self::_get_main_post_id();
// phpcs:enable
}
/**
* Retrieve Post ID from 1 of 3 sources depending on which exists:
* - get_the_ID()
* - $_GET['post']
* - $_POST['et_post_id']
*
* @since 4.0
*
* @return int|bool
*/
public static function get_current_post_id_reverse() {
// phpcs:disable WordPress.Security.NonceVerification -- This function does not change any state, and is therefore not susceptible to CSRF.
$post_id = self::_get_main_post_id();
// try to get post id from get_post_ID().
if ( false !== $post_id ) {
return $post_id;
}
if ( wp_doing_ajax() ) {
// get the post ID if loading data for VB.
return isset( $_POST['et_post_id'] ) ? absint( $_POST['et_post_id'] ) : false;
}
// fallback to $_GET['post'] to cover the BB data loading.
return isset( $_GET['post'] ) ? absint( $_GET['post'] ) : false;
// phpcs:enable
}
/**
* Get the current ID depending on the current request.
*
* @since 4.0
*
* @return int|bool
*/
public function get_the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName -- This function name is consistent with WP core `get_the_ID()` function
return self::get_current_post_id_reverse();
}
/**
* Setup the advanced styles manager
*
* @param int $post_id Post id.
*
* @return array
* @since 4.0 Made public.
*
* {@internal
* Before the styles manager was implemented, the advanced styles were output inline in the footer.
* That resulted in them being the last styles parsed by the browser, thus giving them higher
* priority than other styles on the page. With the styles manager, the advanced styles are
* enqueued at the very end of the <head>. This is for backwards compatibility (to maintain
* the same priority for the styles as before).}}
*/
public static function setup_advanced_styles_manager( $post_id = 0 ) {
if ( 0 === $post_id && et_core_page_resource_is_singular() ) {
// It doesn't matter if post id is 0 because we're going to force inline styles.
$post_id = et_core_page_resource_get_the_ID();
}
$is_preview = is_preview() || is_et_pb_preview();
$forced_in_footer = $post_id && et_builder_setting_is_on( 'et_pb_css_in_footer', $post_id );
$forced_inline = ! $post_id || $is_preview || $forced_in_footer || et_builder_setting_is_off( 'et_pb_static_css_file', $post_id ) || et_core_is_safe_mode_active() || ET_GB_Block_Layout::is_layout_block_preview();
$unified_styles = ! $forced_inline && ! $forced_in_footer;
$resource_owner = $unified_styles ? 'core' : 'builder';
$resource_slug = $unified_styles ? 'unified' : 'module-design';
$resource_slug .= $unified_styles && et_builder_post_is_of_custom_post_type( $post_id ) ? '-cpt' : '';
$resource_slug = et_theme_builder_decorate_page_resource_slug( $post_id, $resource_slug );
// If the post is password protected and a password has not been provided yet,
// no content (including any custom style) will be printed.
// When static css file option is enabled this will result in missing styles.
if ( ! $forced_inline && post_password_required( $post_id ? $post_id : null ) ) {
$forced_inline = true;
}
if ( $is_preview ) {
// Don't let previews cause existing saved static css files to be modified.
$resource_slug .= '-preview';
}
$manager = et_core_page_resource_get( $resource_owner, $resource_slug, $post_id, 40 );
if ( ! $forced_inline && ! $forced_in_footer && $manager->has_file() ) {
// This post currently has a fully configured styles manager.
return array(
'manager' => $manager,
'add_hooks' => false,
);
}
$manager->forced_inline = $forced_inline;
$manager->write_file_location = 'footer';
if ( $forced_in_footer || $forced_inline ) {
// Restore legacy behavior--output inline styles in the footer.
$manager->set_output_location( 'footer' );
}
return array(
'manager' => $manager,
'add_hooks' => true,
);
}
/**
* Passes the module design styles for the current page to the advanced styles manager.
* {@see 'wp_footer' (19) Must run before the style manager's footer callback}
*/
public static function set_advanced_styles() {
$styles = '';
if ( et_core_is_builder_used_on_current_request() ) {
$styles .= et_pb_get_page_custom_css();
}
$styles .= self::get_style() . self::get_style( true );
if ( ! $styles ) {
return;
}
// Pass styles to page resource which will handle their output.
self::$advanced_styles_manager->set_data( $styles, 40 );
}
/**
* Set {@see ET_Builder_Element::$advanced_styles_manager} to force inline styles.
*/
public static function maybe_force_inline_styles() {
if ( et_core_is_fb_enabled() || self::$advanced_styles_manager->forced_inline || ! self::$forced_inline_styles ) {
return;
}
self::$advanced_styles_manager->forced_inline = true;
self::$advanced_styles_manager->write_file_location = 'footer';
self::$advanced_styles_manager->set_output_location( 'footer' );
}
/**
* Filters the unified page resource data. The data is an array of arrays of strings keyed by
* priority. The builder's styles are set with a priority of 40. Here we want to make sure
* only the builder's styles are output in the footer on first-page load so we aren't
* duplicating the customizer and custom css styles which are already in the <head>.
* {@see 'et_core_page_resource_get_data'}
*
* @param array[] $data {
* Arrays of strings keyed by priority.
*
* @type string[] $priority Resource data.
* ...
* }.
* @param string $context Where the data will be used. Accepts 'inline', 'file'.
* @param ET_Core_PageResource $resource The resource instance.
* @return array
*/
public static function filter_page_resource_data( $data, $context, $resource ) {
global $wp_current_filter;
if ( 'inline' !== $context || ! in_array( 'wp_footer', $wp_current_filter, true ) ) {
return $data;
}
if ( false === strpos( $resource->slug, 'unified' ) ) {
return $data;
}
if ( 'footer' !== $resource->location ) {
// This is the first load of a page that doesn't currently have a unified static css file.
// The theme customizer and custom css have already been inlined in the <head> using the
// unified resource's ID. It's invalid HTML to have duplicated IDs on the page so we'll
// fix that here since it only applies to this page load anyway.
$resource->slug = $resource->slug . '-2';
}
return isset( $data[40] ) ? array( 40 => $data[40] ) : array();
}
/**
* Get the slugs for all current builder modules.
*
* @since 3.0.85
*
* @param string $post_type Get module slugs for this post type. If falsy, all slugs are returned.
*
* @return array
*/
public static function get_module_slugs_by_post_type( $post_type = 'post' ) {
if ( $post_type ) {
if ( ! isset( self::$_module_slugs_by_post_type[ $post_type ] ) ) {
// We get all modules when post type is not enabled so that posts that have
// had their post type support disabled still load all necessary modules.
return array_keys( self::get_modules() );
}
return self::$_module_slugs_by_post_type[ $post_type ];
}
return self::$_module_slugs_by_post_type;
}
/**
* Get whether the module has Visual Builder support or not
*
* @since 3.1
*
* @return bool
*/
public function has_vb_support() {
return 'off' !== $this->vb_support;
}
/**
* Create Factory objects
*
* @since 3.23 Add margin padding fields object.
*
* @return void
*/
public function set_factory_objects() {
// Load features fields.
$this->text_shadow = ET_Builder_Module_Fields_Factory::get( 'TextShadow' );
$this->margin_padding = ET_Builder_Module_Fields_Factory::get( 'MarginPadding' );
}
/**
* Populates {@see $fields_unprocessed}.
*
* @param array $fields Fields.
*/
protected function _set_fields_unprocessed( $fields ) {
$unprocessed = &self::$_fields_unprocessed;
foreach ( $fields as $field => $definition ) {
if ( true === $definition ) {
continue;
}
// Have to use md5 now because needed by modules cache.
$key = md5( serialize( $definition ) );
if ( ! isset( $unprocessed[ $key ] ) ) {
$unprocessed[ $key ] = $definition;
}
$this->fields_unprocessed[ $field ] = $unprocessed[ $key ];
}
}
/**
* Populates {@see self::$fields_unprocessed}.
*/
public function set_fields() {
$fields_unprocessed = $this->get_complete_fields();
// Add _builder_version field to all modules.
$fields_unprocessed['_builder_version'] = array( 'type' => 'skip' );
// Add _dynamic_attributes field to all modules.
$fields_unprocessed['_dynamic_attributes'] = array( 'type' => 'skip' );
// Add support for the style presets.
$fields_unprocessed['_module_preset'] = array( 'type' => 'skip' );
if ( function_exists( 'et_builder_definition_sort' ) ) {
et_builder_definition_sort( $fields_unprocessed );
}
if ( $this->_is_official_module ) {
$this->_set_fields_unprocessed( $fields_unprocessed );
return;
}
// 3rd-Party module backwards compatability starts here
foreach ( $fields_unprocessed as $field => $info ) {
if ( isset( $info['depends_to'] ) ) {
$fields_unprocessed[ $field ]['depends_on'] = $info['depends_to'];
}
if ( isset( $info['depends_default'] ) && $info['depends_default'] && ! isset( $info['depends_show_if'] ) ) {
$fields_unprocessed[ $field ]['depends_show_if'] = 'on';
$message = "You're Doing It Wrong! Setting definition for {$field} includes deprecated parameter: 'depends_default'. Use 'show_if' instead.";
et_debug( $message );
}
// Process renderer of string type only.
if ( isset( $info['renderer'] ) && is_string( $info['renderer'] ) ) {
$original_renderer = $info['renderer'];
$updated_field_type = $info['renderer'];
// convert renderer into type.
switch ( $info['renderer'] ) {
case 'et_builder_include_categories_option':
case 'et_builder_include_categories_shop_option':
$updated_field_type = 'categories';
break;
case 'et_builder_get_widget_areas':
$updated_field_type = 'select_sidebar';
break;
case 'et_pb_get_font_icon_list':
case 'et_pb_get_font_down_icon_list':
$updated_field_type = 'select_icon';
break;
case 'et_builder_get_gallery_settings':
$updated_field_type = 'upload_gallery';
break;
case 'et_builder_generate_center_map_setting':
$updated_field_type = 'center_map';
break;
}
$fields_unprocessed[ $field ]['type'] = $updated_field_type;
if ( 'et_pb_get_font_down_icon_list' === $info['renderer'] ) {
$fields_unprocessed[ $field ]['renderer_options'] = array( 'icons_list' => 'icon_down' );
}
// Output developer warning if renderer was converted to type.
if ( $original_renderer !== $updated_field_type ) {
$message = "You're Doing It Wrong! Module setting definition for {$field} has a deprecated value: ";
$message .= "'{$original_renderer}' for parameter 'renderer'. Use '{$updated_field_type}' instead.";
et_debug( $message );
}
}
// Normalize `affects` field names if needed.
if ( isset( $info['affects'] ) ) {
$affects_original = $fields_unprocessed[ $field ]['affects'];
$fields_unprocessed[ $field ]['affects'] = array();
// BB supports comma separated list of affected fields, convert it to array of fields if this is the case.
// Some plugins use combination of various lists, handle all of them.
foreach ( $affects_original as $affect_item ) {
if ( strpos( $affect_item, ',' ) !== false ) {
$fields_unprocessed[ $field ]['affects'] = array_merge( $fields_unprocessed[ $field ]['affects'], explode( ',', str_replace( ' ', '', $affect_item ) ) );
} else {
$fields_unprocessed[ $field ]['affects'][] = $affect_item;
}
}
array_walk( $fields_unprocessed[ $field ]['affects'], array( $this, 'normalize_affect_fields' ) );
}
if ( 'content_new' === $field ) {
$fields_unprocessed['content'] = $fields_unprocessed['content_new'];
unset( $fields_unprocessed['content_new'] );
$message = "You're Doing It Wrong! Setting definition for {$field} includes deprecated parameter: 'content_new'. Use 'content' instead.";
et_debug( $message );
}
// convert old color pickers to the new ones supporting alpha channel.
if ( 'color' === self::$_->array_get( $info, 'type' ) ) {
$info['type'] = 'color-alpha';
$fields_unprocessed[ $field ] = $info;
$message = "You're Doing It Wrong! You're using wrong type for the '" . $field . "'. It should be 'color-alpha' instead of 'color'.";
et_debug( $message, 4, false );
}
// convert input type to text.
if ( 'input' === self::$_->array_get( $info, 'type' ) ) {
$info['type'] = 'text';
$fields_unprocessed[ $field ] = $info;
$message = "You're Doing It Wrong! Setting definition for {$field} has a deprecated value: 'input' for parameter: 'type'. Use 'text' instead.";
et_debug( $message );
}
// Normalize default values.
if ( isset( $info['default'] ) ) {
$fields_unprocessed[ $field ]['default'] = $this->_normalize_field_default( $field, $info['default'], $fields_unprocessed[ $field ]['type'] );
}
}
// Set default values in field definitions based on the legacy defaults "rules".
if ( isset( $this->fields_defaults ) ) {
foreach ( $this->fields_defaults as $field => $value ) {
if ( ! isset( $fields_unprocessed[ $field ] ) ) {
continue;
}
$condition = is_array( $value ) ? self::$_->array_get( $value, '1' ) : false;
$set_default_on_front = 'only_default_setting' !== $condition;
$default = $this->_normalize_field_default( $field, $value, $fields_unprocessed[ $field ]['type'] );
// Always set default value if exists. Only default_on_front should be conditional.
$fields_unprocessed[ $field ]['default'] = $default;
if ( ! $set_default_on_front ) {
continue;
}
$has_default = isset( $fields_unprocessed[ $field ]['default'] );
if ( ! $has_default || $fields_unprocessed[ $field ]['default'] !== $default ) {
$fields_unprocessed[ $field ]['default_on_front'] = $default;
}
}
}
// Legacy Defaults Rule #4 (AKA: longest-running undetected bug in the codebase):
// Fields listed in allowlisted_fields that aren't in fields_defaults lose their definitions.
if ( isset( $this->allowlisted_fields ) ) {
$disable_allowlisted_fields = isset( $this->force_unallowlisted_fields ) && $this->force_unallowlisted_fields;
if ( ! $disable_allowlisted_fields && ! is_admin() && ! et_fb_is_enabled() ) {
foreach ( $this->allowlisted_fields as $field ) {
if ( isset( $this->fields_defaults ) && array_key_exists( $field, $this->fields_defaults ) ) {
continue;
}
$fields_unprocessed[ $field ] = array();
}
}
}
$this->_set_fields_unprocessed( $fields_unprocessed );
}
/**
* Normalize default value depends on field type.
*
* @param string $field Field.
* @param mixed $default_value Default value.
* @param string $type Field type.
*
* @return mixed|string
*/
protected function _normalize_field_default( $field, $default_value, $type = '' ) {
$normalized_value = is_array( $default_value ) ? $default_value[0] : $default_value;
// normalize default value depends on field type.
switch ( $type ) {
case 'yes_no_button':
if ( is_numeric( $normalized_value ) ) {
$normalized_value = (bool) $normalized_value ? 'on' : 'off';
$message = "You're Doing It Wrong! You're using wrong value for '{$field}' default value. It should be either 'on' or 'off'.";
et_debug( $message, 4, false );
}
break;
case 'color-alpha':
if ( is_numeric( $normalized_value ) ) {
$normalized_value = '';
$message = "You're Doing It Wrong! You're using wrong value for '{$field}' default value. It should be string value.";
et_debug( $message, 4, false );
}
// Make sure provided HEX code is a valid color code.
if ( strpos( $normalized_value, '#' ) === 0 && ! in_array( strlen( $normalized_value ), array( 4, 7 ), true ) ) {
$normalized_value = '';
$message = "You're Doing It Wrong! You're using wrong value for '{$field}' default value. It should be valid hex color code.";
et_debug( $message, 4, false );
}
break;
}
return $normalized_value;
}
/**
* Normalize `affects` fields name if needed.
* Some 3rd party modules use `#et_pb_<field_name>` format which is wrong and doesn't work in VB, but works in BB.
* Convert it to correct format and output notice for developer
*
* @param string $field_name Field name.
*
* @return void
*/
public function normalize_affect_fields( &$field_name ) {
if ( strpos( $field_name, '#et_pb_' ) !== false ) {
// Truncate field name from the string wherever it's placed.
$new_field_name = substr( $field_name, strpos( $field_name, '#et_pb_' ) + 7 );
$message = "You're Doing It Wrong! You're using wrong name for 'affects' attribute. It should be '" . $new_field_name . "' instead of '" . $field_name . "'";
$field_name = $new_field_name;
et_debug( $message, 4, false );
}
// content_new renamed to content, so rename it in affected fields list as well.
if ( 'content_new' === $field_name ) {
$field_name = 'content';
}
}
/**
* Finalizes the configuration of {@see self::$fields_unprocessed}.
* Includes filter and fields processing for Visual Builder
*
* @return void
*/
protected function _finalize_all_fields() {
$fields_unprocessed = $this->fields_unprocessed;
$fields_before_filter = $fields_unprocessed;
/**
* Filters module fields.
*
* @since 3.1
*
* @param array $fields_unprocessed See {@see self::$fields_unprocessed}.
*/
$fields_unprocessed = apply_filters( "et_pb_all_fields_unprocessed_{$this->slug}", $fields_unprocessed );
$is_saving_modules_cache = et_core_is_saving_builder_modules_cache();
$need_dynamic_assets = et_core_is_fb_enabled() && ! et_fb_dynamic_asset_exists( 'definitions' );
// Check if this is an AJAX request since this is how VB and BB loads the initial module data et_core_is_fb_enabled() always returns `false` here
// Make exception for requests that are regenerating modules cache and
// VB page which has no dynamic definitions asset so it can cache the definitions correctly.
if ( ! wp_doing_ajax() && ! $is_saving_modules_cache && ! $need_dynamic_assets ) {
$this->_set_fields_unprocessed( $fields_unprocessed );
return;
}
foreach ( array_keys( $fields_unprocessed ) as $field_name ) {
$field_info = $fields_unprocessed[ $field_name ];
$affected_fields = self::$_->array_get( $field_info, 'affects', array() );
foreach ( $affected_fields as $affected_field ) {
if ( ! isset( $fields_unprocessed[ $affected_field ] ) ) {
continue;
}
if ( ! isset( $fields_unprocessed[ $affected_field ]['depends_on'] ) ) {
$fields_unprocessed[ $affected_field ]['depends_on'] = array();
}
// Avoid value duplication.
if ( ! in_array( $field_name, $fields_unprocessed[ $affected_field ]['depends_on'], true ) ) {
$fields_unprocessed[ $affected_field ]['depends_on'][] = $field_name;
}
// Set `depends_show_if = on` if no condition defined for the affected field for backward compatibility with old plugins.
if ( ! isset( $fields_unprocessed[ $affected_field ]['depends_show_if'] ) && ! isset( $fields_unprocessed[ $affected_field ]['depends_show_if_not'] ) ) {
// Deprecation notice has already been logged for this.
$fields_unprocessed[ $affected_field ]['depends_show_if'] = 'on';
}
}
// Unset renderer to avoid errors in VB because of errors in 3rd party plugins
// BB compat. Still need this data, so leave it for BB.
if ( ( self::is_loading_vb_data() || et_fb_is_enabled() ) && isset( $fields_unprocessed[ $field_name ]['renderer'] ) ) {
unset( $fields_unprocessed[ $field_name ]['renderer'] );
}
if ( isset( $fields_unprocessed[ $field_name ]['use_plugin_main'] ) ) {
$fields_unprocessed[ $field_name ]['use_limited_main'] = $fields_unprocessed[ $field_name ]['use_plugin_main'];
unset( $fields_unprocessed[ $field_name ]['use_plugin_main'] );
$message = "You're Doing It Wrong! Setting definition for {$field_name} includes deprecated parameter: 'use_plugin_main'. Use 'use_limited_main' instead.";
et_debug( $message );
}
if ( isset( $fields_unprocessed[ $field_name ]['plugin_main'] ) ) {
$fields_unprocessed[ $field_name ]['limited_main'] = $fields_unprocessed[ $field_name ]['plugin_main'];
unset( $fields_unprocessed[ $field_name ]['plugin_main'] );
$message = "You're Doing It Wrong! Setting definition for {$field_name} includes deprecated parameter: 'plugin_main'. Use 'limited_main' instead.";
et_debug( $message );
}
}
// determine custom fields added via filter and add specific flag to identify them in VB.
$keys_before_filter = array_keys( $fields_before_filter );
$keys_after_filter = array_keys( $fields_unprocessed );
$added_fields = array_diff( $keys_after_filter, $keys_before_filter );
if ( ! empty( $added_fields ) ) {
foreach ( $added_fields as $key ) {
$fields_unprocessed[ $key ]['vb_support'] = false;
}
}
$this->_set_fields_unprocessed( $fields_unprocessed );
}
/**
* Register builder enabled post types.
*
* @param string $post_type Post type.
*/
private function register_post_type( $post_type ) {
$this->post_types[] = $post_type;
self::$parent_modules[ $post_type ] = array();
self::$child_modules[ $post_type ] = array();
}
/**
* Double quote are saved as "%22" in shortcode attributes.
* Decode them back into "
*
* @param string[] $enabled_dynamic_attributes Attributes which have dynamic content enabled.
* @param bool $et_fb_processing_shortcode_object FB processing shortcode flag.
*
* @return void
*/
private function _decode_double_quotes( $enabled_dynamic_attributes, $et_fb_processing_shortcode_object ) {
if ( ! isset( $this->props ) ) {
return;
}
// need to encode HTML entities in Admin Area( for BB ) if Visual Editor disabled for the user.
$need_html_entities_decode = is_admin() && ! user_can_richedit();
$shortcode_attributes = array();
$font_icon_options = array( 'font_icon', 'button_icon', 'button_one_icon', 'button_two_icon', 'hover_icon' );
foreach ( $this->props as $attribute_key => $attribute_value ) {
if ( $et_fb_processing_shortcode_object && in_array( $attribute_key, $enabled_dynamic_attributes, true ) ) {
// Do not decode dynamic content values when preparing them for VB.
$shortcode_attributes[ $attribute_key ] = $attribute_value;
continue;
}
// decode HTML entities and remove trailing and leading quote if needed.
$processed_attr_value = $need_html_entities_decode ? trim( htmlspecialchars_decode( $attribute_value, ENT_QUOTES ), '"' ) : $attribute_value;
// the icon shortcodes are fine.
if ( in_array( $attribute_key, $font_icon_options, true ) ) {
$shortcode_attributes[ $attribute_key ] = $processed_attr_value;
// icon attributes must not be str_replaced.
continue;
}
// Set empty TinyMCE content '<br /><br />' as empty string.
$field_type = empty( $this->fields_unprocessed[ $attribute_key ]['type'] ) ? '' : $this->fields_unprocessed[ $attribute_key ]['type'];
if ( 'tiny_mce' === $field_type && 'ltbrgtbr' === preg_replace( '/[^a-z]/', '', $processed_attr_value ) ) {
$processed_attr_value = '';
}
// URLs are weird since they can allow non-ascii characters so we escape those separately.
if ( in_array( $attribute_key, array( 'url', 'button_link', 'button_url' ), true ) ) {
$url = $processed_attr_value;
$url_parsed = wp_parse_url( $url );
if ( isset( $url_parsed['query'] ) ) {
$replace = str_replace(
array( '%91', '%93' ),
array( '[', ']' ),
$url_parsed['query']
);
$url = str_replace( $url_parsed['query'], $replace, $url );
}
$shortcode_attributes[ $attribute_key ] = esc_url_raw( $url );
} else {
// Manipulate string for font icon attribute with value "%%xx%%" to "##xx##".
$processed_attr_value = preg_replace( '/%%([0-9]+)%%/', '##$1##', $processed_attr_value );
$processed_attr_value = str_replace( array( '%22', '%92', '%91', '%93', '%5c' ), array( '"', '\\', '[', ']', '\\' ), $processed_attr_value );
// Restore string for font icon attribute from "##xx##" to "%%xx%%".
$processed_attr_value = preg_replace( '/##([0-9]+)##/', '%%$1%%', $processed_attr_value );
$shortcode_attributes[ $attribute_key ] = $processed_attr_value;
}
}
$this->props = $shortcode_attributes;
}
/**
* Provide a way for sub-class to access $this->_render_count without a chance to alter its value
*
* @return int
*/
protected function render_count() {
return $this->_render_count;
}
/**
* Bumps the render count for this module instance and the module instance whose slug is
* set as {@see self::$_bumps_render_count} (if any).
*
* @since 3.10
*/
protected function _bump_render_count() {
$this->_render_count++;
if ( $this->_bumps_render_count ) {
$module = self::get_module( $this->_bumps_render_count, $this->get_post_type() );
$module->_render_count++;
}
}
/**
* Check whether ab testing enabled for current module and calculate whether it should be displayed currently or not
*
* @param array $shortcode_atts Shortcode attributes.
*
* @return bool
*/
private function _is_display_module( $shortcode_atts ) {
$ab_subject_id = isset( $shortcode_atts['ab_subject_id'] ) && '' !== $shortcode_atts['ab_subject_id'] ? $shortcode_atts['ab_subject_id'] : false;
// return true if testing is disabled or current module has no subject id.
if ( ! $ab_subject_id ) {
return true;
}
return $this->_check_ab_test_subject( $ab_subject_id );
}
/**
* Check whether the current module should be displayed or not.
*
* @param bool|integer $ab_subject_id subject id.
*
* @return bool
*/
private function _check_ab_test_subject( $ab_subject_id = false ) {
global $et_pb_ab_subject;
if ( ! $ab_subject_id ) {
return true;
}
return et_()->array_get( $et_pb_ab_subject, self::get_layout_id(), '' ) === $ab_subject_id;
}
/**
* Get an index.
*
* @since 4.0
*
* @param string $key The path in the array.
*
* @return mixed
*/
protected static function _get_index( $key ) {
$theme_builder_group = self::get_theme_builder_layout_type();
$key = array_merge( array( $theme_builder_group ), (array) $key );
return et_()->array_get( self::$_indices, $key, -1 );
}
/**
* Set an index.
*
* @since 4.0
*
* @param string $key The path in the array.
* @param mixed $index The value to set.
*
* @return void
*/
protected static function _set_index( $key, $index ) {
$theme_builder_group = self::get_theme_builder_layout_type();
$key = array_merge( array( $theme_builder_group ), (array) $key );
et_()->array_set( self::$_indices, $key, $index );
}
/**
* Resets indexes used when generating element addresses.
*
* @param string $content Element content.
* @param bool $force Whether forcefully reset indexes even when not the main query or
* {@see self::$can_reset_element_indexes} is false.
*
* @return string
*/
public static function reset_element_indexes( $content = '', $force = false ) {
if ( ! $force && ( ! self::$can_reset_element_indexes || ! is_main_query() ) ) {
return $content;
}
$slugs = self::get_parent_slugs_regex();
if ( $content && ! preg_match( "/{$slugs}/", $content ) ) {
// At least one builder element should be present.
return $content;
}
global $wp_current_filter;
if ( in_array( 'the_content', $wp_current_filter, true ) ) {
$call_counts = array_count_values( $wp_current_filter );
if ( $call_counts['the_content'] > 1 ) {
// This is a nested call. We only want to reset indexes after the top-most call.
return $content;
}
}
self::_set_index( self::INDEX_SECTION, -1 );
self::_set_index( self::INDEX_ROW, -1 );
self::_set_index( self::INDEX_ROW_INNER, -1 );
self::_set_index( self::INDEX_COLUMN, -1 );
self::_set_index( self::INDEX_COLUMN_INNER, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
if ( $force ) {
// Reset module order classes.
self::_set_index( self::INDEX_MODULE_ORDER, array() );
self::_set_index( self::INDEX_INNER_MODULE_ORDER, array() );
}
return $content;
}
/**
* Generates the element's address. Every builder element on the page is assigned an address
* based on it's index and those of it's parents using the following format:
*
* `$section.$row.$column.$module[.$module_item]`
*
* For example, if a module is the forth module in the first column in the third row in the
* second section on the page, it's address would be: `1.2.0.3` (indexes are zero-based).
*
* @since 3.1 Renamed from `_get_current_shortcode_address()` to `generate_element_address()`
* @since 3.0.60
*
* @param string $render_slug render slug.
*
* @return string
*/
public function generate_element_address( $render_slug = '' ) {
// Flag child module. $this->type isn't accurate in this context since some modules reuse other
// modules' render() method for rendering their output (ie. accordion item).
// Even though Column and Column Inner are child elements of Row they shouldn't be processed as child items.
$is_child_module = in_array( $render_slug, self::get_child_slugs( $this->get_post_type() ), true ) && false === strpos( $render_slug, '_column_inner' ) && false === strpos( $render_slug, '_column' );
if ( false !== strpos( $render_slug, '_section' ) ) {
self::_set_index( self::INDEX_SECTION, self::_get_index( self::INDEX_SECTION ) + 1 );
// Reset every module index inside section.
self::_set_index( self::INDEX_ROW, -1 );
self::_set_index( self::INDEX_ROW_INNER, -1 );
self::_set_index( self::INDEX_COLUMN, -1 );
self::_set_index( self::INDEX_COLUMN_INNER, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( false !== strpos( $render_slug, '_row_inner' ) ) {
self::_set_index( self::INDEX_ROW_INNER, self::_get_index( self::INDEX_ROW_INNER ) + 1 );
// Reset every module index inside row inner.
self::_set_index( self::INDEX_COLUMN_INNER, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( false !== strpos( $render_slug, '_row' ) ) {
self::_set_index( self::INDEX_ROW, self::_get_index( self::INDEX_ROW ) + 1 );
// Reset every module index inside row.
self::_set_index( self::INDEX_COLUMN, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( false !== strpos( $render_slug, '_column_inner' ) ) {
self::_set_index( self::INDEX_COLUMN_INNER, self::_get_index( self::INDEX_COLUMN_INNER ) + 1 );
// Reset every module index inside column inner.
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( false !== strpos( $render_slug, '_column' ) && -1 === self::_get_index( self::INDEX_ROW ) ) {
self::_set_index( self::INDEX_COLUMN, self::_get_index( self::INDEX_COLUMN ) + 1 );
// Reset every module index inside column of specialty section.
self::_set_index( self::INDEX_ROW_INNER, -1 );
self::_set_index( self::INDEX_COLUMN_INNER, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( false !== strpos( $render_slug, '_column' ) ) {
self::_set_index( self::INDEX_COLUMN, self::_get_index( self::INDEX_COLUMN ) + 1 );
// Reset every module index inside column of regular section.
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( $is_child_module ) {
self::_set_index( self::INDEX_MODULE_ITEM, self::_get_index( self::INDEX_MODULE_ITEM ) + 1 );
} else {
self::_set_index( self::INDEX_MODULE, self::_get_index( self::INDEX_MODULE ) + 1 );
// Reset module item index inside module.
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
}
$address = self::_get_index( self::INDEX_SECTION );
if ( -1 === self::_get_index( self::INDEX_ROW ) && -1 === self::_get_index( self::INDEX_ROW_INNER ) ) {
// Fullwidth & Specialty (without column inner) Section's module.
$parts = array( self::_get_index( self::INDEX_COLUMN ), self::_get_index( self::INDEX_MODULE ) );
} elseif ( 0 <= self::_get_index( self::INDEX_ROW_INNER ) ) {
// Specialty (inside column inner) Section's module.
$parts = array( self::_get_index( self::INDEX_COLUMN ), self::_get_index( self::INDEX_ROW_INNER ), self::_get_index( self::INDEX_COLUMN_INNER ), self::_get_index( self::INDEX_MODULE ) );
} else {
// Regular section's module.
$parts = array( self::_get_index( self::INDEX_ROW ), self::_get_index( self::INDEX_COLUMN ), self::_get_index( self::INDEX_MODULE ) );
}
foreach ( $parts as $part ) {
if ( $part > -1 ) {
$address .= ".{$part}";
}
}
if ( $is_child_module ) {
$address .= '.' . self::_get_index( self::INDEX_MODULE_ITEM );
}
return $address;
}
/**
* Resolves conditional defaults
*
* @param array $values Fields.
* @param string $render_slug Module slug.
*
* @return array
*/
public function resolve_conditional_defaults( $values, $render_slug = '' ) {
// Resolve conditional defaults for the FE.
$resolved = $this->get_default_props();
if ( $render_slug && $render_slug !== $this->slug ) {
$module = self::get_module( $render_slug, $this->get_post_type() );
if ( $module ) {
$resolved = array_merge( $resolved, $module->get_default_props() );
}
}
foreach ( $resolved as $field_name => $field_default ) {
if ( is_array( $field_default ) && 2 === count( $field_default ) && ! empty( $field_default[0] ) ) {
if ( is_array( $field_default[1] ) ) {
// Looks like we have a conditional default
// Get $depend_field value or use the first default if undefined.
list ( $depend_field, $conditional_defaults ) = $field_default;
reset( $conditional_defaults );
$default_key = isset( $values[ $depend_field ] ) ? $values[ $depend_field ] : key( $conditional_defaults );
// Set the resolved default.
$resolved[ $field_name ] = isset( $conditional_defaults[ $default_key ] ) ? $conditional_defaults[ $default_key ] : null;
} elseif ( 'filter' === $field_default[0] ) {
$resolved[ $field_name ] = apply_filters( $field_default[1], $field_name );
}
}
}
// Add hover attributes.
if ( ! is_array( $values ) ) {
return $resolved;
}
foreach ( $values as $attr => $value ) {
// Inject module props with suffixes __hover|__hover_enabled|__sticky|__sticky_enabled|_last_edited|_tablet|_phone.
if ( ! preg_match( ET_Builder_Module_Helper_MultiViewOptions::get_regex_suffix(), $attr ) ) {
continue;
}
$resolved[ $attr ] = $value;
}
$skip_base_names = array(
'fb_built',
'_builder_version',
'hover_enabled',
'sticky_enabled',
);
$base_names = array();
foreach ( array_keys( $values ) as $attr ) {
$base_name = 0 === strpos( $attr, 'content' ) ? 'content' : ET_Builder_Module_Helper_MultiViewOptions::get_name_base( $attr );
if ( in_array( $base_name, $skip_base_names, true ) ) {
continue;
}
$base_names[ $base_name ] = $base_name;
}
// Set the props list that the value need to be inherited.
// to get the responsive content able to display content for tablet/phone/hover only mode.
foreach ( $base_names as $base_name ) {
foreach ( array( 'hover', 'tablet', 'phone' ) as $mode ) {
$name_by_mode = ET_Builder_Module_Helper_MultiViewOptions::get_name_by_mode( $base_name, $mode );
if ( ! isset( $values[ $name_by_mode ] ) && ! isset( $resolved[ $name_by_mode ] ) ) {
// Set value inheritance flag for hover mode.
$this->mv_inherited_props[ $name_by_mode ] = $name_by_mode;
} elseif ( ! isset( $values[ $name_by_mode ] ) && isset( $resolved[ $name_by_mode ] ) && '' === $resolved[ $name_by_mode ] ) {
// Set value inheritance flag for tablet & phone mode.
$this->mv_inherited_props[ $name_by_mode ] = $name_by_mode;
}
}
}
return $resolved;
}
/**
* Get wrapper settings. Combining module-defined wrapper settings with default wrapper settings
*
* @since 3.1
*
* @param string $render_slug module slug.
*
* @return array
*/
protected function get_wrapper_settings( $render_slug = '' ) {
global $et_fb_processing_shortcode_object;
// The following defaults are used on both frontend & builder.
$defaults = array(
'parallax_background' => '',
'video_background' => '',
'attrs' => array(),
'inner_attrs' => array(
'class' => 'et_pb_module_inner',
),
);
// The following defaults are only used on frontend. VB handles these on ETBuilderInjectedComponent based on live props
// Note: get_parallax_image_background() and video_background() have to be called before module_classname().
if ( ! $et_fb_processing_shortcode_object ) {
$use_background_image = self::$_->array_get( $this->advanced_fields, 'background.use_background_image', false );
$use_background_video = self::$_->array_get( $this->advanced_fields, 'background.use_background_video', false );
$use_module_id = self::$_->array_get( $this->props, 'module_id', '' );
// Module might disable image background.
if ( $use_background_image ) {
$defaults['parallax_background'] = $this->get_parallax_image_background();
}
// Module might disable video background.
if ( $use_background_video ) {
$defaults['video_background'] = $this->video_background();
}
// Module might intentionally has custom id fields (ie. Module items).
if ( $use_module_id ) {
$defaults['attrs']['id'] = $this->module_id( false );
}
$defaults['attrs']['class'] = $this->module_classname( $render_slug );
}
if ( ! $defaults['attrs'] ) {
// Make sure we get an empty object when this is output as JSON later.
$defaults['attrs'] = new stdClass();
}
// Fill empty argument attributes by default values.
return wp_parse_args( $this->wrapper_settings, $defaults );
}
/**
* Wrap module's rendered output with proper module wrapper. Ensuring module has consistent
* wrapper output which compatible with module attribute and background insertion.
*
* @since 3.1
*
* @param string $output Module's rendered output.
* @param string $render_slug Slug of module that is used for rendering output.
*
* @return string
*/
protected function _render_module_wrapper( $output = '', $render_slug = '' ) {
$wrapper_settings = $this->get_wrapper_settings( $render_slug );
$slug = $render_slug;
$outer_wrapper_attrs = $wrapper_settings['attrs'];
$inner_wrapper_attrs = $wrapper_settings['inner_attrs'];
/**
* Filters the HTML attributes for the module's outer wrapper. The dynamic portion of the
* filter name, '$slug', corresponds to the module's slug.
*
* @since 3.23 Add support for responsive video background.
* @since 3.1
*
* @param string[] $outer_wrapper_attrs
* @param ET_Builder_Element $module_instance
*/
$outer_wrapper_attrs = apply_filters( "et_builder_module_{$slug}_outer_wrapper_attrs", $outer_wrapper_attrs, $this );
/**
* Filters the HTML attributes for the module's inner wrapper. The dynamic portion of the
* filter name, '$slug', corresponds to the module's slug.
*
* @since 3.1
*
* @param string[] $inner_wrapper_attrs
* @param ET_Builder_Element $module_instance
*/
$inner_wrapper_attrs = apply_filters( "et_builder_module_{$slug}_inner_wrapper_attrs", $inner_wrapper_attrs, $this );
return sprintf(
'<div%1$s>
%2$s
%3$s
%6$s
%7$s
<div%4$s>
%5$s
</div>
</div>',
et_html_attrs( $outer_wrapper_attrs ),
$wrapper_settings['parallax_background'],
$wrapper_settings['video_background'],
et_html_attrs( $inner_wrapper_attrs ),
$output,
et_()->array_get( $wrapper_settings, 'video_background_tablet', '' ),
et_()->array_get( $wrapper_settings, 'video_background_phone', '' )
);
}
/**
* Resolves the values for dynamic attributes.
*
* @since 3.17.2
*
* @param array $original_attrs List of attributes.
*
* @return array Processed attributes with resolved dynamic values.
*/
public function process_dynamic_attrs( $original_attrs ) {
global $et_fb_processing_shortcode_object;
$attrs = $original_attrs;
$enabled_dynamic_attributes = $this->_get_enabled_dynamic_attributes( $attrs );
if ( is_array( $attrs ) ) {
foreach ( $attrs as $key => $value ) {
$attrs[ $key ] = $this->_resolve_value(
$this->get_the_ID(),
$key,
$value,
$enabled_dynamic_attributes,
$et_fb_processing_shortcode_object
);
}
}
return $attrs;
}
/**
* Prepares for and then calls the module's {@see self::render()} method.
*
* @param array $attrs List of attributes.
* @param string $content Content being processed.
* @param string $render_slug Slug of module that is used for rendering output.
* @param string $parent_address Parent address.
* @param string $global_parent Global parent.
* @param string $global_parent_type Global parent type.
* @param string $parent_type Parent type.
*
* @since 3.23 Add support for generating responsive animation.
* @since 3.1 Renamed from `_shortcode_callback()` to `_render()`.
* @since 1.0
*
* @return string The module's HTML output.
*/
public function _render( $attrs, $content, $render_slug, $parent_address = '', $global_parent = '', $global_parent_type = '', $parent_type = '' ) {
global $et_fb_processing_shortcode_object, $et_pb_current_parent_type, $et_pb_parent_section_type, $is_parent_sticky_module, $is_inside_sticky_module;
if ( $this->is_rendering ) {
// Every module instance is a singleton so the TB Post Content module
// can cause a section, row and/or column to call _render() multiple
// times - once for each respective shortcode found in the content
// rendered by the Post Content module.
// Since this _render() method changes object state this leads to
// props being messed up between renders so we have to clone the
// base instance every time we try to render while the base
// instance is still rendering.
$clone = clone $this;
$clone->is_rendering = false;
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found
return call_user_func_array( array( $clone, '_render' ), func_get_args() );
}
$this->_maybe_rebuild_option_template();
$attrs = $this->_maybe_add_global_presets_settings( $attrs, $render_slug );
// Use the current layout or post ID for AB testing. This is not guaranteed to be the real
// current post ID if we are rendering a TB layout.
$post_interference = self::_should_respect_post_interference();
$post_id = apply_filters( 'et_is_ab_testing_active_post_id', self::get_layout_id() );
$is_main_post = $this->get_the_ID() === $post_id;
if ( ! $post_interference ) {
ET_Post_Stack::replace( ET_Post_Stack::get_main_post() );
}
$enabled_dynamic_attributes = $this->_get_enabled_dynamic_attributes( $attrs );
$attrs = $this->_encode_legacy_dynamic_content( $attrs, $enabled_dynamic_attributes );
$this->attrs_unprocessed = $attrs;
$attrs = $this->process_dynamic_attrs( $attrs );
$this->props = shortcode_atts( $this->resolve_conditional_defaults( $attrs, $render_slug ), $attrs );
// Only process if it's not a "global module's parent",
// the render method in the global module's parent will just call the `do_shortcode()` for the global module content.
// So processing the sticky should be done in the global module content render instead.
$should_process_sticky = ! in_array( $render_slug, array( 'et_pb_section', 'et_pb_row', 'et_pb_row_inner' ), true ) || empty( $this->props['global_module'] );
if ( $should_process_sticky ) {
// Check if current module is inside sticky module based on previous $is_parent_sticky_module.
$is_inside_sticky_module = $is_parent_sticky_module;
// Flag if current module rendering is sticky module or not.
// This is frequently used on sticky style rendering for modifying selectors.
$this->is_sticky_module = et_pb_sticky_options()->is_sticky_module( $this->props );
// If current module is sticky module, update $is_parent_sticky_module global; Module inside
// current module will check $is_parent_sticky_module global before $this->is_sticky_module
// property check to see if current module is inside another sticky module or not.
if ( $this->is_sticky_module ) {
// IMPORTANT: DO NOT use $is_parent_sticky_module global to check whether current module
// is inside another sticky or not. Use is_inside_sticky_module() util instead.
$is_parent_sticky_module = $this->is_sticky_module;
}
} else {
$this->is_sticky_module = false;
}
$this->_decode_double_quotes( $enabled_dynamic_attributes, $et_fb_processing_shortcode_object );
$this->_maybe_remove_global_default_values_from_props();
// Some module items need to inherit value from its module parent
// This inheritance needs to be done before migration to make it compatible with migration process.
$this->maybe_inherit_values();
$_address = $this->generate_element_address( $render_slug );
/**
* Filters Module Props.
*
* @param array $props Array of processed props.
* @param array $attrs Array of original shortcode attrs
* @param string $slug Module slug
* @param string $_address Module Address
* @param string $content Module content
*/
$this->props = apply_filters( 'et_pb_module_shortcode_attributes', $this->props, $attrs, $render_slug, $_address, $content );
$global_content = false;
$ab_testing_enabled = et_is_ab_testing_active( $post_id );
$hide_subject_module = false;
$hide_subject_module_cached = $hide_subject_module;
$global_module_id = $this->props['global_module'];
// If the section/row/module is disabled, hide it.
if ( isset( $this->props['disabled'] ) && 'on' === $this->props['disabled'] && ! $et_fb_processing_shortcode_object ) {
if ( ! $post_interference ) {
ET_Post_Stack::restore();
}
return;
}
// need to perform additional check and some modifications in case AB testing enabled
// skip for VB since it's handled on VB side.
if ( $ab_testing_enabled && ( ! $is_main_post || ! $et_fb_processing_shortcode_object ) ) {
// check if ab testing enabled for this module and if it shouldn't be displayed currently.
$hide_subject_module = ( ! $is_main_post || ! $et_fb_processing_shortcode_object ) && ! $this->_is_display_module( $this->props ) && ! et_pb_detect_cache_plugins();
// add class to the AB testing subject if needed.
if ( isset( $this->props['ab_subject_id'] ) && '' !== $this->props['ab_subject_id'] ) {
$subject_class = sprintf(
' et_pb_ab_subject et_pb_ab_subject_id-%1$s_%2$s',
esc_attr( $post_id ),
esc_attr( $this->props['ab_subject_id'] )
);
$this->props['module_class'] = isset( $this->props['module_class'] ) && '' !== $this->props['module_class'] ? $this->props['module_class'] . $subject_class : $subject_class;
if ( et_pb_detect_cache_plugins() ) {
$hide_subject_module_cached = true;
}
}
// add class to the AB testing goal if needed.
if ( isset( $this->props['ab_goal'] ) && 'on' === $this->props['ab_goal'] ) {
$goal_class = sprintf( ' et_pb_ab_goal et_pb_ab_goal_id-%1$s', esc_attr( $post_id ) );
$this->props['module_class'] = isset( $this->props['module_class'] ) && '' !== $this->props['module_class'] ? $this->props['module_class'] . $goal_class : $goal_class;
}
}
// override module attributes for global module. Skip that step while processing Frontend Builder object.
if ( ! empty( $global_module_id ) && ! $et_fb_processing_shortcode_object ) {
// Update render_slug when rendering global rows inside Specialty sections.
$render_slug = 'et_pb_specialty_column' === $et_pb_current_parent_type && 'et_pb_row' === $render_slug ? 'et_pb_row_inner' : $render_slug;
$global_module_data = et_pb_load_global_module( $global_module_id, $render_slug );
if ( '' !== $global_module_data ) {
$unsynced_global_attributes = get_post_meta( $global_module_id, '_et_pb_excluded_global_options' );
$use_updated_global_sync_method = ! empty( $unsynced_global_attributes );
$unsynced_options = ! empty( $unsynced_global_attributes[0] ) ? json_decode( $unsynced_global_attributes[0], true ) : array();
$content_synced = $use_updated_global_sync_method && ! in_array( 'et_pb_content_field', $unsynced_options, true );
// support legacy selective sync system.
if ( ! $use_updated_global_sync_method ) {
$content_synced = ! isset( $this->props['saved_tabs'] ) || false !== strpos( $this->props['saved_tabs'], 'general' ) || 'all' === $this->props['saved_tabs'];
}
if ( $content_synced ) {
// Set the flag showing if we load inner row.
$load_inner_row = 'et_pb_row_inner' === $render_slug;
$global_content = et_pb_get_global_module_content( $global_module_data, $render_slug, $load_inner_row );
}
// cleanup the shortcode string to avoid the attributes messing with content.
$global_content_processed = false !== $global_content ? str_replace( $global_content, '', $global_module_data ) : $global_module_data;
$global_atts = shortcode_parse_atts( et_pb_remove_shortcode_content( $global_content_processed, $this->slug ) );
$global_atts = $this->_encode_legacy_dynamic_content( $global_atts, $enabled_dynamic_attributes );
// Additional content processing required for Code Modules.
if ( in_array( $render_slug, array( 'et_pb_code', 'et_pb_fullwidth_code' ), true ) ) {
$global_content_processed = _et_pb_code_module_prep_content( $global_content_processed );
}
// reset module addresses because global items will be processed once again and address will be incremented wrongly.
if ( false !== strpos( $render_slug, '_section' ) ) {
self::_set_index( self::INDEX_SECTION, self::_get_index( self::INDEX_SECTION ) - 1 );
self::_set_index( self::INDEX_ROW, -1 );
self::_set_index( self::INDEX_ROW_INNER, -1 );
self::_set_index( self::INDEX_COLUMN, -1 );
self::_set_index( self::INDEX_COLUMN_INNER, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( false !== strpos( $render_slug, '_row_inner' ) ) {
self::_set_index( self::INDEX_ROW, self::_get_index( self::INDEX_ROW ) - 1 );
self::_set_index( self::INDEX_COLUMN_INNER, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} elseif ( false !== strpos( $render_slug, '_row' ) ) {
self::_set_index( self::INDEX_ROW, self::_get_index( self::INDEX_ROW ) - 1 );
self::_set_index( self::INDEX_COLUMN, -1 );
self::_set_index( self::INDEX_MODULE, -1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
} else {
self::_set_index( self::INDEX_MODULE, self::_get_index( self::INDEX_MODULE ) - 1 );
self::_set_index( self::INDEX_MODULE_ITEM, -1 );
}
// Always unsync 'next_background_color' and 'prev_background_color' options for global sections
// They should be dynamic and reflect color of top and bottom sections.
if ( 'et_pb_section' === $render_slug ) {
$unsynced_options = array_merge( $unsynced_options, array( 'next_background_color', 'prev_background_color' ) );
}
foreach ( $this->props as $single_attr => $value ) {
if ( isset( $global_atts[ $single_attr ] ) && ! in_array( $single_attr, $unsynced_options, true ) ) {
// replace %22 with double quotes in options to make sure it's rendered correctly.
$this->props[ $single_attr ] = is_string( $global_atts[ $single_attr ] ) && ! array_intersect( array( "et_pb_{$single_attr}", $single_attr ), $this->dbl_quote_exception_options ) ? str_replace( '%22', '"', $global_atts[ $single_attr ] ) : $global_atts[ $single_attr ];
}
}
$this->props = $this->process_dynamic_attrs( $this->props );
$this->_decode_double_quotes( array(), $et_fb_processing_shortcode_object );
}
}
self::set_order_class( $render_slug );
$this->before_render();
$this->content_unprocessed = $this->_encode_legacy_dynamic_content_value(
'content',
false !== $global_content ? $global_content : $content,
$enabled_dynamic_attributes
);
$content = $this->_resolve_value(
$this->get_the_ID(),
'content',
$this->content_unprocessed,
$enabled_dynamic_attributes,
$et_fb_processing_shortcode_object
);
// Process sticky elements earlier to preserve the modules hierarchy during processing.
if ( $should_process_sticky ) {
$this->process_sticky( $render_slug );
}
// Process scroll effects earlier to preserve the modules hierarchy during processing.
$this->process_scroll_effects( $render_slug );
$content = apply_filters( 'et_pb_module_content', $content, $this->props, $attrs, $render_slug, $_address, $global_content );
// Set empty TinyMCE content '<br /><br />' as empty string.
if ( 'ltbrgtbr' === preg_replace( '/[^a-z]/', '', $content ) ) {
$content = '';
}
if ( $et_fb_processing_shortcode_object ) {
$this->content = et_pb_fix_shortcodes( $content, $this->use_raw_content );
} else {
// Line breaks should be converted before do_shortcode to avoid legit rendered shortcode
// line breaks being trimmed into one line and causing issue like broken javascript code.
if ( $this->use_raw_content ) {
$content = et_builder_convert_line_breaks( et_builder_replace_code_content_entities( $content ) );
}
if ( ! ( isset( $this->is_structure_element ) && $this->is_structure_element ) ) {
$content = et_pb_fix_shortcodes( $content, $this->use_raw_content );
$content = et_maybe_enable_embed_shortcode( $content, true );
$this->content = do_shortcode( $content );
} else {
$this->content = '';
}
$this->props['content'] = $this->content;
}
// Restart classname on shortcode callback. Module class is only called once, not on every
// shortcode module appearance. Thus classname construction need to be restarted on each
// module callback.
$this->classname = array();
if ( method_exists( $this, 'shortcode_atts' ) ) {
// Deprecated. Do not use this!
$this->shortcode_atts();
}
$this->process_global_colors();
$this->process_additional_options( $render_slug );
$this->process_custom_css_fields( $render_slug );
// load inline fonts if needed.
if ( isset( $this->props['inline_fonts'] ) ) {
$this->process_inline_fonts_option( $this->props['inline_fonts'] );
}
// Automatically add slug as classname for module that uses other module's shortcode callback
// This has to be added first because some classname is position-sensitive and used for
// JS-based calculation (i.e. .et_pb_column in column inner).
if ( $this->slug !== $render_slug ) {
$this->add_classname( $this->slug );
// Apply classnames added to the module that uses other module's shortcode callback
// (i.e. `process_additional_options` for the column inner).
$module = self::get_module( $render_slug, $this->get_post_type() );
$this->add_classname( $module->classname );
}
// Automatically add default classnames.
$this->add_classname(
array(
'et_pb_module',
$render_slug,
self::get_module_order_class( $render_slug ),
)
);
// Automatically added user-defined classname if there's any.
if ( isset( $this->props['module_class'] ) && '' !== $this->props['module_class'] ) {
$this->add_classname( explode( ' ', $this->props['module_class'] ) );
}
// Animation Styles.
$animation_style = isset( $this->props['animation_style'] ) && '' !== $this->props['animation_style'] ? $this->props['animation_style'] : false;
$animation_repeat = isset( $this->props['animation_repeat'] ) && '' !== $this->props['animation_repeat'] ? $this->props['animation_repeat'] : 'once';
$animation_direction = isset( $this->props['animation_direction'] ) && '' !== $this->props['animation_direction'] ? $this->props['animation_direction'] : 'center';
$animation_duration = isset( $this->props['animation_duration'] ) && '' !== $this->props['animation_duration'] ? $this->props['animation_duration'] : '500ms';
$animation_delay = isset( $this->props['animation_delay'] ) && '' !== $this->props['animation_delay'] ? $this->props['animation_delay'] : '0ms';
$animation_intensity = isset( $this->props[ "animation_intensity_{$animation_style }" ] ) && '' !== $this->props[ "animation_intensity_{$animation_style }" ] ? $this->props[ "animation_intensity_{$animation_style }" ] : '50%';
$animation_starting_opacity = isset( $this->props['animation_starting_opacity'] ) && '' !== $this->props['animation_starting_opacity'] ? $this->props['animation_starting_opacity'] : '0%';
$animation_speed_curve = isset( $this->props['animation_speed_curve'] ) && '' !== $this->props['animation_speed_curve'] ? $this->props['animation_speed_curve'] : 'ease-in-out';
// Animation style and direction values for Tablet & Phone. Basically, style for tablet and
// phone are same with the desktop because we only edit responsive settings for the affected
// fields under animation style. Variable $animation_style_responsive need to be kept as
// unmodified variable because it will be used by animation intensity.
$animation_style_responsive = $animation_style;
$animation_style_tablet = $animation_style;
$animation_style_phone = $animation_style;
$animation_direction_tablet = et_pb_responsive_options()->get_any_value( $this->props, 'animation_direction_tablet' );
$animation_direction_phone = et_pb_responsive_options()->get_any_value( $this->props, 'animation_direction_phone' );
// Check if this is an AJAX request since this is how VB loads the initial module data
// et_core_is_fb_enabled() always returns `false` here.
if ( $animation_style && 'none' !== $animation_style && ! wp_doing_ajax() ) {
$transformed_animations = array(
'desktop' => false,
'tablet' => false,
'phone' => false,
);
// Fade doesn't have direction.
if ( 'fade' === $animation_style ) {
$animation_direction_tablet = '';
$animation_direction_phone = '';
} else {
$directions_list = array( 'top', 'right', 'bottom', 'left' );
if ( in_array( $animation_direction, $directions_list, true ) ) {
$animation_style .= ucfirst( $animation_direction );
}
// avoid custom animation on button because animation is applied to the wrapper so transforms do not need to combine.
if ( 'et_pb_button' !== $render_slug ) {
foreach ( preg_grep( '/(transform_)/', array_keys( $this->props ) ) as $index => $key ) {
if ( strpos( $key, 'link' ) !== false || strpos( $key, 'hover' ) !== false || strpos( $key, 'last_edited' ) !== false ) {
continue;
}
if ( ! empty( $this->props[ $key ] ) ) {
if ( ! $transformed_animations['desktop'] && strpos( $key, 'tablet' ) === false && strpos( $key, 'phone' ) === false ) {
$transformed_animations['desktop'] = true;
$transformed_animations['tablet'] = true;
$transformed_animations['phone'] = true;
} elseif ( ! $transformed_animations['tablet'] && strpos( $key, 'tablet' ) !== false ) {
$transformed_animations['tablet'] = true;
$transformed_animations['phone'] = true;
} elseif ( ! $transformed_animations['phone'] && strpos( $key, 'phone' ) !== false ) {
$transformed_animations['phone'] = true;
}
if ( $transformed_animations['desktop'] && $transformed_animations['tablet'] && $transformed_animations['phone'] ) {
break;
}
}
}
}
}
$module_class = self::get_module_order_class( $render_slug );
if ( $module_class ) {
// Desktop animation data.
$animation_data = array(
'class' => esc_attr( trim( $module_class ) ),
'style' => esc_html( $animation_style ),
'repeat' => esc_html( $animation_repeat ),
'duration' => esc_html( $animation_duration ),
'delay' => esc_html( $animation_delay ),
'intensity' => esc_html( $animation_intensity ),
'starting_opacity' => esc_html( $animation_starting_opacity ),
'speed_curve' => esc_html( $animation_speed_curve ),
);
// Being save to generate Tablet & Phone data attributes. As default, tablet
// default value will inherit desktop value and phone default value will inherit
// tablet value. Ensure to pass the value only if it's different compared to
// desktop value to avoid duplicate values.
$animation_attributes = array(
'repeat' => 'animation_repeat',
'duration' => 'animation_duration',
'delay' => 'animation_delay',
'intensity' => "animation_intensity_{$animation_style_responsive}",
'starting_opacity' => 'animation_starting_opacity',
'speed_curve' => 'animation_speed_curve',
);
foreach ( $animation_attributes as $animation_key => $animation_attribute ) {
$animation_attribute_tablet = '';
$animation_attribute_phone = '';
// Ensure responsive status for current attribute is activated.
if ( ! et_pb_responsive_options()->is_responsive_enabled( $this->props, $animation_attribute ) ) {
continue;
}
// Tablet animation value.
$animation_attribute_tablet = et_pb_responsive_options()->get_any_value( $this->props, "{$animation_attribute}_tablet", $animation_data[ $animation_key ] );
if ( ! empty( $animation_attribute_tablet ) ) {
$animation_data[ "{$animation_key}_tablet" ] = $animation_attribute_tablet;
}
// Phone animation value.
$animation_attribute_phone = et_pb_responsive_options()->get_any_value( $this->props, "{$animation_attribute}_phone", $animation_data[ $animation_key ] );
if ( ! empty( $animation_attribute_phone ) ) {
$animation_data[ "{$animation_key}_phone" ] = $animation_attribute_phone;
}
}
// Animation style is little bit different. We need to check the direction to get
// the correct style. We need to ensure the direction is valid, then add it as
// suffix for the animation style.
if ( et_pb_responsive_options()->is_responsive_enabled( $this->props, 'animation_direction' ) ) {
// Tablet animation style.
if ( ! empty( $animation_direction_tablet ) ) {
$animation_style_tablet_suffix = in_array( $animation_direction_tablet, $directions_list, true ) ? ucfirst( $animation_direction_tablet ) : '';
$animation_data['style_tablet'] = $animation_style_tablet . $animation_style_tablet_suffix;
}
// Phone animation style.
if ( ! empty( $animation_direction_phone ) ) {
$animation_style_phone_suffix = in_array( $animation_direction_phone, $directions_list, true ) ? ucfirst( $animation_direction_phone ) : '';
$animation_data['style_phone'] = $animation_style_phone . $animation_style_phone_suffix;
} elseif ( ! empty( $animation_data['style_tablet'] ) ) {
$animation_data['style_phone'] = $animation_data['style_tablet'];
}
}
// overwrite animation name to match the custom animation generated on transforms options processing.
if ( $transformed_animations['desktop'] ) {
$animation_data['style'] = 'transformAnim';
}
if ( $transformed_animations['tablet'] ) {
$animation_data['style_tablet'] = 'transformAnim';
}
if ( $transformed_animations['phone'] ) {
$animation_data['style_phone'] = 'transformAnim';
}
et_builder_handle_animation_data( $animation_data );
}
// Try to apply old method for plugins without vb support.
if ( ! $et_fb_processing_shortcode_object && 'on' !== $this->vb_support ) {
add_filter( "{$render_slug}_shortcode_output", array( $this, 'add_et_animated_class' ), 10, 2 );
}
// Only print et_animated on front-end. Avoid adding it on computed callback of post slider(s)
// and modules because it'll cause the module to be visually hidden.
if ( ! et_core_is_fb_enabled() ) {
$this->add_classname( 'et_animated' );
}
}
// Add "et_hover_enabled" class to elements that have at least one hover prop enabled.
if ( et_has_hover_enabled( $this->props ) ) {
$this->add_classname( 'et_hover_enabled' );
}
// Add sticky element module classname to determine nested sticky module.
if ( ! $et_fb_processing_shortcode_object && et_()->array_get( self::$sticky_elements, self::get_module_order_class( $render_slug ), false ) ) {
$this->add_classname( 'et_pb_sticky_module' );
}
// Setup link options.
$link_option_url = isset( $this->props['link_option_url'] ) ? $this->props['link_option_url'] : '';
$link_option_url_new_window = isset( $this->props['link_option_url_new_window'] ) ? $this->props['link_option_url_new_window'] : false;
if ( '' !== $link_option_url ) {
$module_class = self::get_module_order_class( $render_slug );
if ( $module_class ) {
et_builder_handle_link_options_data(
array(
'class' => trim( $module_class ),
'url' => esc_url_raw( $link_option_url ),
'target' => 'on' === $link_option_url_new_window ? '_blank' : '_self',
)
);
}
$this->add_classname( 'et_clickable' );
}
// Hide module on specific screens if needed.
if ( isset( $this->props['disabled_on'] ) && '' !== $this->props['disabled_on'] ) {
$disabled_on_array = explode( '|', $this->props['disabled_on'] );
$i = 0;
$current_media_query = 'max_width_767';
foreach ( $disabled_on_array as $value ) {
if ( 'on' === $value ) {
// Added specific declaration to fix the problem when
// Video module is hidden for desktop the fullscreen
// won't work on mobile screen size.
$declaration = 'et_pb_video' === $render_slug ? 'height: 0; padding: 0; overflow: hidden;' : 'display: none !important;';
$el_style = array(
'selector' => '%%order_class%%',
'declaration' => $declaration,
'media_query' => self::get_media_query( $current_media_query ),
);
ET_Builder_Module::set_style( $render_slug, $el_style );
}
$i++;
$current_media_query = 1 === $i ? '768_980' : 'min_width_981';
}
}
if ( ! $et_fb_processing_shortcode_object ) {
if ( 'et_pb_section' === $render_slug ) {
$et_pb_current_parent_type = isset( $this->props['specialty'] ) && 'on' === $this->props['specialty'] ? 'et_pb_specialty_section' : 'et_pb_section';
$et_pb_parent_section_type = $et_pb_current_parent_type;
} elseif ( 'et_pb_specialty_section' === $et_pb_current_parent_type && 'et_pb_column' === $render_slug ) {
$et_pb_current_parent_type = 'et_pb_specialty_column';
}
// Make sure content of Specialty Section is valid and has correct structure. Fix inner shortcode tags if needed.
if ( 'et_pb_specialty_section' === $et_pb_current_parent_type ) {
$content = $this->et_pb_maybe_fix_specialty_columns( $content );
}
}
$this->is_rendering = true;
$render_method = $et_fb_processing_shortcode_object ? 'render_as_builder_data' : 'render';
$output = $this->{$render_method}( $attrs, $content, $render_slug, $parent_address, $global_parent, $global_parent_type, $parent_type );
$this->is_rendering = false;
// Wrap 3rd party module rendered output with proper module wrapper
// @TODO implement module wrapper on official module.
if ( 'on' === $this->vb_support && 'render' === $render_method && ! $this->_is_official_module ) {
$output = $this->_render_module_wrapper( $output, $render_slug );
}
/**
* Filters every builder modules shortcode output.
*
* @since 3.1
*
* @param string $output
* @param string $module_slug
* @param object $this
*/
$output = apply_filters( 'et_module_shortcode_output', $output, $render_slug, $this );
/**
* Filters builder module shortcode output. The dynamic portion of the filter name, `$render_slug`,
* refers to the slug of the module for which the shortcode output was generated.
*
* @since 3.0.87
*
* @param string $output
* @param string $module_slug
*/
$output = apply_filters( "{$render_slug}_shortcode_output", $output, $render_slug );
$this->_bump_render_count();
// Reset is_parent_sticky_module global once content of current module is done rendered.
if ( $this->is_sticky_module ) {
$is_parent_sticky_module = false;
}
if ( ! $post_interference ) {
ET_Post_Stack::restore();
}
if ( $hide_subject_module ) {
return '';
}
if ( $hide_subject_module_cached ) {
$previous_subjects_cache = get_post_meta( $post_id, 'et_pb_subjects_cache', true );
if ( empty( $previous_subjects_cache ) ) {
$previous_subjects_cache = array();
}
if ( empty( $this->template_name ) ) {
$previous_subjects_cache[ $this->props['ab_subject_id'] ] = $output;
} else {
$previous_subjects_cache[ $this->props['ab_subject_id'] ] = $this->output();
}
// update the subjects cache in post meta to use it later.
update_post_meta( $post_id, 'et_pb_subjects_cache', $previous_subjects_cache );
// generate the placeholder to output on front-end instead of actual content.
$subject_placeholder = sprintf(
'<div class="et_pb_subject_placeholder et_pb_subject_placeholder_id_%1$s_%2$s" style="display: none;"></div>',
esc_attr( $post_id ),
esc_attr( $this->props['ab_subject_id'] )
);
return $subject_placeholder;
}
// Do not use `template_name` while processing object for VB.
if ( $et_fb_processing_shortcode_object || empty( $this->template_name ) ) {
return $output;
}
return $this->output();
}
/**
* Add "et_animated" class using filter. Obsolete method and only applied to old 3rd party modules without `modules_classname()` method
*
* @param string $output Shortcode output.
* @param string $module_slug Module slug.
*
* @return string
*/
public function add_et_animated_class( $output, $module_slug ) {
if ( ! is_string( $output ) || in_array( $module_slug, self::$uses_module_classname, true ) ) {
return $output;
}
remove_filter( "{$module_slug}_shortcode_output", array( $this, 'add_et_animated_class' ), 10 );
return preg_replace( "/class=\"(.*?{$module_slug}_\d+.*?)\"/", 'class="$1 et_animated"', $output, 1 );
}
/**
* Delete attribute values that are equal to the global default value (if one exists).
*
* @return void
*/
protected function _maybe_remove_global_default_values_from_props() {
$fields = $this->fields_unprocessed;
$must_print_fields = array( 'text_orientation' );
/**
* Filters Must Print attributes array.
* Must Print attributes - attributes which defaults should always be printed on Front End
*
* @deprecated
*
* @param array $must_print_fields Array of attribute names.
*/
$must_print_fields = apply_filters( $this->slug . '_must_print_attributes', $must_print_fields );
$slug = isset( $this->global_settings_slug ) ? $this->global_settings_slug : $this->slug;
$module_slug = self::$global_presets_manager->maybe_convert_module_type( $this->slug, $this->props );
$module_preset_settings = self::$global_presets_manager->get_module_presets_settings( $module_slug, $this->props );
foreach ( $fields as $field_key => $field_settings ) {
$global_setting_name = "$slug-$field_key";
$global_setting_value = ET_Global_Settings::get_value( $global_setting_name );
if ( ! $global_setting_value || in_array( $field_key, $must_print_fields, true ) ) {
continue;
}
$attr_value = self::$_->array_get( $this->props, $field_key, '' );
if ( $attr_value && $attr_value === $global_setting_value && ! array_key_exists( $field_key, $module_preset_settings ) ) {
$this->props[ $field_key ] = '';
}
}
}
/**
* Intended to be overridden as needed.
*/
public function maybe_inherit_values() {}
/**
* Like {@see self::render()}, but sources the output from a template file. The template name
* should be set in {@see self::$template_name}.
*
* Note: this functionality is not currently supported by the Visual Builder. Pages containing
* modules that use this method to render their output cannot be edited using the Visual Builder
* at this time. However, full support will be added in the coming months.
*
* @since 3.1 Renamed from `shortcode_output()` to `output()`
* @since 2.4.6
*
* @return string
*/
public function output() {
if ( empty( $this->template_name ) ) {
return '';
}
if ( method_exists( $this, 'shortcode_output' ) ) {
// Backwards compatibility.
return $this->__call( 'shortcode_output', array() );
}
$this->props['content'] = $this->content;
// phpcs:ignore WordPress.PHP.DontExtract -- `extract` can not be removed, template depend on props variables.
extract( $this->props );
ob_start();
require locate_template( $this->template_name . '.php' );
return ob_get_clean();
}
/**
* Generates HTML data attributes from an array of props.
*
* @since 3.1 Rename from `shortcode_atts_to_data_atts()` to `props_to_html_data_attrs()`
* @since 1.0
*
* @param array $props Propeties to be use in data attributes.
*
* @return string
*/
public function props_to_html_data_attrs( $props = array() ) {
if ( empty( $props ) ) {
return '';
}
$output = array();
foreach ( $props as $attr ) {
$output[] = 'data-' . esc_attr( $attr ) . '="' . esc_attr( $this->props[ $attr ] ) . '"';
}
return implode( ' ', $output );
}
/**
* This method is called before {@self::_render()} for rows, columns, and modules. It can
* be overridden by elements that need to perform any tasks before rendering begins.
*
* @since 3.1 Renamed from `pre_shortcode_content()` to `before_render()`.
* @since 1.0
*/
public function before_render() {
if ( method_exists( $this, 'pre_shortcode_content' ) ) {
// Backwards compatibility.
$this->__call( 'pre_shortcode_content', array() );
}
}
/**
* Generates the module's HTML output based on {@see self::$props}. This method should be
* overridden in module classes.
*
* @since 3.1 Renamed from `shortcode_callback()` to `render()`.
* @since 1.0
*
* @param array $attrs List of unprocessed attributes.
* @param string $content Content being processed.
* @param string $render_slug Slug of module that is used for rendering output.
*
* @return string The module's HTML output.
*/
public function render( $attrs, $content, $render_slug ) {
if ( method_exists( $this, 'shortcode_callback' ) ) {
// Backwards compatibility.
return $this->__call( 'shortcode_callback', array( $attrs, $content, $render_slug ) );
}
return '';
}
/**
* Replace the et_pb_row with et_pb_row_inner and et_pb_column with et_pb_column_inner.
* Used as a callback function in {@self::et_pb_maybe_fix_specialty_columns} when fixing content of Specialty Sections
*
* @param string $rows Row content.
*
* @return string Shortcode string.
* @since 3.19.16
*/
public function et_pb_fix_specialty_columns( $rows ) {
$sanitized_shortcode = str_replace( array( 'et_pb_row ', 'et_pb_row]' ), array( 'et_pb_row_inner ', 'et_pb_row_inner]' ), $rows[0] );
$sanitized_shortcode = str_replace( array( 'et_pb_column ', 'et_pb_column]' ), array( 'et_pb_column_inner ', 'et_pb_column_inner]' ), $rows[0] );
return $sanitized_shortcode;
}
/**
* Run regex against the Specialty Section content to find and fix invalid inner shortcodes
*
* @param string $section_content Section content.
*
* @return string Shortcode string.
* @since 3.19.16
*/
public function et_pb_maybe_fix_specialty_columns( $section_content ) {
return preg_replace_callback( '/(\[et_pb_(row |row_inner) .*?\].*\[\/et_pb_(row |row_inner)\])/mis', array( $this, 'et_pb_fix_specialty_columns' ), $section_content );
}
/**
* Generates data used to render the module in the builder.
* See {@see self::render()} for parameter info.
*
* @param array $atts Module attributes.
* @param string|null $content Module content.
* @param string $render_slug Module slug.
* @param string $parent_address [description].
* @param string $global_parent [description].
* @param string $global_parent_type [description].
* @param string $parent_type [description].
*
* @return array|string An array when called during AJAX request, an empty string otherwise.
* @since 3.1 Renamed from `_shortcode_passthru_callback()` to `render_as_builder_data()`
* @since 3.0.0
*/
public function render_as_builder_data( $atts, $content, $render_slug, $parent_address = '', $global_parent = '', $global_parent_type = '', $parent_type = '' ) {
global $post;
// this is called during pageload, but we want to ignore that round, as this data will be built and returned on separate ajax request instead.
et_core_nonce_verified_previously();
if ( ! ( isset( $_POST['action'] ) || apply_filters( 'et_builder_module_force_render', false ) ) ) {
return '';
}
$attrs = array();
$fields = $this->process_fields( $this->fields_unprocessed );
$global_content = false;
$function_name_processed = et_fb_prepare_tag( $render_slug );
$unsynced_global_attributes = array();
$use_updated_global_sync_method = false;
$global_module_id = isset( $atts['global_module'] ) ? $atts['global_module'] : false;
$is_specialty_placeholder = isset( $atts['template_type'] ) && 'section' === $atts['template_type'] && isset( $atts['specialty'] ) && 'on' === $atts['specialty'] && ( ! $content || '' === trim( $content ) );
$is_global_template = false;
$real_parent_type = $parent_type;
if ( $render_slug && $render_slug !== $this->slug ) {
$rendering_module = self::get_module( $render_slug, $this->get_post_type() );
if ( $rendering_module ) {
$fields = array_merge( $fields, $this->process_fields( $rendering_module->fields_unprocessed ) );
}
}
$output_render_slug = $render_slug;
// When rendering specialty columns we should make sure correct tags are used for inner content
// Global Rows inside may break it in some cases, so handle it.
if ( 'et_pb_specialty_column' === $parent_type && 'et_pb_row' === $render_slug ) {
$output_render_slug = 'et_pb_row_inner';
$function_name_processed = 'et_pb_row_inner';
}
if ( 'et_pb_row_inner' === $parent_type && 'et_pb_column' === $render_slug ) {
$output_render_slug = 'et_pb_column_inner';
$function_name_processed = 'et_pb_column_inner';
}
$post_id = isset( $post->ID ) ? $post->ID : intval( self::$_->array_get( $_POST, 'et_post_id' ) );
$post_type = isset( $post->post_type ) ? $post->post_type : sanitize_text_field( self::$_->array_get( $_POST, 'et_post_type' ) );
$layout_type = isset( $post_type, $post_id ) && 'et_pb_layout' === $post_type ? et_fb_get_layout_type( $post_id ) : '';
if ( 'module' === $layout_type ) {
// Add support of new selective sync feature for library modules in VB.
$template_scope = wp_get_object_terms( $post_id, 'scope' );
$is_global_template = ! empty( $template_scope[0] ) && 'global' === $template_scope[0]->slug;
if ( $is_global_template ) {
$global_module_id = $post_id;
}
}
// override module attributes for global module.
if ( ! empty( $global_module_id ) ) {
if ( ! in_array( $render_slug, array( 'et_pb_section', 'et_pb_row', 'et_pb_row_inner', 'et_pb_column', 'et_pb_column_inner' ), true ) ) {
$processing_global_module = $global_module_id;
$unsynced_global_attributes = get_post_meta( $processing_global_module, '_et_pb_excluded_global_options' );
$use_updated_global_sync_method = ! empty( $unsynced_global_attributes );
}
$global_module_data = et_pb_load_global_module( $global_module_id, $function_name_processed );
if ( '' !== $global_module_data ) {
$unsynced_options = ! empty( $unsynced_global_attributes[0] ) ? json_decode( $unsynced_global_attributes[0], true ) : array();
$content_synced = $use_updated_global_sync_method && ! in_array( 'et_pb_content_field', $unsynced_options, true );
$is_module_fully_global = $use_updated_global_sync_method && empty( $unsynced_options );
$unsynced_legacy_options = array();
// support legacy selective sync system.
if ( ! $use_updated_global_sync_method ) {
$content_synced = ! isset( $atts['saved_tabs'] ) || false !== strpos( $atts['saved_tabs'], 'general' ) || 'all' === $atts['saved_tabs'];
$is_module_fully_global = ! isset( $atts['saved_tabs'] ) || 'all' === $atts['saved_tabs'];
}
if ( $content_synced && ! $is_global_template ) {
$global_content = et_pb_get_global_module_content( $global_module_data, $function_name_processed );
// When saving global rows from specialty sections, they get saved as et_pb_row instead of et_pb_row_inner.
// Handle this special case when parsing to avoid empty global row content.
if ( empty( $global_content ) && 'et_pb_row_inner' === $function_name_processed ) {
$global_content = et_pb_get_global_module_content( $global_module_data, 'et_pb_row', true );
}
}
// remove the shortcode content to avoid conflicts of parent attributes with similar attrs from child modules.
if ( false !== $global_content ) {
$global_content_processed = str_replace( $global_content, '', $global_module_data );
} else {
$global_content_processed = $global_module_data;
}
// Ensuring that all possible attributes exist to avoid remaining child attributes being used by global parents' attributes
// Do that only in case the module is fully global.
if ( $is_module_fully_global ) {
$global_atts = shortcode_parse_atts( et_pb_remove_shortcode_content( $global_content_processed, $this->slug ) );
} else {
$global_atts = shortcode_parse_atts( $global_content_processed );
}
// Run et_pb_module_shortcode_attributes filter to apply migration system on attributes of global module.
$global_atts = apply_filters( 'et_pb_module_shortcode_attributes', $global_atts, $atts, $this->slug, $this->generate_element_address( $render_slug ), $content );
// Parse dynamic content in global attributes.
$enabled_dynamic_attributes = $this->_get_enabled_dynamic_attributes( $global_atts );
$global_atts = $this->_encode_legacy_dynamic_content( $global_atts, $enabled_dynamic_attributes );
$global_atts = $this->process_dynamic_attrs( $global_atts );
// Parse dynamic content in global content.
if ( false !== $global_content ) {
$global_content = $this->_encode_legacy_dynamic_content_value(
'content',
$global_content,
$enabled_dynamic_attributes
);
$global_content = $this->_resolve_value(
$this->get_the_ID(),
'content',
$global_content,
$this->_get_enabled_dynamic_attributes( $global_atts ),
true
);
}
foreach ( $this->props as $single_attr => $value ) {
if ( isset( $global_atts[ $single_attr ] ) && ! in_array( $single_attr, $unsynced_options, true ) ) {
// replace %22 with double quotes in options to make sure it's rendered correctly.
if ( ! $is_global_template ) {
$this->props[ $single_attr ] = is_string( $global_atts[ $single_attr ] ) && ! array_intersect( array( "et_pb_{$single_attr}", $single_attr ), $this->dbl_quote_exception_options ) ? str_replace( '%22', '"', $global_atts[ $single_attr ] ) : $global_atts[ $single_attr ];
}
if ( 'global_colors_info' === $single_attr ) {
$this->props[ $single_attr ] = str_replace( array( '%91', '%93' ), array( '[', ']' ), $this->props[ $single_attr ] );
}
} elseif ( ! $use_updated_global_sync_method ) {
// prepare array of unsynced options to migrate the legacy modules to new system.
$unsynced_legacy_options[] = $single_attr;
} else {
$unsynced_global_attributes[0] = $unsynced_options;
}
}
// migrate unsynced options to the new selective sync method.
if ( ! $use_updated_global_sync_method ) {
$unsynced_global_attributes[0] = $unsynced_legacy_options;
// check the content and add it into list if needed.
if ( ! $content_synced ) {
$unsynced_global_attributes[0][] = 'et_pb_content_field';
}
} else {
$unsynced_global_attributes[0] = $unsynced_options;
}
} else {
// remove global_module attr if it doesn't exist in DB.
$this->props['global_module'] = '';
$global_parent = '';
}
}
$module_slug = self::$global_presets_manager->maybe_convert_module_type( $this->slug, $this->props );
$module_preset_settings = self::$global_presets_manager->get_module_presets_settings( $module_slug, $this->props );
foreach ( $this->props as $shortcode_attr_key => $shortcode_attr_value ) {
$value = $shortcode_attr_value;
// don't set the default, unless, lol, the value is literally 'default'.
if ( 'default' !== $value ) {
$has_preset_value = isset( $module_preset_settings[ $shortcode_attr_key ] );
if ( $has_preset_value && isset( $atts[ $shortcode_attr_key ] ) ) {
$is_equal_to_preset_value = $atts[ $shortcode_attr_key ] === $module_preset_settings[ $shortcode_attr_key ];
$value = $is_equal_to_preset_value ? '' : $atts[ $shortcode_attr_key ];
} else {
// handle 'preset' type of attributes.
if ( isset( $fields[ $shortcode_attr_key ]['default'] ) && is_array( $fields[ $shortcode_attr_key ]['default'] ) ) {
$field = $fields[ $shortcode_attr_key ];
$preset_attribute_name = $field['default'][0];
if ( 'filter' === $preset_attribute_name ) {
// Functional default.
if ( apply_filters( $field['default'][1], $shortcode_attr_key ) === $value ) {
$value = '';
}
} else {
$preset_default_value = et_()->array_get( $fields[ $preset_attribute_name ], 'default', 'none' );
$preset_attribute_value = et_()->array_get( $this->props, $preset_attribute_name, $preset_default_value );
if ( ! empty( $preset_attribute_value ) ) {
$value_from_preset = et_()->array_get( $fields[ $shortcode_attr_key ]['default'][1], $preset_attribute_value, '' );
if ( $value === $value_from_preset ) {
$value = '';
}
}
}
} else {
$is_equal_to_default = isset( $fields[ $shortcode_attr_key ]['default'] ) && $value === $fields[ $shortcode_attr_key ]['default'];
$is_equal_to_default_on_front = isset( $fields[ $shortcode_attr_key ]['default_on_front'] ) && $value === $fields[ $shortcode_attr_key ]['default_on_front'];
if ( $is_equal_to_default || $is_equal_to_default_on_front ) {
$value = '';
}
}
}
} else {
if ( '_module_preset' !== $shortcode_attr_key ) {
$value = '';
}
}
// generic override, disabled=off is an unspoken default.
if ( 'disabled' === $shortcode_attr_key && 'off' === $shortcode_attr_value ) {
$value = '';
}
// this override is necessary becuase et_pb_column and et_pb_column_inner type default is 4_4 and will get stomped
// above since its default, but we need it explicitly set anyways, so we force set it.
if ( in_array( $render_slug, array( 'et_pb_column', 'et_pb_column_inner' ), true ) && 'type' === $shortcode_attr_key ) {
$value = $shortcode_attr_value;
}
$is_include_attr = false;
if ( '' === $value
&& et_pb_hover_options()->get_field_base_name( $shortcode_attr_key ) !== $shortcode_attr_key
&& et_pb_hover_options()->is_enabled( et_pb_hover_options()->get_field_base_name( $shortcode_attr_key ), $atts ) ) {
$is_include_attr = true;
}
if ( '' === $value
&& et_pb_responsive_options()->get_field_base_name( $shortcode_attr_key ) !== $shortcode_attr_key
&& et_pb_responsive_options()->is_enabled( et_pb_responsive_options()->get_field_base_name( $shortcode_attr_key ), $atts ) ) {
$is_include_attr = true;
}
if ( '' !== $value ) {
$is_include_attr = true;
}
if ( $is_include_attr ) {
$attrs[ $shortcode_attr_key ] = is_string( $value ) ? html_entity_decode( $value ) : $value;
}
}
// Enable `Global Colors` inside preset attrs.
if ( ! empty( $module_preset_settings['global_colors_info'] ) ) {
$attrs['global_colors_info'] = $module_preset_settings['global_colors_info'];
}
// Format FB component path
// TODO, move this to class method and property, and allow both to be overridden.
$component_path = str_replace( 'et_pb_', '', $function_name_processed );
$component_path = str_replace( '_', '-', $component_path );
$_i = isset( $atts['_i'] ) ? $atts['_i'] : 0;
$address = isset( $atts['_address'] ) ? $atts['_address'] : '0';
// set the global parent if exists.
if ( ( ! isset( $attrs['global_module'] ) || '' === $attrs['global_module'] ) && '' !== $global_parent ) {
$attrs['global_parent'] = $global_parent;
}
if ( isset( $this->is_structure_element ) && $this->is_structure_element ) {
$this->vb_support = 'on';
}
$processed_content = false !== $global_content ? $global_content : $this->content;
// Determine the parent type to send it down the tree while processing shortcode
// Main purpose is to know when we rendering Specialty Section content.
if ( 'et_pb_section' === $render_slug ) {
$parent_type = isset( $attrs['specialty'] ) && 'on' === $attrs['specialty'] ? 'et_pb_specialty_section' : 'et_pb_section';
} elseif ( 'et_pb_specialty_section' === $parent_type && 'et_pb_column' === $render_slug ) {
$parent_type = 'et_pb_specialty_column';
} else {
$parent_type = $render_slug;
}
// Make sure content of Specialty Section is valid and has correct structure. Fix inner shortcode tags if needed.
if ( 'et_pb_specialty_section' === $parent_type ) {
$processed_content = $this->et_pb_maybe_fix_specialty_columns( $processed_content );
}
$content = array_key_exists( 'content', $this->fields_unprocessed ) || 'et_pb_code' === $function_name_processed || 'et_pb_fullwidth_code' === $function_name_processed ? $processed_content : et_fb_process_shortcode( $processed_content, $address, $global_parent, $global_parent_type, $parent_type );
// Global Code module content should be decoded before passing to VB.
$is_global_code = in_array( $function_name_processed, array( 'et_pb_code', 'et_pb_fullwidth_code' ), true );
$prepared_content = $content;
if ( ( ! is_array( $content ) && 'on' !== $this->vb_support && ! $this->has_line_breaks( $content ) ) || $is_global_code ) {
$prepared_content = html_entity_decode( $content, ENT_COMPAT, 'UTF-8' );
}
if ( empty( $attrs ) ) {
// Visual Builder expects $attrs to be an object.
// Associative array converted to an object by wp_json_encode correctly, but empty array is not and it causes issues.
$attrs = new stdClass();
}
$is_child_module = in_array( $render_slug, self::get_child_slugs( $this->get_post_type() ), true ) && false === strpos( $render_slug, '_column_inner' ) && false === strpos( $render_slug, '_column' );
$module_type = $this->type;
$render_count = $is_child_module ? self::_get_index( self::INDEX_MODULE_ITEM ) : self::_get_index( array( self::INDEX_MODULE_ORDER, $function_name_processed ) );
$child_title_var = isset( $this->child_title_var ) ? $this->child_title_var : '';
$child_title_fallback_var = isset( $this->child_title_fallback_var ) ? $this->child_title_fallback_var : '';
$advanced_setting_title_text = isset( $this->advanced_setting_title_text ) ? $this->advanced_setting_title_text : '';
// If this is a shop module use the Shop module render count
// Shop module creates a new class instance which resets the $_render_count value
// ( see get_shop_html() method of ET_Builder_Module_Shop class in main-modules.php )
// so we use a static property to track its proper render count.
if ( 'et_pb_shop' === $render_slug ) {
$render_count = self::$_shop_render_count;
self::$_shop_render_count++;
}
// Ensuring that module which uses another module's template (i.e. accordion item uses toggle's
// component) has correct values for class properties where it makes a difference. This is covered on front-end, but it causes inheriting
// module uses its template's value on render_as_builder_data().
if ( isset( $rendering_module, $rendering_module->type ) ) {
$module_type = $rendering_module->type;
$child_title_var = isset( $rendering_module->child_title_var ) ? $rendering_module->child_title_var : $child_title_var;
$child_title_fallback_var = isset( $rendering_module->child_title_fallback_var ) ? $rendering_module->child_title_fallback_var : $child_title_fallback_var;
$advanced_setting_title_text = isset( $rendering_module->advanced_setting_title_text ) ? $rendering_module->advanced_setting_title_text : $advanced_setting_title_text;
}
// Build object.
$object = array(
'_i' => $_i,
'_order' => $_i,
// TODO make address be _address, its conflicting with 'address' prop in map module... (not sure how though, they are in diffent places...).
'address' => $address,
'child_slug' => $this->child_slug,
'parent_slug' => $real_parent_type,
'vb_support' => $this->vb_support,
'parent_address' => $parent_address,
'shortcode_index' => $render_count,
'type' => $output_render_slug,
'theme_builder_suffix' => self::_get_theme_builder_order_class_suffix(),
'component_path' => $component_path,
'main_css_element' => $this->main_css_element,
'attrs' => $attrs,
'content' => $prepared_content,
'is_module_child' => 'child' === $module_type,
'is_structure_element' => ! empty( $this->is_structure_element ),
'is_specialty_placeholder' => $is_specialty_placeholder,
'is_official_module' => $this->_is_official_module,
'child_title_var' => $child_title_var,
'child_title_fallback_var' => $child_title_fallback_var,
'advanced_setting_title_text' => $advanced_setting_title_text,
'wrapper_settings' => $this->get_wrapper_settings( $render_slug ),
);
if ( ! empty( $unsynced_global_attributes ) ) {
$object['unsyncedGlobalSettings'] = $unsynced_global_attributes[0];
}
if ( $is_global_template ) {
$object['libraryModuleScope'] = 'global';
}
if ( isset( $this->module_items_config ) ) {
$object['module_items_config'] = $this->module_items_config;
}
return $object;
}
/**
* Determine if provided string contain line-breaks (`\r\n`)
*
* @param string $content String to check.
*
* @return bool
*/
public function has_line_breaks( $content ) {
return count( preg_split( '/\r\n*\n/', trim( $content ), -1, PREG_SPLIT_NO_EMPTY ) ) > 1;
}
/**
* Additional shortcode render callback.
*
* Intended to be overridden as needed.
*
* @param array $attrs Attributes.
* @param null $content Shortcode content.
* @param string $render_slug Shortcode tag.
*/
public function additional_render( $attrs, $content, $render_slug ) {
if ( method_exists( $this, 'additional_shortcode_callback' ) ) {
// Backwards compatibility.
$this->__call( 'additional_shortcode_callback', array( $attrs, $content, $render_slug ) );
}
}
/**
* Intended to be overridden as needed.
*/
public function predefined_child_modules(){}
/**
* Generate global setting name
*
* @param string $option_slug Option slug.
*
* @return string Global setting name in the following format: "module_slug-option_slug"
*/
public function get_global_setting_name( $option_slug ) {
$global_setting_name = sprintf(
'%1$s-%2$s',
isset( $this->global_settings_slug ) ? $this->global_settings_slug : $this->slug,
$option_slug
);
return $global_setting_name;
}
/**
* Add global default values to all fields, if they don't have defaults set
*
* @return void
*/
protected function _maybe_add_global_defaults() {
// Don't add default settings to "child" modules.
if ( 'child' === $this->type ) {
return;
}
$fields = $this->fields_unprocessed;
$ignored_keys = array(
'custom_margin',
'custom_padding',
);
// Font color settings have custom_color set to true, so add them to ignored keys array.
if ( isset( $this->advanced_fields['fonts'] ) && is_array( $this->advanced_fields['fonts'] ) ) {
foreach ( $this->advanced_fields['fonts'] as $font_key => $font_settings ) {
$ignored_keys[] = sprintf( '%1$s_text_color', $font_key );
}
}
$ignored_keys = apply_filters( 'et_builder_add_defaults_ignored_keys', $ignored_keys );
foreach ( $fields as $field_key => $field_settings ) {
if ( in_array( $field_key, $ignored_keys, true ) ) {
continue;
}
$global_setting_name = $this->get_global_setting_name( $field_key );
$global_setting_value = ET_Global_Settings::get_value( $global_setting_name );
if ( ! isset( $field_settings['default'] ) && $global_setting_value ) {
$fields[ $field_key ]['default'] = $global_setting_value;
// Mark this default as global so VB won't print it to replicate FE behaviour.
$fields[ $field_key ]['is_global_default'] = true;
}
}
$this->fields_unprocessed = $fields;
}
/**
* Rebuild option template in $this->fields_unprocessed property into actual field if needed.
*
* @since 3.28
*/
protected function _maybe_rebuild_option_template() {
// Once module's option template inside $this->fields_unprocessed is rebuilt, the next
// module's `_render()` won't need it. Thus, skip this to speed up performance.
if ( in_array( $this->slug, self::$_has_rebuilt_option_template, true ) ) {
return;
}
foreach ( $this->fields_unprocessed as $field_name => $field ) {
// If first two field name matches template prefix, it is safely assume that current
// unprocessed fields is reference to option template.
if ( self::$option_template->is_enabled() && self::$option_template->is_option_template_field( $field_name ) ) {
// Rebuild fields.
$rebuilt_fields = self::$option_template->rebuild_field_template( $field_name );
// Assign rebuilt fields to module's unprocessed fields.
foreach ( $rebuilt_fields as $rebuilt_field_name => $rebuilt_field ) {
$this->fields_unprocessed[ $rebuilt_field_name ] = $rebuilt_field;
}
// Remove option template field.
unset( $this->fields_unprocessed[ $field_name ] );
}
}
self::$_has_rebuilt_option_template[] = $this->slug;
}
/**
* Adds Global Presets settings.
*
* @since 3.26
*
* @param array $attrs The list of a module attributes.
* @param string $render_slug The real slug from the shortcode.
*
* @return array
*/
protected function _maybe_add_global_presets_settings( $attrs, $render_slug ) {
if ( ( et_fb_is_enabled() || et_builder_bfb_enabled() ) && ! self::is_theme_builder_layout() ) {
return $attrs;
}
$render_slug = self::$global_presets_manager->maybe_convert_module_type( $render_slug, $attrs );
$module_preset_settings = self::$global_presets_manager->get_module_presets_settings( $render_slug, $attrs );
if ( is_array( $attrs ) ) {
// We need a special handler for social media child items module background color setting
// as it has different default background color for each network.
if ( 'et_pb_social_media_follow_network' === $render_slug
&& ! empty( $attrs['social_network'] )
&& ! empty( $attrs['background_color'] )
&& ! empty( $module_preset_settings['background_color'] )
&& $attrs['background_color'] !== $module_preset_settings['background_color']
) {
$background_color_definition = self::$_->array_get( $this->get_fields(), "social_network.options.{$attrs['social_network']}.data.color" );
if ( $background_color_definition === $attrs['background_color'] ) {
// Unset the background color attrs if it was default based on selected network.
unset( $attrs['background_color'] );
}
}
return array_merge( $module_preset_settings, $attrs );
}
return $module_preset_settings;
}
/**
* Add additional option fields.
*
* @since 3.23 Introduce form field options set. Also, add codes to generate responsive options
* set with suffix automatically. It also supports mobile_options on composite, bg
* field, and computed fields as well.
*/
protected function _add_additional_fields() {
// Setup has_advanced_fields property to adjust advanced options visibility on
// module that has no VB support to avoid sudden advanced options appearances.
$this->has_advanced_fields = isset( $this->advanced_fields );
// Advanced options are added by default unless module explicitly disabled it.
$this->advanced_fields = $this->has_advanced_fields ? $this->advanced_fields : array();
// Advanced options have to be array.
if ( ! is_array( $this->advanced_fields ) ) {
return;
}
// Add form field options set to modules that use form as main part.
$this->_add_form_field_fields();
$this->_add_font_fields();
$this->_add_background_fields();
$this->_add_borders_fields();
$this->_add_button_fields();
$this->_add_box_shadow_fields();
$this->_add_transforms_fields();
$this->_add_position_fields();
$this->_add_text_fields();
$this->_add_sizing_fields();
$this->_add_overflow_fields();
$this->_add_margin_padding_fields();
// Add filter fields to modules.
$this->_add_filter_fields();
// Add divider fields to section modules.
$this->_add_divider_fields();
// Add animation fields to all modules.
$this->_add_animation_fields();
$this->_add_additional_transition_fields();
// Add text shadow fields to all modules.
$this->_add_text_shadow_fields();
// Add link options to all modules.
$this->_add_link_options_fields();
$this->_add_sticky_fields();
$this->_add_scroll_effects_fields();
if ( ! isset( $this->_additional_fields_options ) ) {
return false;
}
$additional_options = $this->_additional_fields_options;
$this->_additional_fields_options = array();
$is_column_module = in_array( $this->slug, array( 'et_pb_column', 'et_pb_column_inner' ), true );
// delete second level advanced options default values.
if ( isset( $this->type ) && 'child' === $this->type && ! $is_column_module && apply_filters( 'et_pb_remove_child_module_defaults', true ) ) {
foreach ( $additional_options as $name => $settings ) {
if ( isset( $additional_options[ $name ]['default'] ) && ! isset( $additional_options[ $name ]['default_on_child'] ) ) {
$additional_options[ $name ]['default'] = '';
}
}
}
if ( function_exists( 'et_builder_definition_sort' ) ) {
et_builder_definition_sort( $additional_options );
}
$additional_options = et_pb_responsive_options()->create( $additional_options );
$this->_set_fields_unprocessed( $additional_options );
}
/**
* Set i18n used by font fields.
*
* @since 4.4.9
*
* @return void
*/
protected function set_i18n_font() {
// Cache results so that translation/escaping only happens once.
$i18n =& self::$i18n;
if ( ! isset( $i18n['font'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['font'] = array(
'letter_spacing' => array(
'label' => esc_html__( '%1$s Letter Spacing', 'et_builder' ),
'description' => esc_html__( 'Letter spacing adjusts the distance between each letter in the %1$s.', 'et_builder' ),
),
'size' => array(
'label' => esc_html__( '%1$s Text Size', 'et_builder' ),
'description' => esc_html__( 'Increase or decrease the size of the %1$s text.', 'et_builder' ),
),
'font' => array(
'label' => esc_html__( '%1$s Font', 'et_builder' ),
'description' => esc_html__( 'Choose a custom font to use for the %1$s. All Google web fonts are available, or you can upload your own custom font files.', 'et_builder' ),
),
'color' => array(
'label' => esc_html__( '%1$s Text Color', 'et_builder' ),
'description' => esc_html__( 'Pick a color to be used for the %1$s text.', 'et_builder' ),
),
'line_height' => array(
'label' => esc_html__( '%1$s Line Height', 'et_builder' ),
'description' => esc_html__( 'Line height adjusts the distance between each line of the %1$s text. This becomes noticeable if the %1$s is long and wraps onto multiple lines.', 'et_builder' ),
),
'text_align' => array(
'label' => esc_html__( '%1$s Text Alignment', 'et_builder' ),
'description' => esc_html__( 'Align the %1$s to the left, right, center or justify.', 'et_builder' ),
),
);
// phpcs:enable
}
}
/**
* Add font option fields.
*
* @since 3.23 Introduce block elements sub options group. Add responsive settings for font set,
* text color, text alignment, and text-shadow options set.
*/
protected function _add_font_fields() {
// Font fields are added by default if module has partial or full VB support.
if ( $this->has_vb_support() ) {
$this->advanced_fields['fonts'] = self::$_->array_get(
$this->advanced_fields,
'fonts',
array(
'module' => array(
'label' => esc_html__( 'Module', 'custom_module' ),
'line_height' => array(
'default' => floatval( et_get_option( 'body_font_height', '1.7' ) ) . 'em',
),
'font_size' => array(
'default' => absint( et_get_option( 'body_font_size', '14' ) ) . 'px',
),
),
)
);
} elseif ( ! $this->has_advanced_fields ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
return;
}
// Font settings have to be array.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'fonts' ) ) ) {
return;
}
$advanced_font_options = $this->advanced_fields['fonts'];
$additional_options = array();
$defaults = array(
'all_caps' => 'off',
);
$this->set_i18n_font();
$i18n =& self::$i18n;
foreach ( $advanced_font_options as $option_name => $option_settings ) {
$advanced_font_options[ $option_name ]['defaults'] = $defaults;
// Continue if toggle is disabled.
$toggle_disabled = isset( $option_settings['disable_toggle'] ) && $option_settings['disable_toggle'];
if ( $toggle_disabled ) {
continue;
}
// Block Elements - 1. Add block elements settings to fonts.
// We need to add link, ul, ol, and quote settings to fonts. We also need to convert
// current font setting with block_elements to be sub toggle of P.
if ( isset( $option_settings['block_elements'] ) && is_array( $option_settings['block_elements'] ) ) {
// Ensure target font option is exist.
if ( ! isset( $advanced_font_options[ $option_name ] ) ) {
continue;
}
// Get current block elements selector.
$block_default_selector = isset( $option_settings['css']['main'] ) ? $option_settings['css']['main'] : '';
$block_elements_css = isset( $option_settings['block_elements']['css'] ) ? $option_settings['block_elements']['css'] : array();
$block_elements_selector = isset( $block_elements_css['main'] ) ? $block_elements_css['main'] : $block_default_selector;
// Ensure block elements selector exist and not empty.
if ( empty( $block_elements_selector ) ) {
// Don't forget to disable block elements, so no sub toggles will be added.
$advanced_font_options[ $option_name ]['block_elements'] = false;
continue;
}
// Block element default settings will be used by the following sub toggles. Special
// for P sub toggle, we have to use existing font settings.
$existing_text_settings = $advanced_font_options[ $option_name ];
$block_elements_default_settings = array(
'line_height' => array(
'default' => '1em',
),
'font_size' => array(
'default' => '14px',
),
'toggle_slug' => $option_name,
);
// Check if current module is child or not. Then append default_on_child argument.
$is_child_module = isset( $this->type ) && 'child' === $this->type;
if ( $is_child_module ) {
// Tell font options to set default_on_child. Use fields prefix to avoid confusion.
$existing_text_settings['fields_default_on_child'] = true;
$block_elements_default_settings['fields_default_on_child'] = true;
}
// a. Paragraph - Convert main text as sub toggle P.
// Convert font settings with block_elements property to be sub toggle of P as
// default. So, we can avoid migration because no settings changed after we added
// block elements. We also need to set default line_height and font_size.
$advanced_font_options[ $option_name ] = array_merge(
$existing_text_settings,
array(
'line_height' => array(
'default' => floatval( et_get_option( 'body_font_height', '1.7' ) ) . 'em',
),
'font_size' => array(
'default' => absint( et_get_option( 'body_font_size', '14' ) ) . 'px',
),
'sub_toggle' => 'p',
)
);
// b. Link.
$link_element_selector = isset( $block_elements_css['link'] ) ? $block_elements_css['link'] : "{$block_elements_selector} a";
$advanced_font_options[ "{$option_name}_link" ] = array_merge(
$block_elements_default_settings,
array(
'label' => et_builder_i18n( 'Link' ),
'css' => array(
'main' => $link_element_selector,
),
'font_size' => array(
'default' => absint( et_get_option( 'body_font_size', '14' ) ) . 'px',
),
'sub_toggle' => 'a',
)
);
// c. Unordered List.
$ul_element_selector = et_()->array_get( $block_elements_css, 'ul', "{$block_elements_selector} ul" );
$ul_li_element_selector = et_()->array_get( $block_elements_css, 'ul_li', "{$ul_element_selector} li" );
$ul_item_indent_selector = et_()->array_get( $block_elements_css, 'ul_item_indent', $ul_element_selector );
$advanced_font_options[ "{$option_name}_ul" ] = array_merge(
$block_elements_default_settings,
array(
'label' => esc_html__( 'Unordered List', 'et_builder' ),
'css' => array(
'main' => $ul_li_element_selector,
'item_indent' => $ul_item_indent_selector,
),
'sub_toggle' => 'ul',
)
);
// d. Ordered List.
$ol_element_selector = et_()->array_get( $block_elements_css, 'ol', "{$block_elements_selector} ol" );
$ol_li_element_selector = et_()->array_get( $block_elements_css, 'ol_li', "{$ol_element_selector} li" );
$ol_item_indent_selector = et_()->array_get( $block_elements_css, 'ol_item_indent', $ol_element_selector );
$advanced_font_options[ "{$option_name}_ol" ] = array_merge(
$block_elements_default_settings,
array(
'label' => esc_html__( 'Ordered List', 'et_builder' ),
'css' => array(
'main' => $ol_li_element_selector,
'item_indent' => $ol_item_indent_selector,
),
'sub_toggle' => 'ol',
)
);
// e. Quote.
$quote_element_selector = isset( $block_elements_css['quote'] ) ? $block_elements_css['quote'] : "{$block_elements_selector} blockquote";
$advanced_font_options[ "{$option_name}_quote" ] = array_merge(
$block_elements_default_settings,
array(
'label' => esc_html__( 'Blockquote', 'et_builder' ),
'css' => array(
'main' => $quote_element_selector,
),
'sub_toggle' => 'quote',
)
);
}
}
$this->advanced_fields['fonts'] = $advanced_font_options;
$font_options_count = 0;
foreach ( $advanced_font_options as $option_name => $option_settings ) {
$font_options_count++;
$option_settings = wp_parse_args(
$option_settings,
array(
'label' => '',
'font_size' => array(),
'letter_spacing' => array(),
'font' => array(),
'text_align' => array(),
)
);
$toggle_disabled = isset( $option_settings['disable_toggle'] ) && $option_settings['disable_toggle'];
$tab_slug = isset( $option_settings['tab_slug'] ) ? $option_settings['tab_slug'] : 'advanced';
$toggle_slug = '';
if ( ! $toggle_disabled ) {
$toggle_slug = isset( $option_settings['toggle_slug'] ) ? $option_settings['toggle_slug'] : $option_name;
$sub_toggle = isset( $option_settings['sub_toggle'] ) ? $option_settings['sub_toggle'] : '';
if ( ! isset( $option_settings['toggle_slug'] ) ) {
$font_toggle = array(
$option_name => array(
'title' => sprintf( '%1$s %2$s', esc_html( $option_settings['label'] ), et_builder_i18n( 'Text' ) ),
'priority' => 50 + $font_options_count,
),
);
$this->_add_settings_modal_toggles( $tab_slug, $font_toggle );
}
}
if ( isset( $option_settings['header_level'] ) ) {
$additional_options[ "{$option_name}_level" ] = array(
'label' => sprintf( esc_html__( '%1$s Heading Level', 'et_builder' ), $option_settings['label'] ),
'description' => sprintf( esc_html__( 'Module %1$s are created using HTML headings. You can change the heading level for this module by choosing anything from H1 through H6. Higher heading levels are smaller and less significant.', 'et_builder' ), $option_settings['label'] ),
'type' => 'multiple_buttons',
'option_category' => 'font_option',
'options' => array(
'h1' => array(
'title' => 'H1',
'icon' => 'text-h1',
),
'h2' => array(
'title' => 'H2',
'icon' => 'text-h2',
),
'h3' => array(
'title' => 'H3',
'icon' => 'text-h3',
),
'h4' => array(
'title' => 'H4',
'icon' => 'text-h4',
),
'h5' => array(
'title' => 'H5',
'icon' => 'text-h5',
),
'h6' => array(
'title' => 'H6',
'icon' => 'text-h6',
),
),
'default' => isset( $option_settings['header_level']['default'] ) ? $option_settings['header_level']['default'] : 'h2',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'advanced_fields' => true,
);
if ( isset( $option_settings['header_level']['computed_affects'] ) ) {
$additional_options[ "{$option_name}_level" ]['computed_affects'] = $option_settings['header_level']['computed_affects'];
}
}
if ( ! isset( $option_settings['hide_font'] ) || ! $option_settings['hide_font'] ) {
$additional_options[ "{$option_name}_font" ] = wp_parse_args(
$option_settings['font'],
array(
'label' => sprintf( $i18n['font']['font']['label'], $option_settings['label'] ),
'description' => sprintf( $i18n['font']['font']['description'], $option_settings['label'] ),
'type' => 'font',
'group_label' => et_core_esc_previously( $option_settings['label'] ),
'option_category' => 'font_option',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'mobile_options' => true,
)
);
// add reference to the obsolete "all caps" option if needed.
if ( isset( $option_settings['use_all_caps'] ) && $option_settings['use_all_caps'] ) {
$additional_options[ "{$option_name}_font" ]['attributes'] = array( 'data-old-option-ref' => "{$option_name}_all_caps" );
}
// set the depends_show_if parameter if needed.
if ( isset( $option_settings['depends_show_if'] ) ) {
$additional_options[ "{$option_name}_font" ]['depends_show_if'] = $option_settings['depends_show_if'];
}
// Set default font settings.
if ( ! empty( $option_settings['font']['default'] ) ) {
$additional_options[ "{$option_name}_font" ]['default'] = $option_settings['font']['default'];
}
// Set default on child font settings.
if ( ! empty( $option_settings['fields_default_on_child'] ) ) {
$additional_options[ "{$option_name}_font" ]['default_on_child'] = true;
}
}
if ( ! isset( $option_settings['hide_text_align'] ) || ! $option_settings['hide_text_align'] ) {
$additional_options[ "{$option_name}_text_align" ] = wp_parse_args(
$option_settings['text_align'],
array(
'label' => sprintf( $i18n['font']['text_align']['label'], $option_settings['label'] ),
'description' => sprintf( $i18n['font']['text_align']['description'], $option_settings['label'] ),
'type' => 'text_align',
'option_category' => 'layout',
'options' => et_builder_get_text_orientation_options( array( 'justified' ), array( 'justify' => 'Justified' ) ),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'advanced_fields' => true,
'mobile_options' => true,
)
);
// Set default on child font settings.
if ( ! empty( $option_settings['fields_default_on_child'] ) ) {
$additional_options[ "{$option_name}_text_align" ]['default_on_child'] = true;
}
}
if ( ! isset( $option_settings['hide_text_color'] ) || ! $option_settings['hide_text_color'] ) {
$label = et_()->array_get( $option_settings, 'text_color.label', false )
? $option_settings['text_color']['label']
: sprintf( $i18n['font']['color']['label'], $option_settings['label'] );
$additional_options[ "{$option_name}_text_color" ] = array(
'label' => $label,
'description' => sprintf( $i18n['font']['color']['description'], $option_settings['label'] ),
'type' => 'color-alpha',
'option_category' => 'font_option',
'custom_color' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
// add reference to the obsolete color option if needed.
if ( self::$_->array_get( $option_settings, 'text_color.old_option_ref' ) ) {
$additional_options[ "{$option_name}_text_color" ]['attributes'] = array( 'data-old-option-ref' => "{$option_settings['text_color']['old_option_ref']}" );
}
// set default value if defined.
if ( self::$_->array_get( $option_settings, 'text_color.default' ) ) {
$additional_options[ "{$option_name}_text_color" ]['default'] = $option_settings['text_color']['default'];
}
// set the depends_show_if parameter if needed.
if ( isset( $option_settings['depends_show_if'] ) ) {
$additional_options[ "{$option_name}_text_color" ]['depends_show_if'] = $option_settings['depends_show_if'];
}
// Set default on child font settings.
if ( ! empty( $option_settings['fields_default_on_child'] ) ) {
$additional_options[ "{$option_name}_text_color" ]['default_on_child'] = true;
}
}
if ( ! isset( $option_settings['hide_font_size'] ) || ! $option_settings['hide_font_size'] ) {
$additional_options[ "{$option_name}_font_size" ] = wp_parse_args(
$option_settings['font_size'],
array(
'label' => sprintf( $i18n['font']['size']['label'], $option_settings['label'] ),
'description' => sprintf( $i18n['font']['size']['description'], $option_settings['label'] ),
'type' => 'range',
'option_category' => 'font_option',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'default_unit' => 'px',
'mobile_options' => true,
'sticky' => true,
'range_settings' => array(
'min' => '1',
'max' => '100',
'step' => '1',
),
'hover' => 'tabs',
)
);
// set the depends_show_if parameter if needed.
if ( isset( $option_settings['depends_show_if'] ) ) {
$additional_options[ "{$option_name}_font_size" ]['depends_show_if'] = $option_settings['depends_show_if'];
}
if ( isset( $option_settings['header_level'] ) ) {
$header_level_default = isset( $option_settings['header_level']['default'] ) ? $option_settings['header_level']['default'] : 'h2';
$additional_options[ "{$option_name}_font_size" ]['default_value_depends'] = "{$option_name}_level";
$additional_options[ "{$option_name}_font_size" ]['default_values_mapping'] = array(
'h1' => '30px',
'h2' => '26px',
'h3' => '22px',
'h4' => '18px',
'h5' => '16px',
'h6' => '14px',
);
// remove default font-size for default header level to use option default.
unset( $additional_options[ "{$option_name}_font_size" ]['default_values_mapping'][ $header_level_default ] );
}
// Set default on child font settings.
if ( ! empty( $option_settings['fields_default_on_child'] ) ) {
$additional_options[ "{$option_name}_font_size" ]['default_on_child'] = true;
}
}
if ( ! isset( $option_settings['hide_letter_spacing'] ) || ! $option_settings['hide_letter_spacing'] ) {
$additional_options[ "{$option_name}_letter_spacing" ] = wp_parse_args(
$option_settings['letter_spacing'],
array(
'label' => sprintf( $i18n['font']['letter_spacing']['label'], $option_settings['label'] ),
'description' => sprintf( $i18n['font']['letter_spacing']['description'], $option_settings['label'] ),
'type' => 'range',
'mobile_options' => true,
'sticky' => true,
'option_category' => 'font_option',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'default' => '0px',
'default_unit' => 'px',
'allowed_units' => array( 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'range_settings' => array(
'min' => '0',
'max' => '100',
'step' => '1',
),
'hover' => 'tabs',
)
);
// set the depends_show_if parameter if needed.
if ( isset( $option_settings['depends_show_if'] ) ) {
$additional_options[ "{$option_name}_letter_spacing" ]['depends_show_if'] = $option_settings['depends_show_if'];
}
// Set default on child font settings.
if ( ! empty( $option_settings['fields_default_on_child'] ) ) {
$additional_options[ "{$option_name}_letter_spacing" ]['default_on_child'] = true;
}
}
if ( ! isset( $option_settings['hide_line_height'] ) || ! $option_settings['hide_line_height'] ) {
$default_option_line_height = array(
'label' => sprintf( $i18n['font']['line_height']['label'], $option_settings['label'] ),
'description' => sprintf( $i18n['font']['line_height']['description'], $option_settings['label'] ),
'type' => 'range',
'mobile_options' => true,
'sticky' => true,
'option_category' => 'font_option',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'default_unit' => 'em',
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'range_settings' => array(
'min' => '1',
'max' => '3',
'step' => '0.1',
),
'hover' => 'tabs',
);
if ( isset( $option_settings['line_height'] ) ) {
$additional_options[ "{$option_name}_line_height" ] = wp_parse_args(
$option_settings['line_height'],
$default_option_line_height
);
} else {
$additional_options[ "{$option_name}_line_height" ] = $default_option_line_height;
}
// set the depends_show_if parameter if needed.
if ( isset( $option_settings['depends_show_if'] ) ) {
$additional_options[ "{$option_name}_line_height" ]['depends_show_if'] = $option_settings['depends_show_if'];
}
// Set default on child font settings.
if ( ! empty( $option_settings['fields_default_on_child'] ) ) {
$additional_options[ "{$option_name}_line_height" ]['default_on_child'] = true;
}
}
// Add text-shadow to font options.
if ( ! isset( $option_settings['hide_text_shadow'] ) || ! $option_settings['hide_text_shadow'] ) {
$option = $this->text_shadow->get_fields(
array(
// Don't use an additional label for 'text' or else we'll end up with 'Text Text Shadow....'.
'label' => 'text' === $option_name ? '' : $option_settings['label'],
'prefix' => $option_name,
'option_category' => 'font_option',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
'mobile_options' => true,
)
);
$additional_options = array_merge( $additional_options, $option );
};
// The below option is obsolete. This code is for backward compatibility.
if ( isset( $option_settings['use_all_caps'] ) && $option_settings['use_all_caps'] ) {
$additional_options[ "{$option_name}_all_caps" ] = array(
'type' => 'hidden',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'sub_toggle' => $sub_toggle,
);
}
// Set options priority if it's exist and not empty. Mostly used to push a setting to
// the top of font settings. For example: reorder Text Color to the top of font settings.
if ( isset( $option_settings['options_priority'] ) && is_array( $option_settings['options_priority'] ) ) {
$options_priority = ! empty( $option_settings['options_priority'] ) ? $option_settings['options_priority'] : array();
$temporary_options = array();
foreach ( $options_priority as $option_key => $option_priority ) {
// Ensure the target is exist before adding priority.
if ( isset( $additional_options[ $option_key ] ) ) {
$additional_options[ $option_key ]['priority'] = $option_priority;
// Keep it on temporary options and remove it from additional options.
// It's needed because priority doesn't work for font settings with no
// sub toggle. Basically, we will reorder the array element of font
// settings here to make it works.
$temporary_options[ $option_key ] = $additional_options[ $option_key ];
unset( $additional_options[ $option_key ] );
}
}
// Merge temporary options with additional options.
$additional_options = array_merge( $temporary_options, $additional_options );
}
if ( isset( $option_settings['block_elements'] ) && is_array( $option_settings['block_elements'] ) ) {
// Block Elements - 2. Set sub toggles for block elements.
// Add p, a, ul, ol, and quote as sub toggle of current font settings. We also
// need to add tabbed_subtoggles property there.
$block_elements = array(
'p' => array(
'name' => 'P',
'icon' => 'text-left',
),
'a' => array(
'name' => 'A',
'icon' => 'text-link',
),
'ul' => array(
'name' => 'UL',
'icon' => 'list',
),
'ol' => array(
'name' => 'OL',
'icon' => 'numbered-list',
),
'quote' => array(
'name' => 'QUOTE',
'icon' => 'text-quote',
),
);
// Tabbed toggle & BB icons support status.
$tabbed_subtoggles = isset( $option_settings['block_elements']['tabbed_subtoggles'] ) ? $option_settings['block_elements']['tabbed_subtoggles'] : false;
$bb_icons_support = isset( $option_settings['block_elements']['bb_icons_support'] ) ? $option_settings['block_elements']['bb_icons_support'] : false;
$this->_add_settings_modal_sub_toggles( $tab_slug, $toggle_slug, $block_elements, $tabbed_subtoggles, $bb_icons_support );
// Block Elements - 3. Set additional options for ul/ol/qoute sub toggles.
// a. UL - Type, Position, and Indent.
$additional_options[ "{$option_name}_ul_type" ] = array(
'label' => esc_html__( 'Unordered List Style Type', 'et_builder' ),
'description' => esc_html__( 'This setting adjusts the shape of the bullet point that begins each list item.', 'et_builder' ),
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'disc' => et_builder_i18n( 'Disc' ),
'circle' => et_builder_i18n( 'Circle' ),
'square' => et_builder_i18n( 'Square' ),
'none' => et_builder_i18n( 'None' ),
),
'priority' => 80,
'default' => 'disc',
'default_on_front' => '',
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'ul',
'mobile_options' => true,
);
$additional_options[ "{$option_name}_ul_position" ] = array(
'label' => esc_html__( 'Unordered List Style Position', 'et_builder' ),
'description' => esc_html__( 'The bullet point that begins each list item can be placed either inside or outside the parent list wrapper. Placing list items inside will indent them further within the list.', 'et_builder' ),
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'outside' => et_builder_i18n( 'Outside' ),
'inside' => et_builder_i18n( 'Inside' ),
),
'priority' => 85,
'default' => 'outside',
'default_on_front' => '',
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'ul',
'mobile_options' => true,
);
$additional_options[ "{$option_name}_ul_item_indent" ] = array(
'label' => esc_html__( 'Unordered List Item Indent', 'et_builder' ),
'description' => esc_html__( 'Increasing indentation will push list items further towards the center of the text content, giving the list more visible separation from the the rest of the text.', 'et_builder' ),
'type' => 'range',
'option_category' => 'configuration',
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'ul',
'priority' => 90,
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'default' => '0px',
'default_unit' => 'px',
'default_on_front' => '',
'range_settings' => array(
'min' => '0',
'max' => '100',
'step' => '1',
),
'mobile_options' => true,
);
// b. OL - Type, Position, and Indent.
$additional_options[ "{$option_name}_ol_type" ] = array(
'label' => esc_html__( 'Ordered List Style Type', 'et_builder' ),
'description' => esc_html__( 'Here you can choose which types of characters are used to distinguish between each item in the ordered list.', 'et_builder' ),
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'decimal' => 'decimal',
'armenian' => 'armenian',
'cjk-ideographic' => 'cjk-ideographic',
'decimal-leading-zero' => 'decimal-leading-zero',
'georgian' => 'georgian',
'hebrew' => 'hebrew',
'hiragana' => 'hiragana',
'hiragana-iroha' => 'hiragana-iroha',
'katakana' => 'katakana',
'katakana-iroha' => 'katakana-iroha',
'lower-alpha' => 'lower-alpha',
'lower-greek' => 'lower-greek',
'lower-latin' => 'lower-latin',
'lower-roman' => 'lower-roman',
'upper-alpha' => 'upper-alpha',
'upper-greek' => 'upper-greek',
'upper-latin' => 'upper-latin',
'upper-roman' => 'upper-roman',
'none' => 'none',
),
'priority' => 80,
'default' => 'decimal',
'default_on_front' => '',
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'ol',
'mobile_options' => true,
);
$additional_options[ "{$option_name}_ol_position" ] = array(
'label' => esc_html__( 'Ordered List Style Position', 'et_builder' ),
'description' => esc_html__( 'The characters that begins each list item can be placed either inside or outside the parent list wrapper. Placing list items inside will indent them further within the list.', 'et_builder' ),
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'inside' => et_builder_i18n( 'Inside' ),
'outside' => et_builder_i18n( 'Outside' ),
),
'priority' => 85,
'default' => 'inside',
'default_on_front' => '',
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'ol',
'mobile_options' => true,
);
$additional_options[ "{$option_name}_ol_item_indent" ] = array(
'label' => esc_html__( 'Ordered List Item Indent', 'et_builder' ),
'description' => esc_html__( 'Increasing indentation will push list items further towards the center of the text content, giving the list more visible separation from the the rest of the text.', 'et_builder' ),
'type' => 'range',
'option_category' => 'configuration',
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'ol',
'priority' => 90,
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'default' => '0px',
'default_unit' => 'px',
'default_on_front' => '',
'range_settings' => array(
'min' => '0',
'max' => '100',
'step' => '1',
),
'mobile_options' => true,
);
// c. Quote - Border Weight and Border Color.
$additional_options[ "{$option_name}_quote_border_weight" ] = array(
'label' => esc_html__( 'Blockquote Border Weight', 'et_builder' ),
'description' => esc_html__( 'Block quotes are given a border to separate them from normal text. You can increase or decrease the size of that border using this setting.', 'et_builder' ),
'type' => 'range',
'option_category' => 'configuration',
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'quote',
'priority' => 85,
'allowed_units' => array( 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'default' => '5px',
'default_unit' => 'px',
'default_on_front' => '',
'range_settings' => array(
'min' => '0',
'max' => '100',
'step' => '1',
),
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
);
$additional_options[ "{$option_name}_quote_border_color" ] = array(
'label' => esc_html__( 'Blockquote Border Color', 'et_builder' ),
'description' => esc_html__( 'Block quotes are given a border to separate them from normal text. Pick a color to use for that border.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'configuration',
'custom_color' => true,
'tab_slug' => 'advanced',
'toggle_slug' => $option_name,
'sub_toggle' => 'quote',
'field_template' => 'color',
'priority' => 90,
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
);
// Set default on child font settings.
if ( ! empty( $option_settings['fields_default_on_child'] ) ) {
$additional_options[ "{$option_name}_ul_type" ]['default_on_child'] = true;
$additional_options[ "{$option_name}_ul_position" ]['default_on_child'] = true;
$additional_options[ "{$option_name}_ul_item_indent" ]['default_on_child'] = true;
$additional_options[ "{$option_name}_ol_type" ]['default_on_child'] = true;
$additional_options[ "{$option_name}_ol_position" ]['default_on_child'] = true;
$additional_options[ "{$option_name}_ol_item_indent" ]['default_on_child'] = true;
$additional_options[ "{$option_name}_quote_border_weight" ]['default_on_child'] = true;
$additional_options[ "{$option_name}_quote_border_color" ]['default_on_child'] = true;
}
}
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add background option fields.
*
* @since 3.23 Add responsive settings for background settings.
*/
protected function _add_background_fields() {
// Background fields are added by default if module has partial or full VB support.
if ( $this->has_vb_support() ) {
$this->advanced_fields['background'] = self::$_->array_get( $this->advanced_fields, 'background', array() );
} elseif ( ! $this->has_advanced_fields ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
return;
}
// Background settings have to be array.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'background' ) ) ) {
return;
}
$toggle_disabled = self::$_->array_get( $this->advanced_fields, 'background.settings.disable_toggle', false );
$tab_slug = self::$_->array_get( $this->advanced_fields, 'background.settings.tab_slug', 'general' );
$toggle_slug = '';
if ( ! $toggle_disabled ) {
$toggle_slug = self::$_->array_get( $this->advanced_fields, 'background.settings.toggle_slug', 'background' );
$background_toggle = array(
'background' => array(
'title' => et_builder_i18n( 'Background' ),
'priority' => 80,
),
);
$this->_add_settings_modal_toggles( $tab_slug, $background_toggle );
}
$background_field_name = 'background';
// Possible values for use_* attributes: true, false, or 'fields_only'.
$defaults = array(
'has_background_color_toggle' => false,
'use_background_color' => true,
'use_background_color_gradient' => true,
'use_background_image' => true,
'use_background_video' => true,
'use_background_color_reset' => true,
);
$this->advanced_fields['background'] = wp_parse_args( $this->advanced_fields['background'], $defaults );
$additional_options = array();
if ( $this->advanced_fields['background']['use_background_color'] ) {
$additional_options = array_merge(
$additional_options,
$this->generate_background_options( 'background', 'color', $tab_slug, $toggle_slug, null )
);
}
// Use background color toggle was added on pre color-alpha era. Added for backward
// compatibility. This option's output is printed manually on render().
if ( $this->advanced_fields['background']['has_background_color_toggle'] ) {
$additional_options['use_background_color'] = self::background_field_template(
'use_color',
array(
'label' => esc_html__( 'Use Background Color', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'color_option',
'options' => array(
'on' => et_builder_i18n( 'Yes' ),
'off' => et_builder_i18n( 'No' ),
),
'affects' => array(
'background_color',
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'description' => esc_html__( 'Here you can choose whether background color setting above should be used or not.', 'et_builder' ),
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
}
if ( $this->advanced_fields['background']['use_background_color_gradient'] ) {
$additional_options = array_merge(
$additional_options,
$this->generate_background_options( 'background', 'gradient', $tab_slug, $toggle_slug, null )
);
}
if ( $this->advanced_fields['background']['use_background_image'] ) {
$additional_options = array_merge(
$additional_options,
$this->generate_background_options( 'background', 'image', $tab_slug, $toggle_slug, null )
);
}
if ( $this->advanced_fields['background']['use_background_video'] ) {
$additional_options = array_merge(
$additional_options,
$this->generate_background_options( 'background', 'video', $tab_slug, $toggle_slug, null )
);
}
// Allow module to configure specific options.
$background_options = self::$_->array_get( $this->advanced_fields, 'background.options', false );
if ( $background_options ) {
foreach ( $background_options as $option_slug => $options ) {
if ( ! is_array( $options ) ) {
continue;
}
foreach ( $options as $option_name => $option_value ) {
$additional_options[ $option_slug ][ $option_name ] = $option_value;
}
}
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add text option fields.
*
* @since 3.23 Add responsive settings for text orientation and layout settings.
*/
protected function _add_text_fields() {
// Text fields are added by default if module has partial or full VB support.
if ( $this->has_vb_support() ) {
$this->advanced_fields['text'] = self::$_->array_get( $this->advanced_fields, 'text', array() );
} elseif ( ! $this->has_advanced_fields ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
return;
}
// Text settings have to be array.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'text' ) ) ) {
return;
}
$text_settings = $this->advanced_fields['text'];
$tab_slug = isset( $text_settings['tab_slug'] ) ? $text_settings['tab_slug'] : 'advanced';
$toggle_slug = isset( $text_settings['toggle_slug'] ) ? $text_settings['toggle_slug'] : 'text';
$sub_toggle = isset( $text_settings['sub_toggle'] ) ? $text_settings['sub_toggle'] : '';
$orientation_exclude_options = isset( $text_settings['text_orientation'] ) && isset( $text_settings['text_orientation']['exclude_options'] ) ? $text_settings['text_orientation']['exclude_options'] : array();
// Make sure we can exclude text_orientation from Advanced/Text.
$setting_defaults = array(
'use_text_orientation' => true,
'use_background_layout' => false,
);
$text_settings = wp_parse_args( $text_settings, $setting_defaults );
$this->_add_settings_modal_toggles(
$tab_slug,
array(
$toggle_slug => array(
'title' => et_builder_i18n( 'Text' ),
'priority' => 49,
),
)
);
$additional_options = array();
if ( $text_settings['use_text_orientation'] ) {
$default_on_front = self::$_->array_get( $text_settings, 'options.text_orientation.default_on_front', '' );
$additional_options = array(
'text_orientation' => wp_parse_args(
self::$_->array_get( $text_settings, 'options.text_orientation', array() ),
array(
'label' => esc_html__( 'Text Alignment', 'et_builder' ),
'type' => 'text_align',
'option_category' => 'layout',
'options' => et_builder_get_text_orientation_options( $orientation_exclude_options ),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'description' => esc_html__( 'This controls how your text is aligned within the module.', 'et_builder' ),
'advanced_fields' => true,
'default' => self::$_->array_get( $text_settings, 'options.text_orientation.default', $default_on_front ),
'mobile_options' => true,
)
),
);
if ( '' !== $sub_toggle ) {
$additional_options['text_orientation']['sub_toggle'] = $sub_toggle;
}
}
// Background layout works by setting text to light/dark color. This was added before text
// color has its own colorpicker as a simple mechanism for picking color.
// New module should not use this option. This is kept for backward compatibility.
if ( $text_settings['use_background_layout'] ) {
$additional_options['background_layout'] = array(
'label' => esc_html__( 'Text Color', 'et_builder' ),
'type' => 'select',
'option_category' => 'color_option',
'options' => array(
'dark' => et_builder_i18n( 'Light' ),
'light' => et_builder_i18n( 'Dark' ),
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'hover' => 'tabs',
'description' => esc_html__( 'Here you can choose whether your text should be light or dark. If you are working with a dark background, then your text should be light. If your background is light, then your text should be set to dark.', 'et_builder' ),
'mobile_options' => true,
'sticky' => true,
);
if ( '' !== $sub_toggle ) {
$additional_options['background_layout']['sub_toggle'] = $sub_toggle;
}
}
// Allow module to configure specific options.
if ( isset( $text_settings['options'] ) && is_array( $text_settings['options'] ) ) {
foreach ( $text_settings['options'] as $option_slug => $options ) {
if ( ! is_array( $options ) ) {
continue;
}
foreach ( $options as $option_name => $option_value ) {
if ( isset( $additional_options[ $option_slug ] ) ) {
$additional_options[ $option_slug ][ $option_name ] = $option_value;
}
}
}
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add Border & Border Radius fields to each module. Default borders option are added on with
* Borders fields group on Design tab. However, module can add more borders field by adding
* more settings on $this->advanced_fields['borders']
*
* @since 3.1
*
* {@internal
* border options are initially defined via _add_additional_border_fields() method and adding
* more border options require overwriting it on module's class. This is repetitive so
* the fields registration mechanics were simplified mimicing advanced fonts field mechanism.}
*/
protected function _add_borders_fields() {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
// Get borders settings. Fallback to default if needed. Borders are added to all modules by default
// unless the module explicitly disabled it
// Backward compatibility. Use `border` settings as default if exist.
$legacy_border = self::$_->array_get( $this->advanced_fields, 'border', array() );
$borders_fields = self::$_->array_get(
$this->advanced_fields,
'borders',
array(
'default' => $legacy_border,
)
);
// Borders settings have to be array.
if ( ! is_array( $borders_fields ) ) {
return;
}
$i18n =& self::$i18n;
if ( ! isset( $i18n['border'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['border'] = array(
'title' => esc_html__( 'Border', 'et_builder' ),
);
// phpcs:enable
}
// Loop border settings, enable multiple border fields declaration in one place.
foreach ( $borders_fields as $border_fields_name => $border_fields ) {
// Enable module to disable border options by setting it to false.
if ( false === $border_fields ) {
continue;
}
// Make sure that border fields has minimum attribute required.
$border_fields_defaults = array(
'tab_slug' => 'advanced',
'toggle_slug' => 'border',
);
$border_fields = wp_parse_args( $border_fields, $border_fields_defaults );
// Check for default border options.
$is_default_border_options = 'default' === $border_fields_name;
if ( $is_default_border_options ) {
// Default border fields doesn't have toggle for itself, thus register new toggle.
$this->_add_settings_modal_toggles(
$border_fields['tab_slug'],
array(
$border_fields['toggle_slug'] => array(
'title' => $i18n['border']['title'],
'priority' => 95,
),
)
);
}
// Add suffix to border fields settings.
$suffix = $is_default_border_options ? '' : "_{$border_fields_name}";
$border_fields['suffix'] = $suffix;
// Assign CSS setting to advanced options.
if ( isset( $border_fields['css'] ) ) {
$this->advanced_fields[ "border{$suffix}" ]['css'] = $border_fields['css'];
}
// Add border fields to advanced_fields. Each border fields (style + radii) has its own attribute
// registered on $this->advanced_fields.
self::$_->array_set( $this->advanced_fields, "border{$suffix}", $border_fields );
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
ET_Builder_Module_Fields_Factory::get( 'Border' )->get_fields( $border_fields )
);
// Add module defined fields that needs to be added after existing border options.
if ( isset( $border_fields['fields_after'] ) ) {
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
$border_fields['fields_after']
);
}
// Loop radii and styles and add fields to advanced_fields.
foreach ( array( 'border_radii', 'border_styles' ) as $border_key ) {
$border_key_name = $border_key . $suffix;
if ( isset( $this->advanced_fields[ "border{$suffix}" ][ $border_key_name ] ) ) {
// Backward compatibility. Properly handle existing 3rd party module that
// directly defines border via direct $this->advanced_fields["border{$suffix}"].
$this->advanced_fields[ "border{$suffix}" ][ $border_key_name ] = array_merge(
$this->advanced_fields[ "border{$suffix}" ][ $border_key_name ],
$this->_additional_fields_options[ $border_key_name ]
);
$message = "You're Doing It Wrong! You shouldn't define border settings in 'advanced_fields' directly. All the Border settings should be defined via provided API";
et_debug( $message );
}
// Border used to rely on $this->advanced_fields complete configuration for
// rendering. Since option template update, border style rendering fetches
// border setting based on rebuilt fields on demand for performance reason.
}
}
if ( method_exists( $this, '_add_additional_border_fields' ) ) {
// Backwards compatibility should go after all the fields added to emulate behavior of old version.
$this->_add_additional_border_fields();
$message = "You're Doing It Wrong! '_add_additional_border_fields' is deprecated. All the Border settings should be defined via provided API";
et_debug( $message );
}
}
/**
* Add transform fields.
*/
protected function _add_transforms_fields() {
$i18n =& self::$i18n;
if ( ! isset( $i18n['transforms'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['transforms'] = array(
'title' => esc_html__( 'Transform', 'et_builder' ),
);
// phpcs:enable
}
$this->advanced_fields['transform'] = self::$_->array_get( $this->advanced_fields, 'transform', array() );
// Transforms Disabled.
if ( false === $this->advanced_fields['transform'] ) {
return;
}
// Transforms settings have to be array.
if ( ! is_array( $this->advanced_fields['transform'] ) ) {
return;
}
$this->settings_modal_toggles['advanced']['toggles']['transform'] = array(
'title' => $i18n['transforms']['title'],
'priority' => 109,
);
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
/** Get transform fields. @see ET_Builder_Module_Field_Transform::get_fields() */
ET_Builder_Module_Fields_Factory::get( 'Transform' )->get_fields()
);
}
/**
* Add sizing option fields.
*/
protected function _add_sizing_fields() {
// Maybe someone did overwrite this function.
$this->_add_max_width_fields();
$additional_options = array();
$features = array(
'max_width' => 'MaxWidth',
'height' => 'Height',
);
foreach ( $features as $name => $fields_name ) {
if ( $this->has_vb_support() ) {
$this->advanced_fields[ $name ] = self::$_->array_get( $this->advanced_fields, $name, array() );
} elseif ( ! $this->has_advanced_fields ) {
return;
}
if ( ! is_array( self::$_->array_get( $this->advanced_fields, $name ) ) ) {
return;
}
$extra = self::$_->array_get( $this->advanced_fields[ $name ], 'extra', array() );
$fields = array_merge( array( '' => $this->advanced_fields[ $name ] ), $extra );
foreach ( $fields as $prefix => $settings ) {
$prefix = et_builder_add_prefix( $prefix, '' );
$tab_slug = isset( $settings['tab_slug'] ) ? $settings['tab_slug'] : 'advanced';
$toggle_slug = isset( $settings['toggle_slug'] ) ? $settings['toggle_slug'] : 'width';
$toggle_title = isset( $settings['toggle_title'] ) ? $settings['toggle_title'] : et_builder_i18n( 'Sizing' );
$toggle_priority = isset( $settings['toggle_priority'] ) ? $settings['toggle_priority'] : 80;
$settings['prefix'] = $prefix;
$this->_add_settings_modal_toggles(
$tab_slug,
array(
$toggle_slug => array(
'title' => $toggle_title,
'priority' => $toggle_priority,
),
)
);
$additional_options = array_merge(
$additional_options,
ET_Builder_Module_Fields_Factory::get( $fields_name )->get_fields( $settings )
);
// Allow module to configure specific options.
if ( isset( $settings['options'] ) && is_array( $settings['options'] ) ) {
foreach ( $settings['options'] as $option_slug => $options ) {
if ( ! is_array( $options ) ) {
continue;
}
foreach ( $options as $option_name => $option_value ) {
$additional_options[ $prefix . $option_slug ][ $option_name ] = $option_value;
}
}
}
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
}
// phpcs:ignore Generic.Commenting.DocComment -- Deprecated function.
/**
* @deprecated
*/
public function _add_max_width_fields() {
}
/**
* Add overflow option fields.
*/
protected function _add_overflow_fields() {
if ( is_array( self::$_->array_get( $this->advanced_fields, 'overflow', array() ) ) ) {
$default_overflow = self::$_->array_get( $this->advanced_fields, 'overflow.default', ET_Builder_Module_Helper_Overflow::OVERFLOW_DEFAULT );
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
ET_Builder_Module_Fields_Factory::get( 'Overflow' )->get_fields( array( 'default' => $default_overflow ) )
);
}
}
/**
* Return Scroll effects option fields.
*
* @return array
*/
public function get_scroll_effects_options() {
// cache translations.
$prefix = 'scroll_';
$i18n =& self::$i18n;
if ( ! isset( $i18n['motion'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['motion'] = array(
'vertical' => array(
'label' => __( 'Vertical Motion', 'et_builder' ),
'description' => __( 'Give this element vertical motion so that is moves faster or slower than the elements around it as the viewer scrolls through the page.', 'et_builder' ),
'startValueTitle' => __( 'Starting Offset', 'et_builder' ),
'middleValueTitle' => __( 'Mid Offset', 'et_builder' ),
'endValueTitle' => __( 'Ending Offset', 'et_builder' ),
),
'horizontal' => array(
'label' => __( 'Horizontal Motion', 'et_builder' ),
'description' => __( 'Give this element horizontal motion so that it slides left or right as the viewer scrolls through the page.', 'et_builder' ),
'startValueTitle' => __( 'Starting Offset', 'et_builder' ),
'middleValueTitle' => __( 'Mid Offset', 'et_builder' ),
'endValueTitle' => __( 'Ending Offset', 'et_builder' ),
),
'fade' => array(
'label' => __( 'Fading In and Out', 'et_builder' ),
'description' => __( 'Give this element an opacity effect so that it fades in and out as the viewer scrolls through the page.', 'et_builder' ),
'startValueTitle' => __( 'Starting Opacity', 'et_builder' ),
'middleValueTitle' => __( 'Mid Opacity', 'et_builder' ),
'endValueTitle' => __( 'Ending Opacity', 'et_builder' ),
),
'scaling' => array(
'label' => __( 'Scaling Up and Down', 'et_builder' ),
'description' => __( 'Give this element a scale effect so that it grows and shrinks as the viewer scrolls through the page.', 'et_builder' ),
'startValueTitle' => __( 'Starting Scale', 'et_builder' ),
'middleValueTitle' => __( 'Mid Scale', 'et_builder' ),
'endValueTitle' => __( 'Ending Scale', 'et_builder' ),
),
'rotating' => array(
'label' => __( 'Rotating', 'et_builder' ),
'description' => __( 'Give this element rotating motion so that it spins as the viewer scrolls through the page.', 'et_builder' ),
'startValueTitle' => __( 'Starting Rotation', 'et_builder' ),
'middleValueTitle' => __( 'Mid Rotation', 'et_builder' ),
'endValueTitle' => __( 'Ending Rotation', 'et_builder' ),
),
'blur' => array(
'label' => __( 'Blur', 'et_builder' ),
'description' => __( 'Give this element a blur effect so that it moves in and out of focus as the viewer scrolls through the page.', 'et_builder' ),
'startValueTitle' => __( 'Starting Blur', 'et_builder' ),
'middleValueTitle' => __( 'Mid Blur', 'et_builder' ),
'endValueTitle' => __( 'Ending Blur', 'et_builder' ),
),
);
// phpcs:enable
}
return array(
"${prefix}vertical_motion" => array(
'label' => $i18n['motion']['vertical']['label'],
'description' => $i18n['motion']['vertical']['description'],
'startValueTitle' => $i18n['motion']['vertical']['startValueTitle'],
'middleValueTitle' => $i18n['motion']['vertical']['middleValueTitle'],
'endValueTitle' => $i18n['motion']['vertical']['endValueTitle'],
'icon' => 'vertical-motion',
'resolver' => 'translateY',
'default' => '0|50|50|100|4|0|-4',
),
"{$prefix}horizontal_motion" => array(
'label' => $i18n['motion']['horizontal']['label'],
'description' => $i18n['motion']['horizontal']['description'],
'startValueTitle' => $i18n['motion']['horizontal']['startValueTitle'],
'middleValueTitle' => $i18n['motion']['horizontal']['middleValueTitle'],
'endValueTitle' => $i18n['motion']['horizontal']['endValueTitle'],
'icon' => 'horizontal-motion',
'resolver' => 'translateX',
'default' => '0|50|50|100|4|0|-4',
),
"{$prefix}fade" => array(
'label' => $i18n['motion']['fade']['label'],
'description' => $i18n['motion']['fade']['description'],
'startValueTitle' => $i18n['motion']['fade']['startValueTitle'],
'middleValueTitle' => $i18n['motion']['fade']['middleValueTitle'],
'endValueTitle' => $i18n['motion']['fade']['endValueTitle'],
'icon' => 'animation-fade',
'resolver' => 'opacity',
'default' => '0|50|50|100|0|100|100',
),
"{$prefix}scaling" => array(
'label' => $i18n['motion']['scaling']['label'],
'description' => $i18n['motion']['scaling']['description'],
'startValueTitle' => $i18n['motion']['scaling']['startValueTitle'],
'middleValueTitle' => $i18n['motion']['scaling']['middleValueTitle'],
'endValueTitle' => $i18n['motion']['scaling']['endValueTitle'],
'icon' => 'resize',
'resolver' => 'scale',
'default' => '0|50|50|100|70|100|100',
),
"{$prefix}rotating" => array(
'label' => $i18n['motion']['rotating']['label'],
'description' => $i18n['motion']['rotating']['description'],
'startValueTitle' => $i18n['motion']['rotating']['startValueTitle'],
'middleValueTitle' => $i18n['motion']['rotating']['middleValueTitle'],
'endValueTitle' => $i18n['motion']['rotating']['endValueTitle'],
'icon' => 'rotate',
'resolver' => 'rotate',
'default' => '0|50|50|100|90|0|0',
),
"{$prefix}blur" => array(
'label' => $i18n['motion']['blur']['label'],
'description' => $i18n['motion']['blur']['description'],
'startValueTitle' => $i18n['motion']['blur']['startValueTitle'],
'middleValueTitle' => $i18n['motion']['blur']['middleValueTitle'],
'endValueTitle' => $i18n['motion']['blur']['endValueTitle'],
'icon' => 'blur',
'resolver' => 'blur',
'default' => '0|40|60|100|10|0|0',
),
);
}
/**
* Add sticky fields to the additional fields options.
*
* @since 4.6.0
*
* @return void
*/
protected function _add_sticky_fields() {
if ( is_array( self::$_->array_get( $this->advanced_fields, 'sticky', array() ) ) ) {
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
ET_Builder_Module_Fields_Factory::get( 'Sticky' )->get_fields(
array(
'module_slug' => $this->slug,
)
)
);
}
}
/**
* Add scroll effects option fields.
*/
protected function _add_scroll_effects_fields() {
if ( is_array( self::$_->array_get( $this->advanced_fields, 'scroll_effects', array() ) ) ) {
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
ET_Builder_Module_Fields_Factory::get( 'Scroll' )->get_fields(
array(
'options' => $this->get_scroll_effects_options(),
'grid_support' => self::$_->array_get( $this->advanced_fields, 'scroll_effects.grid_support', 'no' ),
)
)
);
}
}
/**
* Add margin & padding option fields.
*
* @since 3.23 Add allowed CSS units for margin and padding.
*/
protected function _add_margin_padding_fields() {
// Margin-Padding fields are added by default if module has partial or full VB support.
if ( $this->has_vb_support() ) {
$this->advanced_fields['margin_padding'] = self::$_->array_get( $this->advanced_fields, 'margin_padding', array() );
} elseif ( ! $this->has_advanced_fields ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
return;
}
// Margin settings have to be array.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'margin_padding' ) ) ) {
return;
}
$additional_options = array();
$defaults = array(
'use_margin' => true,
'draggable_margin' => true,
'use_padding' => true,
'draggable_padding' => true,
);
$this->advanced_fields['margin_padding'] = wp_parse_args( $this->advanced_fields['margin_padding'], $defaults );
$tab_slug = isset( $this->advanced_fields['margin_padding']['tab_slug'] ) ? $this->advanced_fields['margin_padding']['tab_slug'] : 'advanced';
$toggle_disabled = isset( $this->advanced_fields['margin_padding']['disable_toggle'] ) && $this->advanced_fields['margin_padding']['disable_toggle'];
$toggle_slug = isset( $this->advanced_fields['margin_padding']['toggle_slug'] ) ? $this->advanced_fields['margin_padding']['toggle_slug'] : 'margin_padding';
$i18n =& self::$i18n;
if ( ! isset( $i18n['margin'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['margin'] = array(
'toggle' => array(
'title' => esc_html__( 'Spacing', 'et_builder' ),
),
'margin' => array(
'label' => esc_html__( 'Margin', 'et_builder' ),
'description' => esc_html__( 'Margin adds extra space to the outside of the element, increasing the distance between the element and other items on the page.', 'et_builder' ),
),
'padding' => array(
'label' => esc_html__( 'Padding', 'et_builder' ),
'description' => esc_html__( 'Padding adds extra space to the inside of the element, increasing the distance between the edge of the element and its inner contents.', 'et_builder' ),
),
);
// phpcs:enable
}
if ( ! $toggle_disabled ) {
$margin_toggle = array(
$toggle_slug => array(
'title' => $i18n['margin']['toggle']['title'],
'priority' => 90,
),
);
$this->_add_settings_modal_toggles( $tab_slug, $margin_toggle );
}
if ( $this->advanced_fields['margin_padding']['use_margin'] ) {
$additional_options['custom_margin'] = array(
'label' => $i18n['margin']['margin']['label'],
'description' => $i18n['margin']['margin']['description'],
'type' => 'custom_margin',
'mobile_options' => true,
'sticky' => true,
'option_category' => 'layout',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'hover' => 'tabs',
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
);
$additional_options['custom_margin_tablet'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
);
$additional_options['custom_margin_phone'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
// make it possible to override/add options.
if ( ! empty( $this->advanced_fields['margin_padding']['custom_margin'] ) ) {
$additional_options['custom_margin'] = array_merge( $additional_options['custom_margin'], $this->advanced_fields['margin_padding']['custom_margin'] );
}
$additional_options['custom_margin_last_edited'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
$additional_options['padding_1_last_edited'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
$additional_options['padding_2_last_edited'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
$additional_options['padding_3_last_edited'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
$additional_options['padding_4_last_edited'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
}
if ( $this->advanced_fields['margin_padding']['use_padding'] ) {
$additional_options['custom_padding'] = array(
'label' => $i18n['margin']['padding']['label'],
'description' => $i18n['margin']['padding']['description'],
'type' => 'custom_padding',
'mobile_options' => true,
'sticky' => true,
'option_category' => 'layout',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'hover' => 'tabs',
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
);
$additional_options['custom_padding_tablet'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
$additional_options['custom_padding_phone'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
// make it possible to override/add options.
if ( ! empty( $this->advanced_fields['margin_padding']['custom_padding'] ) ) {
$additional_options['custom_padding'] = array_merge( $additional_options['custom_padding'], $this->advanced_fields['margin_padding']['custom_padding'] );
}
$additional_options['custom_padding_last_edited'] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add button option fields.
*
* @since 3.23 Add custom padding for button options set. Add allowed CSS units. Set custom
* default for text size and border width. Add responsive settings for button
* settings. Set custom group label. Add ability hide and show the icon settings.
*/
protected function _add_button_fields() {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_advanced_fields ) {
return;
}
// Button settings have to be array.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'button' ) ) ) {
return;
}
$this->set_i18n_font();
$i18n =& self::$i18n;
// Auto-add attributes toggle.
$toggles_custom_css_tab = isset( $this->settings_modal_toggles['custom_css'] ) ? $this->settings_modal_toggles['custom_css'] : array();
if ( ! isset( $toggles_custom_css_tab['toggles'] ) || ! isset( $toggles_custom_css_tab['toggles']['attributes'] ) ) {
$this->_add_settings_modal_toggles(
'custom_css',
array(
'attributes' => array(
'title' => esc_html__( 'Attributes', 'et_builder' ),
'priority' => 95,
),
)
);
}
$additional_options = array();
$hover = et_pb_hover_options();
foreach ( $this->advanced_fields['button'] as $option_name => $option_settings ) {
$tab_slug = isset( $option_settings['tab_slug'] ) ? $option_settings['tab_slug'] : 'advanced';
$toggle_disabled = isset( $option_settings['disable_toggle'] ) && $option_settings['disable_toggle'];
$toggle_slug = '';
if ( ! $toggle_disabled ) {
$toggle_slug = isset( $option_settings['toggle_slug'] ) ? $option_settings['toggle_slug'] : $option_name;
$button_toggle = array(
$option_name => array(
'title' => esc_html( $option_settings['label'] ),
'priority' => 70,
),
);
$this->_add_settings_modal_toggles( $tab_slug, $button_toggle );
}
// Custom default values defined on module.
$text_size_default = self::$_->array_get( $option_settings, 'text_size.default', '' );
$border_width_default = self::$_->array_get( $option_settings, 'border_width.default', '' );
$additional_options[ "custom_{$option_name}" ] = array(
'label' => sprintf( esc_html__( 'Use Custom Styles For %1$s ', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( "If you would like to customize the appearance of this module's button, you must first enable custom button styles.", 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'button',
'options' => array(
'off' => et_builder_i18n( 'No' ),
'on' => et_builder_i18n( 'Yes' ),
),
'affects' => array(
"{$option_name}_text_color",
"{$option_name}_text_size",
"{$option_name}_border_width",
"{$option_name}_border_radius",
"{$option_name}_letter_spacing",
"{$option_name}_spacing",
"{$option_name}_bg_color",
"{$option_name}_border_color",
"{$option_name}_use_icon",
"{$option_name}_font",
$hover->get_hover_field( "{$option_name}_text_color" ),
$hover->get_hover_field( "{$option_name}_border_color" ),
$hover->get_hover_field( "{$option_name}_border_radius" ),
$hover->get_hover_field( "{$option_name}_letter_spacing" ),
"{$option_name}_text_shadow_style", // Add Text Shadow to button options.
"{$option_name}_custom_margin",
"{$option_name}_custom_padding",
),
'default_on_front' => 'off',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
$additional_options[ "{$option_name}_text_size" ] = array(
'label' => sprintf( $i18n['font']['size']['label'], $option_settings['label'] ),
'description' => esc_html__( 'Increase or decrease the size of the button text.', 'et_builder' ),
'type' => 'range',
'range_settings' => array(
'min' => '1',
'max' => '100',
'step' => '1',
),
'option_category' => 'button',
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'default' => ! empty( $text_size_default ) ? $text_size_default : ET_Global_Settings::get_value( 'all_buttons_font_size' ),
'default_unit' => 'px',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'mobile_options' => true,
'sticky' => true,
'depends_show_if' => 'on',
'hover' => 'tabs',
);
$additional_options[ "{$option_name}_text_color" ] = array(
'label' => sprintf( $i18n['font']['color']['label'], $option_settings['label'] ),
'description' => esc_html__( 'Pick a color to be used for the button text.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'button',
'custom_color' => true,
'default' => '',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options[ "{$option_name}_bg_color" ] = array(
'label' => sprintf( esc_html__( '%1$s Background', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'Adjust the background style of the button by customizing the background color, gradient, and image.', 'et_builder' ),
'type' => 'background-field',
'base_name' => "{$option_name}_bg",
'context' => "{$option_name}_bg_color",
'option_category' => 'button',
'custom_color' => true,
'default' => ET_Global_Settings::get_value( 'all_buttons_bg_color' ),
'default_on_front' => '',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
'background_fields' => $this->generate_background_options( "{$option_name}_bg", 'button', $tab_slug, $toggle_slug, "{$option_name}_bg_color" ),
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options[ "{$option_name}_bg_color" ]['background_fields'][ "{$option_name}_bg_color" ]['default'] = ET_Global_Settings::get_value( 'all_buttons_bg_color' );
$additional_options = array_merge( $additional_options, $this->generate_background_options( "{$option_name}_bg", 'skip', $tab_slug, $toggle_slug, "{$option_name}_bg_color" ) );
$additional_options[ "{$option_name}_border_width" ] = array(
'label' => sprintf( esc_html__( '%1$s Border Width', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'Increase or decrease the thickness of the border around the button. Setting this value to 0 will remove the border entirely.', 'et_builder' ),
'type' => 'range',
'option_category' => 'button',
'default' => ! empty( $border_width_default ) ? $border_width_default : ET_Global_Settings::get_value( 'all_buttons_border_width' ),
'default_unit' => 'px',
'default_on_front' => '',
'allowed_units' => array( 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options[ "{$option_name}_border_color" ] = array(
'label' => sprintf( esc_html__( '%1$s Border Color', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'Pick a color to be used for the button border.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'button',
'custom_color' => true,
'default' => '',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options[ "{$option_name}_border_radius" ] = array(
'label' => sprintf( esc_html__( '%1$s Border Radius', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( "Increasing the border radius will increase the roundness of the button's corners. Setting this value to 0 will result in squared corners.", 'et_builder' ),
'type' => 'range',
'option_category' => 'button',
'default' => ET_Global_Settings::get_value( 'all_buttons_border_radius' ),
'default_unit' => 'px',
'default_on_front' => '',
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options[ "{$option_name}_letter_spacing" ] = array(
'label' => sprintf( $i18n['font']['letter_spacing']['label'], $option_settings['label'] ),
'description' => esc_html__( 'Letter spacing adjusts the distance between each letter in the button.', 'et_builder' ),
'type' => 'range',
'option_category' => 'button',
'default' => ET_Global_Settings::get_value( 'all_buttons_spacing' ),
'default_unit' => 'px',
'default_on_front' => '',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'mobile_options' => true,
'sticky' => true,
'depends_show_if' => 'on',
'hover' => 'tabs',
);
$additional_options[ "{$option_name}_font" ] = array(
'label' => sprintf( $i18n['font']['font']['label'], $option_settings['label'] ),
'description' => esc_html__( 'Choose a custom font to use for the button. All Google web fonts are available, or you can upload your own custom font files.', 'et_builder' ),
'group_label' => esc_html( $option_settings['label'] ),
'type' => 'font',
'option_category' => 'button',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
'mobile_options' => true,
);
// Hide show button icon.
$hide_icon = isset( $option_settings['hide_icon'] ) ? $option_settings['hide_icon'] : false;
if ( false === $hide_icon ) {
$additional_options[ "{$option_name}_use_icon" ] = array(
'label' => sprintf( esc_html__( 'Show %1$s Icon', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'When enabled, this will add a custom icon within the button.', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'button',
'default' => 'on',
'options' => array(
'on' => et_builder_i18n( 'Yes' ),
'off' => et_builder_i18n( 'No' ),
),
'affects' => array(
"{$option_name}_icon_color",
"{$option_name}_icon_placement",
"{$option_name}_on_hover",
"{$option_name}_icon",
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
);
$additional_options[ "{$option_name}_icon" ] = array(
'label' => sprintf( esc_html__( '%1$s Icon', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'Pick an icon to be used for the button.', 'et_builder' ),
'type' => 'select_icon',
'option_category' => 'button',
'class' => array( 'et-pb-font-icon' ),
'default' => '',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if_not' => 'off',
'mobile_options' => true,
);
$additional_options[ "{$option_name}_icon_color" ] = array(
'label' => sprintf( esc_html__( '%1$s Icon Color', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'Here you can define a custom color for the button icon.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'button',
'custom_color' => true,
'default' => '',
'hover' => 'tabs',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if_not' => 'off',
'mobile_options' => true,
'sticky' => true,
);
$additional_options[ "{$option_name}_icon_placement" ] = array(
'label' => sprintf( esc_html__( '%1$s Icon Placement', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'Choose where the button icon should be displayed within the button.', 'et_builder' ),
'type' => 'select',
'option_category' => 'button',
'options' => array(
'right' => et_builder_i18n( 'Right' ),
'left' => et_builder_i18n( 'Left' ),
),
'default' => 'right',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if_not' => 'off',
'mobile_options' => true,
);
$additional_options[ "{$option_name}_on_hover" ] = array(
'label' => sprintf( esc_html__( 'Only Show Icon On Hover for %1$s', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'By default, button icons are displayed on hover. If you would like button icons to always be displayed, then you can enable this option.', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'button',
'default' => 'on',
'options' => array(
'on' => et_builder_i18n( 'Yes' ),
'off' => et_builder_i18n( 'No' ),
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if_not' => 'off',
'mobile_options' => true,
);
}
if ( isset( $option_settings['use_alignment'] ) && $option_settings['use_alignment'] ) {
$additional_options[ "{$option_name}_alignment" ] = array(
'label' => esc_html__( 'Button Alignment', 'et_builder' ),
'description' => esc_html__( 'Align your button to the left, right or center of the module.', 'et_builder' ),
'type' => 'text_align',
'option_category' => 'layout',
'options' => et_builder_get_text_orientation_options( array( 'justified' ) ),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'mobile_options' => true,
);
}
// The configurable rel attribute field is added by default.
if ( ! isset( $option_settings['no_rel_attr'] ) ) {
$additional_options[ "{$option_name}_rel" ] = array(
'label' => sprintf( esc_html__( '%1$s Relationship', 'et_builder' ), $option_settings['label'] ),
'type' => 'multiple_checkboxes',
'option_category' => 'configuration',
'options' => $this->get_rel_values(),
'description' => et_get_safe_localization( __( "Specify the value of your link's <em>rel</em> attribute. The <em>rel</em> attribute specifies the relationship between the current document and the linked document.<br><strong>Tip:</strong> Search engines can use this attribute to get more information about a link.", 'et_builder' ) ),
'tab_slug' => 'custom_css',
'toggle_slug' => 'attributes',
'shortcut_index' => $option_name,
);
}
// Add text-shadow to button options.
$option = $this->text_shadow->get_fields(
array(
'label' => $option_settings['label'],
'prefix' => $option_name,
'option_category' => 'font_option',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_show_if' => 'on',
'show_if' => array(
"custom_{$option_name}" => 'on',
),
)
);
$additional_options = array_merge( $additional_options, $option );
// Conditionally add box-shadow options to button options. Get box shadow settings for advanced button fields.
$button_box_shadow_options = self::$_->array_get( $option_settings, 'box_shadow', array() );
// Enable module to remove box shadow from advanced button fields by declaring false value to box
// shadow attribute (i.e. button module).
if ( false !== $button_box_shadow_options ) {
$button_box_shadow_options = wp_parse_args(
$button_box_shadow_options,
array(
'label' => esc_html__( 'Button Box Shadow', 'et_builder' ),
'option_category' => 'layout',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'show_if' => array(
"custom_{$option_name}" => 'on',
),
)
);
// Only print box shadow styling if custom_* attribute is equal to "on" by adding show_iff attribute.
$button_visibility_condition = array( "custom_{$option_name}" => 'on' );
self::$_->array_set( $button_box_shadow_options, 'css.show_if', $button_visibility_condition );
// Automatically add default box shadow fields if box shadow attribute hasn't even defined yet.
// No attribute found is considered true for default thus if this about to add the first advanced
// box shadow, add the default first.
if ( ! isset( $this->advanced_fields['box_shadow'] ) ) {
$button_box_shadow_options_default = array();
self::$_->array_set( $this->advanced_fields, 'box_shadow.default', $button_box_shadow_options_default );
}
// Box shadow fields are generated after button fields being added. Thus, adding $this->advanced_fields
// is sufficient to insert the box shadow fields.
self::$_->array_set( $this->advanced_fields, "box_shadow.{$option_name}", $button_box_shadow_options );
}
// Add custom margin-padding to form field options.
$margin_padding = self::$_->array_get( $option_settings, 'margin_padding', true );
if ( $margin_padding ) {
$margin_padding_module_args = is_array( $margin_padding ) ? $margin_padding : array();
$margin_padding_args = wp_parse_args(
$margin_padding_module_args,
array(
'label' => $option_settings['label'],
'prefix' => $option_name,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
)
);
$margin_padding_options = $this->margin_padding->get_fields( $margin_padding_args );
$additional_options = array_merge( $additional_options, $margin_padding_options );
}
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add animation option fields.
*
* @since 3.23 Introduce responsive settings on all animation options. Rename Animation label
* for et_pb_team_member module as Image Animation. Reorder animation repeat option
* to the bottom of animation settings.
*/
protected function _add_animation_fields() {
// Animation fields are added by default on all module.
$this->advanced_fields['animation'] = self::$_->array_get( $this->advanced_fields, 'animation', array() );
// Animation Disabled.
if ( false === $this->advanced_fields['animation'] ) {
return;
}
$classname = get_class( $this );
// Child modules do not support the Animation settings except for Columns.
if ( isset( $this->type ) && 'child' === $this->type && ! in_array( $this->slug, array( 'et_pb_column', 'et_pb_column_inner' ), true ) ) {
return;
}
// Cache results so that translation/escaping only happens once.
$i18n =& self::$i18n;
if ( ! isset( $i18n['animation'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['animation'] = array(
'toggle' => array(
'title' => esc_html__( 'Animation', 'et_builder' ),
),
'style' => array(
'label' => esc_html__( 'Animation Style', 'et_builder' ),
'description' => esc_html__( 'Pick an animation style to enable animations for this element. Once enabled, you will be able to customize your animation style further. To disable animations, choose the None option.', 'et_builder' ),
'options' => array(
'fade' => et_builder_i18n( 'Fade' ),
'slide' => et_builder_i18n( 'Slide' ),
'bounce' => esc_html__( 'Bounce', 'et_builder' ),
'zoom' => esc_html__( 'Zoom', 'et_builder' ),
'flip' => et_builder_i18n( 'Flip' ),
'fold' => esc_html__( 'Fold', 'et_builder' ),
'roll' => esc_html__( 'Roll', 'et_builder' ),
),
),
'direction' => array(
'label' => esc_html__( 'Animation Direction', 'et_builder' ),
'description' => esc_html__( 'Pick from up to five different animation directions, each of which will adjust the starting and ending position of your animated element.', 'et_builder' ),
),
'duration' => array(
'label' => esc_html__( 'Animation Duration', 'et_builder' ),
'description' => esc_html__( 'Speed up or slow down your animation by adjusting the animation duration. Units are in milliseconds and the default animation duration is one second.', 'et_builder' ),
),
'delay' => array(
'label' => esc_html__( 'Animation Delay', 'et_builder' ),
'description' => esc_html__( 'If you would like to add a delay before your animation runs you can designate that delay here in milliseconds. This can be useful when using multiple animated modules together.', 'et_builder' ),
),
'opacity' => array(
'label' => esc_html__( 'Animation Starting Opacity', 'et_builder' ),
'description' => esc_html__( 'By increasing the starting opacity, you can reduce or remove the fade effect that is applied to all animation styles.', 'et_builder' ),
),
'speed' => array(
'label' => esc_html__( 'Animation Speed Curve', 'et_builder' ),
'description' => esc_html__( 'Here you can adjust the easing method of your animation. Easing your animation in and out will create a smoother effect when compared to a linear speed curve.', 'et_builder' ),
),
'repeat' => array(
'label' => esc_html__( 'Animation Repeat', 'et_builder' ),
'description' => esc_html__( 'By default, animations will only play once. If you would like to loop your animation continuously you can choose the Loop option here.', 'et_builder' ),
'options' => array(
'once' => esc_html__( 'Once', 'et_builder' ),
'loop' => esc_html__( 'Loop', 'et_builder' ),
),
),
'menu' => array(
'label' => esc_html__( 'Dropdown Menu Animation', 'et_builder' ),
'description' => esc_html__( 'Select an animation to be used when dropdown menus appear. Dropdown menus appear when hovering over links with sub items.', 'et_builder' ),
),
'intensity' => array(
'label' => esc_html__( 'Animation Intensity', 'et_builder' ),
'description' => esc_html__( 'Intensity effects how subtle or aggressive your animation will be. Lowering the intensity will create a smoother and more subtle animation while increasing the intensity will create a snappier more aggressive animation.', 'et_builder' ),
),
);
// phpcs:enable
}
$this->settings_modal_toggles['advanced']['toggles']['animation'] = array(
'title' => $i18n['animation']['toggle']['title'],
'priority' => 110,
);
$additional_options = array();
$animations_intensity_fields = array(
'animation_intensity_slide',
'animation_intensity_zoom',
'animation_intensity_flip',
'animation_intensity_fold',
'animation_intensity_roll',
);
$additional_options['animation_style'] = array(
'label' => $i18n['animation']['style']['label'],
'description' => $i18n['animation']['style']['description'],
'type' => 'select_animation',
'option_category' => 'configuration',
'default' => 'none',
'options' => array(
'none' => et_builder_i18n( 'None' ),
'fade' => $i18n['animation']['style']['options']['fade'],
'slide' => $i18n['animation']['style']['options']['slide'],
'bounce' => $i18n['animation']['style']['options']['bounce'],
'zoom' => $i18n['animation']['style']['options']['zoom'],
'flip' => $i18n['animation']['style']['options']['flip'],
'fold' => $i18n['animation']['style']['options']['fold'],
'roll' => $i18n['animation']['style']['options']['roll'],
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'affects' => array_merge(
array(
'animation_repeat',
'animation_direction',
'animation_duration',
'animation_delay',
'animation_starting_opacity',
'animation_speed_curve',
),
$animations_intensity_fields
),
);
$additional_options['animation_direction'] = array(
'label' => $i18n['animation']['direction']['label'],
'description' => $i18n['animation']['direction']['description'],
'type' => 'select',
'option_category' => 'configuration',
'default' => 'center',
'options' => array(
'center' => et_builder_i18n( 'Center' ),
'left' => et_builder_i18n( 'Right' ),
'right' => et_builder_i18n( 'Left' ),
'bottom' => et_builder_i18n( 'Up' ),
'top' => et_builder_i18n( 'Down' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'depends_show_if_not' => array( 'none', 'fade' ),
'mobile_options' => true,
);
$additional_options['animation_duration'] = array(
'label' => $i18n['animation']['duration']['label'],
'description' => $i18n['animation']['duration']['description'],
'type' => 'range',
'option_category' => 'configuration',
'range_settings' => array(
'min' => 0,
'max' => 2000,
'step' => 50,
),
'default' => '1000ms',
'validate_unit' => true,
'fixed_unit' => 'ms',
'fixed_range' => true,
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'depends_show_if_not' => 'none',
'reset_animation' => true,
'mobile_options' => true,
);
$additional_options['animation_delay'] = array(
'label' => $i18n['animation']['delay']['label'],
'description' => $i18n['animation']['delay']['description'],
'type' => 'range',
'option_category' => 'configuration',
'range_settings' => array(
'min' => 0,
'max' => 3000,
'step' => 50,
),
'default' => '0ms',
'validate_unit' => true,
'fixed_unit' => 'ms',
'fixed_range' => true,
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'depends_show_if_not' => 'none',
'reset_animation' => true,
'mobile_options' => true,
);
foreach ( $animations_intensity_fields as $animations_intensity_field ) {
$animation_style = str_replace( 'animation_intensity_', '', $animations_intensity_field );
$additional_options[ $animations_intensity_field ] = array(
'label' => $i18n['animation']['intensity']['label'],
'description' => $i18n['animation']['intensity']['description'],
'type' => 'range',
'option_category' => 'configuration',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
),
'default' => '50%',
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'depends_show_if' => $animation_style,
'reset_animation' => true,
'mobile_options' => true,
);
}
$additional_options['animation_starting_opacity'] = array(
'label' => $i18n['animation']['opacity']['label'],
'description' => $i18n['animation']['opacity']['description'],
'type' => 'range',
'option_category' => 'configuration',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
'min_limit' => 0,
'max_limit' => 100,
),
'default' => '0%',
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'depends_show_if_not' => 'none',
'reset_animation' => true,
'mobile_options' => true,
);
$additional_options['animation_speed_curve'] = array(
'label' => $i18n['animation']['speed']['label'],
'description' => $i18n['animation']['speed']['description'],
'type' => 'select',
'option_category' => 'configuration',
'default' => 'ease-in-out',
'options' => array(
'ease-in-out' => et_builder_i18n( 'Ease-In-Out' ),
'ease' => et_builder_i18n( 'Ease' ),
'ease-in' => et_builder_i18n( 'Ease-In' ),
'ease-out' => et_builder_i18n( 'Ease-Out' ),
'linear' => et_builder_i18n( 'Linear' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'depends_show_if_not' => 'none',
'mobile_options' => true,
);
$additional_options['animation_repeat'] = array(
'label' => $i18n['animation']['repeat']['label'],
'description' => $i18n['animation']['repeat']['description'],
'type' => 'select',
'option_category' => 'configuration',
'default' => 'once',
'options' => array(
'once' => $i18n['animation']['repeat']['options']['once'],
'loop' => $i18n['animation']['repeat']['options']['loop'],
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'depends_show_if_not' => 'none',
'mobile_options' => true,
);
if ( isset( $this->slug ) && in_array( $this->slug, array( 'et_pb_menu', 'et_pb_fullwidth_menu' ), true ) ) {
$additional_options['dropdown_menu_animation'] = array(
'label' => $i18n['animation']['menu']['label'],
'description' => $i18n['animation']['menu']['description'],
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'fade' => et_builder_i18n( 'Fade' ),
'expand' => et_builder_i18n( 'Expand' ),
'slide' => et_builder_i18n( 'Slide' ),
'flip' => et_builder_i18n( 'Flip' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'default' => 'fade',
);
}
// Move existing "Animation" section fields under the new animations UI.
if ( isset( $this->slug ) && 'et_pb_fullwidth_portfolio' === $this->slug ) {
$additional_options['auto'] = array(
'label' => esc_html__( 'Automatic Carousel Rotation', 'et_builder' ),
'description' => esc_html__( 'If you the carousel layout option is chosen and you would like the carousel to slide automatically, without the visitor having to click the next button, enable this option and then adjust the rotation speed below if desired.', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'affects' => array(
'auto_speed',
),
'depends_show_if' => 'on',
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'default' => 'off',
);
$additional_options['auto_speed'] = array(
'label' => esc_html__( 'Automatic Carousel Rotation Speed (in ms)', 'et_builder' ),
'type' => 'text',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( "Here you can designate how fast the carousel rotates, if 'Automatic Carousel Rotation' option is enabled above. The higher the number the longer the pause between each rotation. (Ex. 1000 = 1 sec)", 'et_builder' ),
'default' => '7000',
);
}
if ( isset( $this->slug ) && 'et_pb_fullwidth_slider' === $this->slug ) {
$additional_options['auto'] = array(
'label' => esc_html__( 'Automatic Animation', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'affects' => array(
'auto_speed',
'auto_ignore_hover',
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'If you would like the slider to slide automatically, without the visitor having to click the next button, enable this option and then adjust the rotation speed below if desired.', 'et_builder' ),
'default' => 'off',
);
$additional_options['auto_speed'] = array(
'label' => esc_html__( 'Automatic Animation Speed (in ms)', 'et_builder' ),
'type' => 'text',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( "Here you can designate how fast the slider fades between each slide, if 'Automatic Animation' option is enabled above. The higher the number the longer the pause between each rotation.", 'et_builder' ),
'default' => '7000',
);
$additional_options['auto_ignore_hover'] = array(
'label' => esc_html__( 'Continue Automatic Slide on Hover', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'Turning this on will allow automatic sliding to continue on mouse hover.', 'et_builder' ),
'default' => 'off',
);
}
if ( isset( $this->slug ) && 'et_pb_fullwidth_post_slider' === $this->slug ) {
$additional_options['auto'] = array(
'label' => esc_html__( 'Automatic Animation', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'affects' => array(
'auto_speed',
'auto_ignore_hover',
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'If you would like the slider to slide automatically, without the visitor having to click the next button, enable this option and then adjust the rotation speed below if desired.', 'et_builder' ),
'default' => 'off',
);
$additional_options['auto_speed'] = array(
'label' => esc_html__( 'Automatic Animation Speed (in ms)', 'et_builder' ),
'type' => 'text',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( "Here you can designate how fast the slider fades between each slide, if 'Automatic Animation' option is enabled above. The higher the number the longer the pause between each rotation.", 'et_builder' ),
'default' => '7000',
);
$additional_options['auto_ignore_hover'] = array(
'label' => esc_html__( 'Continue Automatic Slide on Hover', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'Turning this on will allow automatic sliding to continue on mouse hover.', 'et_builder' ),
'default' => 'off',
);
}
if ( isset( $this->slug ) && in_array( $this->slug, array( 'et_pb_gallery', 'et_pb_wc_images', 'et_pb_wc_gallery' ), true ) ) {
$additional_options['auto'] = array(
'label' => esc_html__( 'Automatic Animation', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'affects' => array(
'auto_speed',
),
'depends_show_if' => 'on',
'depends_on' => array(
'fullwidth',
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'If you would like the slider to slide automatically, without the visitor having to click the next button, enable this option and then adjust the rotation speed below if desired.', 'et_builder' ),
'default' => 'off',
);
$additional_options['auto_speed'] = array(
'label' => esc_html__( 'Automatic Animation Speed (in ms)', 'et_builder' ),
'type' => 'text',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( "Here you can designate how fast the slider fades between each slide, if 'Automatic Animation' option is enabled above. The higher the number the longer the pause between each rotation.", 'et_builder' ),
'default' => '7000',
);
}
if ( isset( $this->slug ) && 'et_pb_blurb' === $this->slug ) {
$additional_options['animation'] = array(
'label' => esc_html__( 'Image/Icon Animation', 'et_builder' ),
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'top' => esc_html__( 'Top To Bottom', 'et_builder' ),
'left' => esc_html__( 'Left To Right', 'et_builder' ),
'right' => esc_html__( 'Right To Left', 'et_builder' ),
'bottom' => esc_html__( 'Bottom To Top', 'et_builder' ),
'off' => esc_html__( 'No Animation', 'et_builder' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'This controls the direction of the lazy-loading animation.', 'et_builder' ),
'default' => 'top',
'mobile_options' => true,
);
}
if ( isset( $this->slug ) && 'et_pb_slider' === $this->slug ) {
$additional_options['auto'] = array(
'label' => esc_html__( 'Automatic Animation', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'affects' => array(
'auto_speed',
'auto_ignore_hover',
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'If you would like the slider to slide automatically, without the visitor having to click the next button, enable this option and then adjust the rotation speed below if desired.', 'et_builder' ),
'default' => 'off',
);
$additional_options['auto_speed'] = array(
'label' => esc_html__( 'Automatic Animation Speed (in ms)', 'et_builder' ),
'type' => 'text',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( "Here you can designate how fast the slider fades between each slide, if 'Automatic Animation' option is enabled above. The higher the number the longer the pause between each rotation.", 'et_builder' ),
'default' => '7000',
);
$additional_options['auto_ignore_hover'] = array(
'label' => esc_html__( 'Continue Automatic Slide on Hover', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'Turning this on will allow automatic sliding to continue on mouse hover.', 'et_builder' ),
'default' => 'off',
);
}
if ( isset( $this->slug ) && 'et_pb_post_slider' === $this->slug ) {
$additional_options['auto'] = array(
'label' => esc_html__( 'Automatic Animation', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'affects' => array(
'auto_speed',
'auto_ignore_hover',
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'If you would like the slider to slide automatically, without the visitor having to click the next button, enable this option and then adjust the rotation speed below if desired.', 'et_builder' ),
'default' => 'off',
);
$additional_options['auto_speed'] = array(
'label' => esc_html__( 'Automatic Animation Speed (in ms)', 'et_builder' ),
'type' => 'text',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( "Here you can designate how fast the slider fades between each slide, if 'Automatic Animation' option is enabled above. The higher the number the longer the pause between each rotation.", 'et_builder' ),
'default' => '7000',
);
$additional_options['auto_ignore_hover'] = array(
'label' => esc_html__( 'Continue Automatic Slide on Hover', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'options' => array(
'off' => et_builder_i18n( 'Off' ),
'on' => et_builder_i18n( 'On' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'Turning this on will allow automatic sliding to continue on mouse hover.', 'et_builder' ),
'default' => 'off',
);
}
if ( isset( $this->slug ) && 'et_pb_team_member' === $this->slug ) {
$additional_options['animation'] = array(
'label' => esc_html__( 'Image Animation', 'et_builder' ),
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'off' => esc_html__( 'No Animation', 'et_builder' ),
'fade_in' => esc_html__( 'Fade In', 'et_builder' ),
'left' => esc_html__( 'Left To Right', 'et_builder' ),
'right' => esc_html__( 'Right To Left', 'et_builder' ),
'top' => esc_html__( 'Top To Bottom', 'et_builder' ),
'bottom' => esc_html__( 'Bottom To Top', 'et_builder' ),
),
'tab_slug' => 'advanced',
'toggle_slug' => 'animation',
'description' => esc_html__( 'This controls the direction of the lazy-loading animation.', 'et_builder' ),
'default' => 'off',
);
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add additional transition fields. e.x hover transition fields.
*/
private function _add_additional_transition_fields() {
$i18n =& self::$i18n;
if ( ! isset( $i18n['transition'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['transition'] = array(
'toggle' => array(
'title' => esc_html__( 'Transitions', 'et_builder' ),
),
'duration' => array(
'label' => esc_html__( 'Transition Duration', 'et_builder' ),
'description' => esc_html__( 'This controls the transition duration of the hover animation.', 'et_builder' ),
),
'delay' => array(
'label' => esc_html__( 'Transition Delay', 'et_builder' ),
'description' => esc_html__( 'This controls the transition delay of the hover animation.', 'et_builder' ),
),
'curve' => array(
'label' => esc_html__( 'Transition Speed Curve', 'et_builder' ),
'description' => esc_html__( 'This controls the transition speed curve of the hover animation.', 'et_builder' ),
),
);
// phpcs:enable
}
$this->settings_modal_toggles['custom_css']['toggles']['hover_transitions'] = array(
'title' => $i18n['transition']['toggle']['title'],
'priority' => 120,
);
$additional_options = array();
$additional_options['hover_transition_duration'] = array(
'label' => $i18n['transition']['duration']['label'],
'description' => $i18n['transition']['duration']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 2000,
'step' => 50,
),
'default' => '300ms',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => 'ms',
'fixed_range' => true,
'tab_slug' => 'custom_css',
'toggle_slug' => 'hover_transitions',
'depends_default' => null,
'mobile_options' => true,
);
$additional_options['hover_transition_delay'] = array(
'label' => $i18n['transition']['delay']['label'],
'description' => $i18n['transition']['delay']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 300,
'step' => 50,
),
'default' => '0ms',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => 'ms',
'fixed_range' => true,
'tab_slug' => 'custom_css',
'toggle_slug' => 'hover_transitions',
'depends_default' => null,
'mobile_options' => true,
);
$additional_options['hover_transition_speed_curve'] = array(
'label' => $i18n['transition']['curve']['label'],
'description' => $i18n['transition']['curve']['description'],
'type' => 'select',
'option_category' => 'layout',
'default' => 'ease',
'default_on_child' => true,
'options' => array(
'ease-in-out' => et_builder_i18n( 'Ease-In-Out' ),
'ease' => et_builder_i18n( 'Ease' ),
'ease-in' => et_builder_i18n( 'Ease-In' ),
'ease-out' => et_builder_i18n( 'Ease-Out' ),
'linear' => et_builder_i18n( 'Linear' ),
),
'tab_slug' => 'custom_css',
'toggle_slug' => 'hover_transitions',
'depends_default' => null,
'mobile_options' => true,
);
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add CSS position controls affects top,right,bottom,left,position and transform translate CSS properties.
*
* @return void
* @since 4.2
*/
private function _add_position_fields() {
/** Position field class instance. @var $class ET_Builder_Module_Field_Position */
$class = ET_Builder_Module_Fields_Factory::get( 'Position' );
$this->advanced_fields[ $class::TOGGLE_SLUG ] = self::$_->array_get( $this->advanced_fields, $class::TOGGLE_SLUG, array() );
$this->advanced_fields['z_index'] = self::$_->array_get( $this->advanced_fields, 'z_index', array() );
// Position and Z Index Disabled.
if ( ! is_array( $this->advanced_fields[ $class::TOGGLE_SLUG ] ) && ! is_array( $this->advanced_fields['z_index'] ) ) {
return;
}
$this->settings_modal_toggles[ $class::TAB_SLUG ]['toggles'][ $class::TOGGLE_SLUG ] = array(
'title' => et_builder_i18n( 'Position' ),
'priority' => 190,
);
$default_position = self::$_->array_get( $this->advanced_fields[ $class::TOGGLE_SLUG ], 'default', 'none' );
$default_z_index = self::$_->array_get( $this->advanced_fields['z_index'], 'default', '' );
$args = array(
'defaults' => array(
'positioning' => $default_position, // none | relative | absolute | fixed.
'position_origin' => 'top_left',
'vertical_offset' => '',
'horizontal_offset' => '',
'z_index' => $default_z_index,
),
'hide_position_fields' => false === $this->advanced_fields[ $class::TOGGLE_SLUG ],
'hide_z_index_fields' => false === $this->advanced_fields['z_index'],
);
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $class->get_fields( $args ) );
}
/**
* Add CSS filter controls (i.e. saturation, brightness, opacity) to the `_additional_fields_options` array.
*
* @since 3.23 Introduce responsive settings on all animation options. Add allowed CSS unit for
* Blur option.
*
* @return void
*/
protected function _add_filter_fields() {
// Filter fields are added by default if module has partial or full VB support.
if ( $this->has_vb_support() ) {
$this->advanced_fields['filters'] = self::$_->array_get( $this->advanced_fields, 'filters', array() );
} elseif ( ! $this->has_advanced_fields ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
return;
}
// Module has to explicitly set false to disable filters options.
if ( false === self::$_->array_get( $this->advanced_fields, 'filters', false ) ) {
return;
}
$i18n =& self::$i18n;
if ( ! isset( $i18n['filter'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['filter'] = array(
'toggle' => array(
'title' => esc_html__( 'Filters', 'et_builder' ),
),
'hue' => array(
'description' => esc_html__( 'Shift all colors by this amount.', 'et_builder' ),
),
'saturate' => array(
'description' => esc_html__( 'Define how intense the color saturation should be.', 'et_builder' ),
),
'brightness' => array(
'label' => esc_html__( 'Brightness', 'et_builder' ),
'description' => esc_html__( 'Define how bright the colors should be.', 'et_builder' ),
),
'contrast' => array(
'label' => esc_html__( 'Contrast', 'et_builder' ),
'description' => esc_html__( 'Define how distinct bright and dark areas should be.', 'et_builder' ),
),
'invert' => array(
'label' => esc_html__( 'Invert', 'et_builder' ),
'description' => esc_html__( 'Invert the hue, saturation, and brightness by this amount.', 'et_builder' ),
),
'sepia' => array(
'label' => esc_html__( 'Sepia', 'et_builder' ),
'description' => esc_html__( 'Travel back in time by this amount.', 'et_builder' ),
),
'opacity' => array(
'label' => esc_html__( 'Opacity', 'et_builder' ),
'description' => esc_html__( 'Define how transparent or opaque this should be.', 'et_builder' ),
),
'blur' => array(
'description' => esc_html__( 'Blur by this amount.', 'et_builder' ),
),
'blend' => array(
'label' => esc_html__( 'Blend Mode', 'et_builder' ),
'description' => esc_html__( 'Modify how this element blends with any layers beneath it. To reset, choose the "Normal" option.', 'et_builder' ),
),
);
// phpcs:enable
}
$filter_settings = self::$_->array_get( $this->advanced_fields, 'filters' );
$tab_slug = self::$_->array_get( $filter_settings, 'tab_slug', 'advanced' );
$toggle_slug = self::$_->array_get( $filter_settings, 'toggle_slug', 'filters' );
$toggle_name = self::$_->array_get( $filter_settings, 'toggle_name', $i18n['filter']['toggle']['title'] );
$modal_toggles = array(
$toggle_slug => array(
'title' => $toggle_name,
'priority' => 105,
),
);
$this->_add_settings_modal_toggles( $tab_slug, $modal_toggles );
$additional_options = array();
$additional_options['filter_hue_rotate'] = array(
'label' => et_builder_i18n( 'Hue' ),
'description' => $i18n['filter']['hue']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 359,
'step' => 1,
),
'default' => '0deg',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => 'deg',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['filter_saturate'] = array(
'label' => et_builder_i18n( 'Saturation' ),
'description' => $i18n['filter']['saturate']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 200,
'step' => 1,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['filter_brightness'] = array(
'label' => $i18n['filter']['brightness']['label'],
'description' => $i18n['filter']['brightness']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 200,
'step' => 1,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['filter_contrast'] = array(
'label' => $i18n['filter']['contrast']['label'],
'description' => $i18n['filter']['contrast']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 200,
'step' => 1,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['filter_invert'] = array(
'label' => $i18n['filter']['invert']['label'],
'description' => $i18n['filter']['invert']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
),
'default' => '0%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['filter_sepia'] = array(
'label' => $i18n['filter']['sepia']['label'],
'description' => $i18n['filter']['sepia']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
),
'default' => '0%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['filter_opacity'] = array(
'label' => $i18n['filter']['opacity']['label'],
'description' => $i18n['filter']['opacity']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
'min_limit' => 0,
'max_limit' => 100,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['filter_blur'] = array(
'label' => et_builder_i18n( 'Blur' ),
'description' => $i18n['filter']['blur']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 50,
'step' => 1,
),
'default' => '0px',
'default_unit' => 'px',
'default_on_child' => true,
'validate_unit' => true,
'allowed_units' => array( 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'default_unit' => 'px',
'fixed_range' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
$additional_options['mix_blend_mode'] = array(
'label' => $i18n['filter']['blend']['label'],
'description' => $i18n['filter']['blend']['description'],
'type' => 'select',
'option_category' => 'layout',
'default' => 'normal',
'default_on_child' => true,
'options' => array(
'normal' => et_builder_i18n( 'Normal' ),
'multiply' => et_builder_i18n( 'Multiply' ),
'screen' => et_builder_i18n( 'Screen' ),
'overlay' => et_builder_i18n( 'Overlay' ),
'darken' => et_builder_i18n( 'Darken' ),
'lighten' => et_builder_i18n( 'Lighten' ),
'color-dodge' => et_builder_i18n( 'Color Dodge' ),
'color-burn' => et_builder_i18n( 'Color Burn' ),
'hard-light' => et_builder_i18n( 'Hard Light' ),
'soft-light' => et_builder_i18n( 'Soft Light' ),
'difference' => et_builder_i18n( 'Difference' ),
'exclusion' => et_builder_i18n( 'Exclusion' ),
'hue' => et_builder_i18n( 'Hue' ),
'saturation' => et_builder_i18n( 'Saturation' ),
'color' => et_builder_i18n( 'Color' ),
'luminosity' => et_builder_i18n( 'Luminosity' ),
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'reset_animation' => false,
'mobile_options' => true,
);
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
// Maybe add child filters (i.e. targeting only images within a module).
if ( ! isset( $this->advanced_fields['filters']['child_filters_target'] ) ) {
return;
}
$child_filter = $this->advanced_fields['filters']['child_filters_target'];
// Allow to modify child filter options label. Default is Image.
$child_filter_label = isset( $child_filter['label'] ) ? $child_filter['label'] : et_builder_i18n( 'Image' );
$additional_child_options = array(
'child_filter_hue_rotate' => array(
'label' => $child_filter_label . ' ' . et_builder_i18n( 'Hue' ),
'description' => $i18n['filter']['hue']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 359,
'step' => 1,
),
'default' => '0deg',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => 'deg',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_filter_saturate' => array(
'label' => $child_filter_label . ' ' . et_builder_i18n( 'Saturation' ),
'description' => $i18n['filter']['saturate']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 200,
'step' => 1,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_filter_brightness' => array(
'label' => $child_filter_label . ' ' . $i18n['filter']['brightness']['label'],
'description' => $i18n['filter']['brightness']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 200,
'step' => 1,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_filter_contrast' => array(
'label' => $child_filter_label . ' ' . $i18n['filter']['contrast']['label'],
'description' => $i18n['filter']['contrast']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 200,
'step' => 1,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_filter_invert' => array(
'label' => $child_filter_label . ' ' . $i18n['filter']['invert']['label'],
'description' => $i18n['filter']['invert']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
),
'default' => '0%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_filter_sepia' => array(
'label' => $child_filter_label . ' ' . $i18n['filter']['sepia']['label'],
'description' => $i18n['filter']['sepia']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
),
'default' => '0%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_filter_opacity' => array(
'label' => $child_filter_label . ' ' . $i18n['filter']['opacity']['label'],
'description' => $i18n['filter']['opacity']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
'min_limit' => 0,
'max_limit' => 100,
),
'default' => '100%',
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => '%',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_filter_blur' => array(
'label' => $child_filter_label . ' ' . et_builder_i18n( 'Blur' ),
'description' => $i18n['filter']['blur']['description'],
'type' => 'range',
'option_category' => 'layout',
'range_settings' => array(
'min' => 0,
'max' => 50,
'step' => 1,
),
'default' => '0px',
'default_on_child' => true,
'validate_unit' => true,
'allowed_units' => array( 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pt', 'pc', 'ex', 'vh', 'vw' ),
'default_unit' => 'px',
'fixed_range' => true,
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
'child_mix_blend_mode' => array(
'label' => $child_filter_label . ' ' . $i18n['filter']['blend']['label'],
'description' => $i18n['filter']['blend']['description'],
'type' => 'select',
'option_category' => 'layout',
'default' => 'normal',
'default_on_child' => true,
'options' => array(
'normal' => et_builder_i18n( 'Normal' ),
'multiply' => et_builder_i18n( 'Multiply' ),
'screen' => et_builder_i18n( 'Screen' ),
'overlay' => et_builder_i18n( 'Overlay' ),
'darken' => et_builder_i18n( 'Darken' ),
'lighten' => et_builder_i18n( 'Lighten' ),
'color-dodge' => et_builder_i18n( 'Color Dodge' ),
'color-burn' => et_builder_i18n( 'Color Burn' ),
'hard-light' => et_builder_i18n( 'Hard Light' ),
'soft-light' => et_builder_i18n( 'Soft Light' ),
'difference' => et_builder_i18n( 'Difference' ),
'exclusion' => et_builder_i18n( 'Exclusion' ),
'hue' => et_builder_i18n( 'Hue' ),
'saturation' => et_builder_i18n( 'Saturation' ),
'color' => et_builder_i18n( 'Color' ),
'luminosity' => et_builder_i18n( 'Luminosity' ),
),
'tab_slug' => $child_filter['tab_slug'],
'toggle_slug' => $child_filter['toggle_slug'],
'reset_animation' => false,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => false,
),
);
if ( isset( $child_filter['depends_show_if'] ) ) {
foreach ( $additional_child_options as $option => $value ) {
$additional_child_options[ $option ]['depends_show_if'] = $child_filter['depends_show_if'];
}
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_child_options );
}
/**
* Add the divider options to the additional_fields_options array.
*/
protected function _add_divider_fields() {
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
// Make sure we only add this to sections.
if ( 'et_pb_section' !== $this->slug ) {
return;
}
$tab_slug = 'advanced';
$toggle_slug = 'dividers';
$divider_toggle = array(
$toggle_slug => array(
'title' => esc_html__( 'Dividers', 'et_builder' ),
'priority' => 65,
),
);
// Add the toggle sections.
$this->_add_settings_modal_toggles( $tab_slug, $divider_toggle );
if ( ! isset( $this->advanced_fields['dividers'] ) ) {
$this->advanced_fields['dividers'] = array();
}
$additional_options = ET_Builder_Module_Fields_Factory::get( 'Divider' )->get_fields(
array(
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
)
);
// Return our merged options and toggles.
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Add additional Text Shadow fields to all modules
*/
protected function _add_text_shadow_fields() {
// Get text shadow settings. Fallback to default if needed.
$this->advanced_fields['text_shadow'] = self::$_->array_get(
$this->advanced_fields,
'text_shadow',
array(
'default' => array(),
)
);
// Text shadow settings have to be array.
if ( ! is_array( $this->advanced_fields['text_shadow'] ) ) {
return;
}
// Loop test settings, do multiple text shadow field declaration in one palce.
foreach ( $this->advanced_fields['text_shadow'] as $text_shadow_name => $text_shadow_fields ) {
// Enable module to disable text shadow. Also disable text shadow if no text group is
// found because default text shadow lives on text group.
if ( 'default' === $text_shadow_name && ( false === $text_shadow_fields || empty( $this->settings_modal_toggles['advanced']['toggles']['text'] ) ) ) {
return;
}
if ( 'default' !== $text_shadow_name ) {
// Automatically add prefix and toggle slug.
$text_shadow_fields['prefix'] = $text_shadow_name;
$text_shadow_fields['toggle_slug'] = $text_shadow_name;
}
// Add text shadow fields.
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
$this->text_shadow->get_fields( $text_shadow_fields )
);
}
}
/**
* Add box shadow fields based on configuration on $this->advanced_fields['box_shadow']
*
* @since 3.1
*/
protected function _add_box_shadow_fields() {
// BOX shadow fields are added by default to all modules.
$this->advanced_fields['box_shadow'] = self::$_->array_get(
$this->advanced_fields,
'box_shadow',
array(
'default' => array(),
)
);
// Box shadow settings have to be array.
if ( ! is_array( $this->advanced_fields['box_shadow'] ) ) {
return;
}
$i18n =& self::$i18n;
if ( ! isset( $i18n['box_shadow'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['box_shadow'] = array(
'title' => esc_html__( 'Box Shadow', 'et_builder' ),
);
// phpcs:enable
}
// Loop box shadow settings.
foreach ( $this->advanced_fields['box_shadow'] as $fields_name => $settings ) {
// Enable module to disable box shadow.
if ( false === $settings ) {
continue;
}
$is_box_shadow_default = 'default' === $fields_name;
// Add Box Shadow toggle for default Box Shadow fields.
if ( $is_box_shadow_default ) {
$this->settings_modal_toggles['advanced']['toggles']['box_shadow'] = array(
'title' => $i18n['box_shadow']['title'],
'priority' => 100,
);
}
// Ensure box settings has minimum settings required.
$default_settings = array(
'option_category' => 'layout',
'tab_slug' => 'advanced',
'toggle_slug' => 'box_shadow',
);
$settings = wp_parse_args( $settings, $default_settings );
// Automatically add suffix attribute.
$settings['suffix'] = $is_box_shadow_default ? '' : "_{$fields_name}";
// Add default Box Shadow fields.
$this->_additional_fields_options = array_merge(
$this->_additional_fields_options,
ET_Builder_Module_Fields_Factory::get( 'BoxShadow' )->get_fields( $settings )
);
}
}
/**
* Add form field fields based on configuration on $this->advanced_fields['field'].
*
* @since 3.23
*/
protected function _add_form_field_fields() {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_advanced_fields ) {
return;
}
// Form field settings have to be an array.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'form_field' ) ) ) {
return;
}
$additional_options = array();
$hover = et_pb_hover_options();
$this->set_i18n_font();
$i18n =& self::$i18n;
// Fetch the form field.
foreach ( $this->advanced_fields['form_field'] as $option_name => $option_settings ) {
$toggle_slug = '';
$tab_slug = isset( $option_settings['tab_slug'] ) ? $option_settings['tab_slug'] : 'advanced';
$toggle_disabled = isset( $option_settings['disable_toggle'] ) && $option_settings['disable_toggle'];
// Add form field options group if it's enabled.
if ( ! $toggle_disabled ) {
$toggle_slug = isset( $option_settings['toggle_slug'] ) ? $option_settings['toggle_slug'] : $option_name;
$toggle_priority = isset( $option_settings['toggle_priority'] ) ? $option_settings['toggle_priority'] : 20;
$field_toggle = array(
$option_name => array(
'title' => esc_html( $option_settings['label'] ),
'priority' => $toggle_priority,
),
);
$this->_add_settings_modal_toggles( $tab_slug, $field_toggle );
}
// Background Color.
$bg_color_options = isset( $option_settings['background_color'] ) ? $option_settings['background_color'] : true;
if ( $bg_color_options ) {
$bg_color_args = is_array( $bg_color_options ) ? $bg_color_options : array();
$additional_options[ "{$option_name}_background_color" ] = array_merge(
array(
'label' => sprintf( esc_html__( '%1$s Background Color', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'Pick a color to fill the module\'s input fields.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'field',
'custom_color' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
),
$bg_color_args
);
}
// Text Color.
$additional_options[ "{$option_name}_text_color" ] = array(
'label' => sprintf( $i18n['font']['color']['label'], $option_settings['label'] ),
'description' => esc_html__( 'Pick a color to be used for the text written inside input fields.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'field',
'custom_color' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
// Focus Background Color.
$additional_options[ "{$option_name}_focus_background_color" ] = array(
'label' => sprintf( esc_html__( '%1$s Focus Background Color', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'When a visitor clicks into an input field, it becomes focused. You can pick a color to be used for the input field background while focused.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'field',
'custom_color' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
// Focus Text Color.
$additional_options[ "{$option_name}_focus_text_color" ] = array(
'label' => sprintf( esc_html__( '%1$s Focus Text Color', 'et_builder' ), $option_settings['label'] ),
'description' => esc_html__( 'When a visitor clicks into an input field, it becomes focused. You can pick a color to be used for the input text while focused.', 'et_builder' ),
'type' => 'color-alpha',
'option_category' => 'field',
'custom_color' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'hover' => 'tabs',
'mobile_options' => true,
'sticky' => true,
);
// Font - Add current font settings into advanced fields. The font_field is basically
// combination of fonts (options group) + fields (type), but plural suffix is removed
// because there are some case we just need one field declaration for child module.
$font_options = isset( $option_settings['font_field'] ) ? $option_settings['font_field'] : true;
if ( $font_options ) {
$font_args = is_array( $font_options ) ? $font_options : array();
$font_settings = array_merge(
array(
'label' => esc_html( $option_settings['label'] ),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
// Text color will be handled by form field function.
'hide_text_color' => true,
),
$font_args
);
self::$_->array_set( $this->advanced_fields, "fonts.{$option_name}", $font_settings );
}
// Add custom margin-padding to form field options.
$margin_padding_options = isset( $option_settings['margin_padding'] ) ? $option_settings['margin_padding'] : true;
if ( $margin_padding_options ) {
$margin_padding_args = is_array( $margin_padding_options ) ? $margin_padding_options : array();
$margin_padding_settings = array_merge(
array(
'label' => $option_settings['label'],
'prefix' => $option_name,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
),
$margin_padding_args
);
$additional_options = array_merge( $additional_options, $this->margin_padding->get_fields( $margin_padding_settings ) );
}
// Border Styles - Ensure borders attribute is exist in advanced fields. If it's not,
// add borders property and set empty default.
$borders_options = isset( $option_settings['border_styles'] ) ? $option_settings['border_styles'] : true;
if ( $borders_options ) {
if ( ! isset( $this->advanced_fields['borders'] ) ) {
self::$_->array_set( $this->advanced_fields, 'borders.default', array() );
}
// Border Styles - Add current borders settings into advanced fields.
$border_style_options = self::$_->array_get( $option_settings, "border_styles.{$option_name}", array() );
$border_style_name = ! empty( $border_style_options['name'] ) ? $border_style_options['name'] : $option_name;
$border_style_settings = array_merge(
array(
'option_category' => 'field',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'defaults' => array(
'border_radii' => 'on|3px|3px|3px|3px',
'border_styles' => array(
'width' => '0px',
'color' => '#333333',
'style' => 'solid',
),
),
'fields_after' => array(
'use_focus_border_color' => array(
'label' => esc_html__( 'Use Focus Borders', 'et_builder' ),
'description' => esc_html__( 'Enabling this option will add borders to input fields when focused.', 'et_builder' ),
'type' => 'yes_no_button',
'option_category' => 'color_option',
'options' => array(
'off' => et_builder_i18n( 'No' ),
'on' => et_builder_i18n( 'Yes' ),
),
'affects' => array(
"border_radii_{$toggle_slug}_focus",
"border_styles_{$toggle_slug}_focus",
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'default_on_front' => 'off',
),
),
),
$border_style_options
);
self::$_->array_set( $this->advanced_fields, "borders.{$border_style_name}", $border_style_settings );
// Border Styles Focus - Add current borders focus settings into advanced fields.
$border_style_focus_options = self::$_->array_get( $option_settings, "border_styles.{$option_name}_focus", array() );
$border_style_focus_settings = array_merge(
array(
'option_category' => 'field',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'depends_on' => array( 'use_focus_border_color' ),
'depends_show_if' => 'on',
'defaults' => array(
'border_radii' => 'on|3px|3px|3px|3px',
'border_styles' => array(
'width' => '0px',
'color' => '#333333',
'style' => 'solid',
),
),
),
$border_style_focus_options
);
self::$_->array_set( $this->advanced_fields, "borders.{$border_style_name}_focus", $border_style_focus_settings );
}
// Box Shadow - Ensure box shadow attribute is exist in advanced fields. If it's not,
// add box_shadow property and set empty default.
$box_shadow_options = isset( $option_settings['box_shadow'] ) ? $option_settings['box_shadow'] : true;
if ( $box_shadow_options ) {
if ( ! isset( $this->advanced_fields['box_shadow'] ) ) {
self::$_->array_set( $this->advanced_fields, 'box_shadow.default', array() );
}
$box_shadow_args = is_array( $box_shadow_options ) ? $box_shadow_options : array();
$box_shadow_name = ! empty( $box_shadow_options['name'] ) ? $box_shadow_options['name'] : $option_name;
// Box Shadow - Add current box shadow settings into advanced fields.
$box_shadow_settings = array_merge(
array(
'label' => sprintf( esc_html__( '%1$s Box Shadow', 'et_builder' ), $option_settings['label'] ),
'option_category' => 'layout',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
),
$box_shadow_args
);
self::$_->array_set( $this->advanced_fields, "box_shadow.{$box_shadow_name}", $box_shadow_settings );
}
}
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Get css transition properties for box shadow fields.
*
* @param string|null $module Module slug.
*
* @return array
*/
public function get_transition_box_shadow_fields_css_props( $module = 'default' ) {
/**
* Instance of box shadow field class. @var ET_Builder_Module_Field_BoxShadow $box_shadow
*/
$box_shadow = ET_Builder_Module_Fields_Factory::get( 'BoxShadow' );
$selector = self::$_->array_get( $this->advanced_fields, "box_shadow.$module.css.main", '%%order_class%%' );
$overlay = self::$_->array_get( $this->advanced_fields, "box_shadow.$module.css.overlay", false );
$suffix = 'default' === $module ? '' : "_$module";
if ( in_array( $overlay, array( 'inset', 'always' ), true ) ) {
$selector .= ', ' . $box_shadow->get_overlay_selector( $selector );
}
return array(
"box_shadow_horizontal{$suffix}" => array( 'box-shadow' => $selector ),
"box_shadow_vertical{$suffix}" => array( 'box-shadow' => $selector ),
"box_shadow_blur{$suffix}" => array( 'box-shadow' => $selector ),
"box_shadow_spread{$suffix}" => array( 'box-shadow' => $selector ),
"box_shadow_color{$suffix}" => array( 'box-shadow' => $selector ),
);
}
/**
* Get css transition properties for text shadow fields.
*
* @param string|null $module Module slug.
*
* @return array
*/
public function get_transition_text_shadow_fields_css_props( $module = null ) {
$source = null === $module ? 'text.css' : "fonts.$module.css";
$default = self::$_->array_get( $this->advanced_fields, "$source.main", '%%order_class%%' );
$selector = self::$_->array_get( $this->advanced_fields, "$source.text_shadow", $default );
$prefix = null === $module ? '' : "{$module}_";
return array(
"{$prefix}text_shadow_horizontal_length" => array( 'text-shadow' => $selector ),
"{$prefix}text_shadow_vertical_length" => array( 'text-shadow' => $selector ),
"{$prefix}text_shadow_blur_strength" => array( 'text-shadow' => $selector ),
"{$prefix}text_shadow_color" => array( 'text-shadow' => $selector ),
);
}
/**
* Get css transition properties for filters fields.
*
* @param string|null $module Module slug.
*
* @return array
*/
public function get_transition_filters_fields_css_props( $module = null ) {
$slug = empty( $module ) ? 'filter' : 'child_filter';
$source = empty( $module ) ? 'filters.css.main' : "$module.css.main";
$filters = array( 'hue_rotate', 'saturate', 'brightness', 'contrast', 'invert', 'sepia', 'opacity', 'blur' );
$fields = array();
$main = self::$_->array_get( $this->advanced_fields, $source, '%%order_class%%' );
$selector = $module ? self::$_->array_get( $this->advanced_fields, 'filters.child_filters_target.css.main', $main ) : $main;
foreach ( $filters as $filter ) {
$fields[ "{$slug}_{$filter}" ] = array( 'filter' => $selector );
}
return $fields;
}
/**
* Get css transition properties for borders fields.
*
* @param string|null $module Module slug.
*
* @return array
*/
public function get_transition_borders_fields_css_props( $module = 'default' ) {
$suffix = 'default' === $module ? '' : "_$module";
$radius = self::$_->array_get( $this->advanced_fields, "borders.$module.css.main.border_radii", '%%order_class%%' );
$style = self::$_->array_get( $this->advanced_fields, "borders.$module.css.main.border_styles", '%%order_class%%' );
return array(
"border_radii{$suffix}" => array( 'border-radius' => implode( ', ', array( $radius ) ) ),
"border_width_all{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_color_all{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_width_top{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_color_top{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_width_right{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_color_right{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_width_bottom{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_color_bottom{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_width_left{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
"border_color_left{$suffix}" => array( 'border' => implode( ', ', array( $style ) ) ),
);
}
/**
* Get margin and padding transition css properties.
*
* @param string|null $module Module slug.
*
* @return array
*/
public function get_transition_margin_padding_fields_css_props( $module = null ) {
$key = empty( $module ) ? '' : "$module.";
$suffix = empty( $module ) ? '' : "_$module";
$margin = self::$_->array_get( $this->advanced_fields, "margin_padding.{$key}css.margin", '%%order_class%%' );
$padding = self::$_->array_get( $this->advanced_fields, "margin_padding.{$key}css.padding", '%%order_class%%' );
return array(
"custom_margin{$suffix}" => array( 'margin' => implode( ', ', array( $margin ) ) ),
"custom_padding{$suffix}" => array( 'padding' => implode( ', ', array( $padding ) ) ),
);
}
/**
* Get transform transition css properties.
*
* @param string|null $module Module slug.
*
* @return array
*/
public function get_transition_transform_css_props( $module = null ) {
$key = empty( $module ) ? '' : "$module.";
$suffix = empty( $module ) ? '' : "_$module";
$selector = self::$_->array_get( $this->advanced_fields, "transform.{$key}css.main", '%%order_class%%' );
/** Transform field. @see ET_Builder_Module_Field_Transform */
$defaults = array( 'scale', 'translate', 'rotate', 'skew', 'origin' );
$fields = array();
foreach ( $defaults as $name ) {
$fields += array( "transform_{$name}{$suffix}" => array( 'transform' => implode( ', ', (array) $selector ) ) );
}
return $fields;
}
/**
* Get position transition css properties.
*
* @param string|null $module Module slug.
*
* @return array
*/
public function get_transition_position_css_props( $module = null ) {
$key = empty( $module ) ? '' : "$module.";
$suffix = empty( $module ) ? '' : "_$module";
$selector = self::$_->array_get( $this->advanced_fields, "position_fields.{$key}css.main", '%%order_class%%' );
$string_selector = implode( ', ', (array) $selector );
$fields = array();
$fields += array(
"horizontal_offset{$suffix}" => array(
'left' => $string_selector,
'right' => $string_selector,
),
);
$fields += array(
"vertical_offset{$suffix}" => array(
'top' => $string_selector,
'bottom' => $string_selector,
),
);
return $fields;
}
/**
* Get font transition css properties.
*
* @return array
*/
public function get_transition_font_fields_css_props() {
$items = self::$_->array_get( $this->advanced_fields, 'fonts' );
if ( ! is_array( $items ) ) {
return array();
}
$font_options = array(
array(
'option' => 'text_color',
'slug' => 'color',
'prop' => 'color',
),
array(
'option' => 'font_size',
'slug' => 'font_size',
'prop' => 'font-size',
),
array(
'option' => 'line_height',
'slug' => 'line_height',
'prop' => 'line-height',
),
array(
'option' => 'letter_spacing',
'slug' => 'letter_spacing',
'prop' => 'letter-spacing',
),
array(
'option' => 'text_shadow_horizontal_length',
'slug' => 'text_shadow',
'prop' => 'text-shadow',
),
array(
'option' => 'text_shadow_vertical_length',
'slug' => 'text_shadow',
'prop' => 'text-shadow',
),
array(
'option' => 'text_shadow_blur_strength',
'slug' => 'text_shadow',
'prop' => 'text-shadow',
),
array(
'option' => 'text_shadow_color',
'slug' => 'text_shadow',
'prop' => 'text-shadow',
),
array(
'option' => 'border_weight',
'slug' => 'quote',
'prop' => 'border-width',
),
array(
'option' => 'border_color',
'slug' => 'quote',
'prop' => 'border-color',
),
);
$fields = array();
foreach ( $items as $item => $field ) {
foreach ( $font_options as $key ) {
$default = self::$_->array_get( $field, 'css.main', '%%order_class%%' );
$fields[ "{$item}_{$key['option']}" ] = array( $key['prop'] => self::$_->array_get( $field, "css.{$key['slug']}", $default ) );
}
}
return $fields;
}
/**
* Get height transition css properties.
*
* @param string $prefix The prefix string that may be added to field name.
*
* @return array
*/
public function get_transition_height_fields_css_props( $prefix = '' ) {
$options = self::$_->array_get( $this->advanced_fields, 'height' );
if ( ! is_array( $options ) ) {
return array();
}
$height = et_pb_height_options( $prefix );
$max_height = et_pb_max_height_options( $prefix );
$selector = self::$_->array_get( $options, 'css.main', '%%order_class%%' );
return array(
$height->get_field() => array( 'height' => $selector ),
$max_height->get_field() => array( 'max-height' => $selector ),
);
}
/**
* Get css transition properties for image fields.
*
* @return array
*/
public function get_transition_image_fields_css_props() {
$fields = array();
$fields = array_merge( $this->get_transition_filters_fields_css_props( 'image' ), $fields );
$fields = array_merge( $this->get_transition_borders_fields_css_props( 'image' ), $fields );
$fields = array_merge( $this->get_transition_box_shadow_fields_css_props( 'image' ), $fields );
return $fields;
}
/**
* Get css transition properties for button fields.
* *
*
* @return array
*/
public function get_transition_button_fields_css_props() {
$buttons = self::$_->array_get( $this->advanced_fields, 'button', array() );
$fields = array();
if ( empty( $buttons ) ) {
return array();
}
foreach ( $buttons as $key => $button ) {
$selector = self::$_->array_get( $button, 'css.main', '%%order_class%%' );
$box_shadow_style = array(
$selector,
$this->add_suffix_to_selectors( ' > .box-shadow-overlay', $selector ),
);
$field = array(
"{$key}_text_color" => array( 'color' => $selector ),
"{$key}_text_size" => array(
'font-size' => $selector,
'line-height' => $selector,
'padding' => $selector,
),
"{$key}_bg_color" => array( 'background-color' => $selector ),
"{$key}_border_width" => array( 'border' => $selector ),
"{$key}_border_color" => array( 'border' => $selector ),
"{$key}_border_radius" => array( 'border-radius' => $selector ),
"{$key}_letter_spacing" => array( 'letter-spacing' => $selector ),
"{$key}text_shadow_horizontal_length" => array( 'text-shadow' => $selector ),
"{$key}text_shadow_vertical_length" => array( 'text-shadow' => $selector ),
"{$key}text_shadow_blur_strength" => array( 'text-shadow' => $selector ),
"{$key}text_shadow_color" => array( 'text-shadow' => $selector ),
"box_shadow_style_$key" => array( 'box-shadow' => implode( ', ', $box_shadow_style ) ),
);
$fields = array_merge( $fields, $field );
}
return $fields;
}
/**
* Get transition form field CSS props.
*
* @since 3.23
*
* @return array Selector for each fields.
*/
public function get_transition_form_field_fields_css_props() {
$fields_input = self::$_->array_get( $this->advanced_fields, 'form_field', array() );
$fields = array();
// Ensure fields input is exist.
if ( empty( $fields_input ) ) {
return array();
}
foreach ( $fields_input as $key => $form_field ) {
$selector = self::$_->array_get( $form_field, 'css.main', '%%order_class%% input' );
$placeholders = "$selector::placeholder, $selector::-webkit-input-placeholder, $selector::-moz-placeholder, $selector::-ms-input-placeholder";
// Set all individual fields that need transition during hover event.
$fields = array_merge(
$fields,
array(
"{$key}_background_color" => array( 'background-color' => $selector ),
"{$key}_text_color" => array( 'color' => implode( ', ', array( $placeholders, $selector ) ) ),
"{$key}_focus_background_color" => array( 'background-color' => $selector ),
"{$key}_focus_text_color" => array( 'color' => implode( ', ', array( $placeholders, $selector ) ) ),
"{$key}_custom_margin" => array( 'margin' => $selector ),
"{$key}_custom_padding" => array( 'padding' => $selector ),
)
);
// Merge group fields such as borders, box shadow, and text shadow.
$fields = array_merge(
$fields,
$this->get_transition_borders_fields_css_props( $key ),
$this->get_transition_borders_fields_css_props( "{$key}_focus" ),
$this->get_transition_box_shadow_fields_css_props( $key )
);
}
return $fields;
}
/**
* Get css transition properties for gutter wudth fields.
* *
*
* @return array
*/
public function get_transition_gutter_fields_css_props() {
$gutter_selector = 'et_pb_section' === $this->slug ? '%%order_class%% .et_pb_gutter_hover *' : '%%order_class%%.et_pb_gutter_hover *';
// animate width, padding and margin if gutter width has hover options.
return array(
'gutter_width' => array(
'width' => $gutter_selector,
'margin' => $gutter_selector,
'padding' => $gutter_selector,
),
);
}
/**
* Get CSS fields transition.
*
* @since 3.23 Add form field options group and background image on the fields list.
*/
public function get_transition_fields_css_props() {
$default = $this->main_css_element;
$text_main = self::$_->array_get( $this->advanced_fields, 'text.css.main', $default );
$fields = array(
'background_layout' => array( 'color' => $text_main ),
'background' => array(
'background-color' => self::$_->array_get(
$this->advanced_fields,
'background.css.main',
$default
),
'background-image' => self::$_->array_get(
$this->advanced_fields,
'background.css.main',
$default
),
),
'max_width' => array( 'max-width' => $default ),
'width' => array( 'width' => $default ),
'text_color' => array(
'color' => self::$_->array_get(
$this->advanced_fields,
'text.css.color',
$text_main
),
),
);
$fields = array_merge( $this->get_transition_filters_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_box_shadow_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_text_shadow_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_image_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_borders_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_margin_padding_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_button_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_form_field_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_font_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_gutter_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_height_fields_css_props(), $fields );
$fields = array_merge( $this->get_transition_transform_css_props(), $fields );
$fields = array_merge( $this->get_transition_position_css_props(), $fields );
return apply_filters( 'et_builder_hover_transitions_map', $fields );
}
/**
* Add link options fields to all modules
*
* @since 3.15.1
*/
protected function _add_link_options_fields() {
// Link Options are added by default if module has partial or full VB support.
if ( $this->has_vb_support() ) {
$this->advanced_fields['link_options'] = self::$_->array_get( $this->advanced_fields, 'link_options', array() );
} elseif ( ! $this->has_advanced_fields ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
return;
}
// Set link_options to false to disable Link options.
if ( false === self::$_->array_get( $this->advanced_fields, 'link_options' ) ) {
return;
}
// Link options settings have to be array.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'link_options' ) ) ) {
return;
}
$this->settings_modal_toggles['general']['toggles']['link_options'] = array(
'title' => et_builder_i18n( 'Link' ),
'priority' => 70,
);
$additional_options = array();
$i18n =& self::$i18n;
if ( ! isset( $i18n['link'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['link'] = array(
'url' => array(
'label' => esc_html__( 'Module Link URL', 'et_builder' ),
'description' => esc_html__( 'When clicked the module will link to this URL.', 'et_builder' ),
),
'target' => array(
'label' => esc_html__( 'Module Link Target', 'et_builder' ),
'description' => esc_html__( 'Here you can choose whether or not your link opens in a new window', 'et_builder' ),
'options' => array(
'off' => esc_html__( 'In The Same Window', 'et_builder' ),
'on' => esc_html__( 'In The New Tab', 'et_builder' ),
),
),
);
// phpcs:enable
}
// Translate the whole label as a phrase instead of replacing placeholder with section / row / module translation
// Less error prone for translator and the translation. Phrase might be structured differently in some language.
switch ( $this->slug ) {
case 'et_pb_section':
$url_label = esc_html__( 'Section Link URL', 'et_builder' );
$target_label = esc_html__( 'Section Link Target', 'et_builder' );
break;
case 'et_pb_row':
case 'et_pb_row_inner':
$url_label = esc_html__( 'Row Link URL', 'et_builder' );
$target_label = esc_html__( 'Row Link Target', 'et_builder' );
break;
case 'et_pb_column':
case 'et_pb_column_inner':
$url_label = esc_html__( 'Column Link URL', 'et_builder' );
$target_label = esc_html__( 'Column Link Target', 'et_builder' );
break;
default:
$url_label = $i18n['link']['url']['label'];
$target_label = $i18n['link']['target']['label'];
break;
}
$additional_options['link_option_url'] = array(
'label' => $url_label,
'description' => $i18n['link']['url']['description'],
'type' => 'text',
'option_category' => 'configuration',
'toggle_slug' => 'link_options',
'dynamic_content' => 'url',
);
$additional_options['link_option_url_new_window'] = array(
'label' => $target_label,
'description' => $i18n['link']['target']['description'],
'type' => 'select',
'option_category' => 'configuration',
'options' => array(
'off' => $i18n['link']['target']['options']['off'],
'on' => $i18n['link']['target']['options']['on'],
),
'toggle_slug' => 'link_options',
'default_on_front' => 'off',
);
$this->_additional_fields_options = array_merge( $this->_additional_fields_options, $additional_options );
}
/**
* Get transition style.
*
* @param array $props Transition css properties.
* @param string $device Device.
*
* @since 3.23 Add $device parameter to support responsive settings.
*
* @return string
*/
public function get_transition_style( array $props = array(), $device = 'desktop' ) {
$duration = et_pb_transition_options()->get_duration( $this->props, $device );
$easing = et_pb_transition_options()->get_easing( $this->props, $device );
$delay = et_pb_transition_options()->get_delay( $this->props, $device );
$transition_css = array();
foreach ( $props as $prop ) {
$transition_css[] = sprintf(
'%1$s %2$s %3$s %4$s',
esc_attr( $prop ),
esc_attr( $duration ),
esc_attr( $easing ),
esc_attr( $delay )
);
}
// Sticky module that has custom width for sticky style will need its `left` property to
// be animated as well due to fixed positioning used for sticky state.
if ( $this->is_sticky_module && in_array( 'width', $props, true ) ) {
$transition_css[] = sprintf(
'left %1$s %2$s %3$s',
esc_attr( $duration ),
esc_attr( $easing ),
esc_attr( $delay )
);
}
return 'transition: ' . implode( ', ', $transition_css ) . ';';
}
/**
* Setup hover transitions.
*
* @param string $function_name Function name.
*
* @since 4.6.0 Add sticky style support
*/
public function setup_hover_transitions( $function_name ) {
// List of all property names and their respective CSS property names.
$transitions_map = $this->get_transition_fields_css_props();
$selectors = array();
$transitions = array();
$hover = et_pb_hover_options();
$hover_suffix = $hover->get_suffix();
$hover_enabled_suffix = $hover->get_enabled_suffix();
$sticky = et_pb_sticky_options();
$sticky_suffix = $sticky->get_suffix();
$sticky_enabled_suffix = $sticky->get_enabled_suffix();
// We need to loop transitions array so cases of prefixed prop names can also be caught.
foreach ( $transitions_map as $prop_name => $css_props ) {
$prop_name_hover = "{$prop_name}{$hover_suffix}";
$prop_name_sticky = "{$prop_name}{$sticky_suffix}";
// Background is a special case because it also contains the "background_color" property.
if ( 'background' === $prop_name ) {
// We can continue if hover background color is not set because it is the only animatable property.
if ( ! $hover->get_value( 'background_color', $this->props ) && ! $sticky->get_value( 'background_color', $this->props ) ) {
continue;
}
} elseif ( empty( $this->props[ $prop_name_hover ] ) && empty( $this->props[ $prop_name_sticky ] ) ) {
// Continue if hover or sticky value is empty.
continue;
}
// Continue if sticky / hover option is not enabled.
$is_hover_option_enabled = $hover->is_enabled( $prop_name, $this->props );
$is_sticky_option_enabled = $sticky->is_enabled( $prop_name, $this->props );
$is_sticky_transition_enabled = 'on' === et_()->array_get( $this->props, 'sticky_transition' );
if ( ! $is_hover_option_enabled && ! ( $is_sticky_transition_enabled && $is_sticky_option_enabled ) ) {
continue;
}
// Add the CSS property for the transition.
$transitions = array_merge( $transitions, array_keys( $css_props ) );
foreach ( $css_props as $selector ) {
$selector = is_array( $selector ) ? $selector : array( $selector );
$selectors = array_merge( $selectors, $selector );
}
}
// Don't apply transitions if none are needed.
if ( empty( $transitions ) ) {
return;
}
$transitions = array_unique( $transitions );
$transition_selectors = implode( ', ', array_unique( $selectors ) );
$transition_style = $this->get_transition_style( $transitions );
$el_style = array(
'selector' => $transition_selectors,
'declaration' => esc_html( $transition_style ),
);
self::set_style( $function_name, $el_style );
// Tablet.
$transition_style_tablet = $this->get_transition_style( $transitions, 'tablet' );
if ( $transition_style_tablet !== $transition_style ) {
$el_style = array(
'selector' => $transition_selectors,
'declaration' => esc_html( $transition_style_tablet ),
'media_query' => self::get_media_query( 'max_width_980' ),
);
self::set_style( $function_name, $el_style );
}
// Phone.
$transition_style_phone = $this->get_transition_style( $transitions, 'phone' );
if ( $transition_style_phone !== $transition_style || $transition_style_phone !== $transition_style_tablet ) {
$el_style = array(
'selector' => $transition_selectors,
'declaration' => esc_html( $transition_style_phone ),
'media_query' => self::get_media_query( 'max_width_767' ),
);
self::set_style( $function_name, $el_style );
}
}
/**
* Add custom css fields. e.g before, main_element and after.
*/
protected function _add_custom_css_fields() {
if ( isset( $this->custom_css_tab ) && ! $this->custom_css_tab ) {
return;
}
$custom_css_fields_processed = array();
$current_module_unique_class = '.' . $this->slug . '_' . "<%= typeof( module_order ) !== 'undefined' ? module_order : '<span class=\"et_pb_module_order_placeholder\"></span>' %>";
$main_css_element_output = isset( $this->main_css_element ) ? $this->main_css_element : '%%order_class%%';
$main_css_element_output = str_replace( '%%order_class%%', $current_module_unique_class, $main_css_element_output );
$custom_css_default_options = array(
'before' => array(
'label' => et_builder_i18n( 'Before' ),
'selector' => ':before',
'no_space_before_selector' => true,
),
'main_element' => array(
'label' => et_builder_i18n( 'Main Element' ),
),
'after' => array(
'label' => et_builder_i18n( 'After' ),
'selector' => ':after',
'no_space_before_selector' => true,
),
);
$custom_css_fields = apply_filters( 'et_default_custom_css_fields', $custom_css_default_options );
$this->custom_css_fields = $this->get_custom_css_fields_config();
if ( $this->custom_css_fields ) {
$custom_css_fields = array_merge( $custom_css_fields, $this->custom_css_fields );
}
$this->custom_css_fields = apply_filters( 'et_custom_css_fields_' . $this->slug, $custom_css_fields );
// optional settings names in custom css options.
$additional_option_slugs = array( 'description', 'priority' );
foreach ( $custom_css_fields as $slug => $option ) {
$selector_value = isset( $option['selector'] ) ? $option['selector'] : '';
$selector_contains_module_class = false !== strpos( $selector_value, '%%order_class%%' ) ? true : false;
$selector_output = '' !== $selector_value ? str_replace( '%%order_class%%', $current_module_unique_class, $option['selector'] ) : '';
$custom_css_fields_processed[ "custom_css_{$slug}" ] = array(
'label' => sprintf(
'%1$s:<span>%2$s%3$s%4$s</span>',
$option['label'],
! $selector_contains_module_class ? $main_css_element_output : '',
! isset( $option['no_space_before_selector'] ) && isset( $option['selector'] ) ? ' ' : '',
$selector_output
),
'type' => 'custom_css',
'tab_slug' => 'custom_css',
'toggle_slug' => 'custom_css',
'option_category' => 'layout',
'no_colon' => true,
);
// update toggle slug and option category for $this->custom_css_fields.
$this->custom_css_fields[ $slug ]['toggle_slug'] = 'custom_css';
$this->custom_css_fields[ $slug ]['option_category'] = 'layout';
// add optional settings if needed.
foreach ( $additional_option_slugs as $option_slug ) {
if ( isset( $option[ $option_slug ] ) ) {
$custom_css_fields_processed[ "custom_css_{$slug}" ][ $option_slug ] = $option[ $option_slug ];
}
}
}
if ( ! empty( $custom_css_fields_processed ) ) {
$this->fields_unprocessed = array_merge( $this->fields_unprocessed, $custom_css_fields_processed );
}
$i18n =& self::$i18n;
if ( ! isset( $i18n['css'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['css'] = array(
'classes' => esc_html__( 'CSS ID & Classes', 'et_builder' ),
);
// phpcs:enable
}
$default_custom_css_toggles = array(
'classes' => $i18n['css']['classes'],
'custom_css' => et_builder_i18n( 'Custom CSS' ),
);
$this->_add_settings_modal_toggles( 'custom_css', $default_custom_css_toggles );
}
/**
* Add toggles in settings modal.
*
* @param string $tab_slug Toggle tab slug.
* @param string $toggles_array Toggles.
*/
protected function _add_settings_modal_toggles( $tab_slug, $toggles_array ) {
if ( ! isset( $this->settings_modal_toggles[ $tab_slug ] ) ) {
$this->settings_modal_toggles[ $tab_slug ] = array();
}
if ( ! isset( $this->settings_modal_toggles[ $tab_slug ]['toggles'] ) ) {
$this->settings_modal_toggles[ $tab_slug ]['toggles'] = array();
}
// get the only toggles which do not exist.
$processed_toggles = array_diff_key( $toggles_array, $this->settings_modal_toggles[ $tab_slug ]['toggles'] );
$this->settings_modal_toggles[ $tab_slug ]['toggles'] = array_merge( $this->settings_modal_toggles[ $tab_slug ]['toggles'], $processed_toggles );
}
/**
* Add settings under sub toggles.
*
* @since 3.23
* @since 3.26.7 Add support to set custom icons on sub toggles.
*
* @param string $tab_slug Current tab slug.
* @param string $toggle_slug Current toggle slug.
* @param array $sub_toggle_items Sub toggles settings need to be added.
* @param boolean $tabbed_subtoggles Tabbed sub toggle status.
* @param boolean $bb_icons_support BB icons support status.
*/
protected function _add_settings_modal_sub_toggles( $tab_slug, $toggle_slug, $sub_toggle_items, $tabbed_subtoggles = false, $bb_icons_support = false ) {
// Ensure tab slug is exist.
if ( ! isset( $this->settings_modal_toggles[ $tab_slug ] ) ) {
$this->settings_modal_toggles[ $tab_slug ] = array();
}
// Ensure toggles is exist.
if ( ! isset( $this->settings_modal_toggles[ $tab_slug ]['toggles'] ) ) {
$this->settings_modal_toggles[ $tab_slug ]['toggles'] = array();
}
// Stop the process here if the toggle slug doesn't exist. It should exist before we add
// sub toggles.
if ( ! isset( $this->settings_modal_toggles[ $tab_slug ]['toggles'][ $toggle_slug ] ) ) {
return;
}
// Don't replace existing sub toggles.
$toggle = $this->settings_modal_toggles[ $tab_slug ]['toggles'][ $toggle_slug ];
$sub_toggles = isset( $toggle['sub_toggles'] ) ? $toggle['sub_toggles'] : array();
if ( ! empty( $sub_toggles ) ) {
return;
}
// Set sub toggles.
$this->settings_modal_toggles[ $tab_slug ]['toggles'][ $toggle_slug ]['sub_toggles'] = $sub_toggle_items;
// Set tabbed sub toggles status.
if ( $tabbed_subtoggles ) {
$this->settings_modal_toggles[ $tab_slug ]['toggles'][ $toggle_slug ]['tabbed_subtoggles'] = $tabbed_subtoggles;
}
// Set BB icons support status.
if ( $bb_icons_support ) {
$this->settings_modal_toggles[ $tab_slug ]['toggles'][ $toggle_slug ]['bb_icons_support'] = $bb_icons_support;
}
}
/**
* Get all the fields.
*
* @return array|mixed|void
*/
private function _get_fields() {
$this->fields = array();
$this->fields = $this->fields_unprocessed;
$this->fields = $this->process_fields( $this->fields );
$this->fields = apply_filters( 'et_builder_module_fields_' . $this->slug, $this->fields );
foreach ( $this->fields as $field_name => $field ) {
$this->fields[ $field_name ] = apply_filters( 'et_builder_module_fields_' . $this->slug . '_field_' . $field_name, $field );
// Option template replaces field's array configuration into string which refers to
// saved template data & template id.
if ( is_array( $this->fields[ $field_name ] ) ) {
$this->fields[ $field_name ]['name'] = $field_name;
}
}
return $this->fields;
}
/**
* Checks if the field value equals its default value
*
* @param string $name Field name.
* @param mixed $value Field value.
*
* @return bool
*/
protected function _is_field_default( $name, $value ) {
if ( ! isset( $this->fields_unprocessed[ $name ] ) ) {
// field does not exist.
return false;
}
$field = $this->fields_unprocessed[ $name ];
$default = self::$_->array_get( $field, 'default', '' );
$default_on_front = self::$_->array_get( $field, 'default_on_front', 'not_found' );
if ( 'not_found' !== $default_on_front ) {
return $default_on_front === $value;
}
if ( is_array( $default ) && ! empty( $default[0] ) && is_array( $default[1] ) ) {
// This is a conditional default. Let's try to resolve it.
list ( $depend_field, $conditional_defaults ) = $default;
$default_key = self::$_->array_get( $this->props, $depend_field, key( $conditional_defaults ) );
$default = self::$_->array_get( $conditional_defaults, $default_key, null );
}
return $default === $value;
}
/**
* Intended to be overridden as needed.
*
* @param array $fields Module fields.
*
* @return mixed|void
*/
public function process_fields( $fields ) {
return apply_filters( 'et_pb_module_processed_fields', $fields, $this->slug );
}
/**
* Get the settings fields data for this element.
*
* @since 1.0
* @todo Finish documenting return value's structure.
*
* @return array[] {
* Settings Fields
*
* @type mixed[] $setting_field_key {
* Setting Field Data
*
* @type string $type Setting field type.
* @type string $id CSS id for the setting.
* @type string $label Text label for the setting. Translatable.
* @type string $description Description for the settings. Translatable.
* @type string $class Optional. Css class for the settings.
* @type string[] $affects Optional. The keys of all settings that depend on this setting.
* @type string[] $depends_on Optional. The keys of all settings that this setting depends on.
* @type string $depends_show_if Optional. Only show this setting when the settings
* on which it depends has a value equal to this.
* @type string $depends_show_if_not Optional. Only show this setting when the settings
* on which it depends has a value that is not equal to this.
* ...
* }
* ...
* }
*/
public function get_fields() {
return array(); }
/**
* Returns props value by provided key, if the value is empty, returns the default value
*
* @param string $prop Prop key.
* @param mixed $default Default value.
*
* @return mixed|null
*/
public function prop( $prop, $default = null ) {
return et_builder_module_prop( $prop, $this->props, $default );
}
/**
* Get module defined fields + automatically generated fields
*
* @since 3.23 Add auto generate responsive settings suffix based on mobile_options parameter.
*
* @internal Added to make get_fields() lighter. Initially added during BFB's 3rd party support
*
* @return array
*/
public function get_complete_fields() {
$fields = $this->get_fields();
$responsive_suffixes = array( 'tablet', 'phone', 'last_edited' );
// Loop fields and modify it if needed.
foreach ( $fields as $field_name => $field ) {
// Automatically generate responsive fields.
$supports_responsive = ( isset( $field['responsive'] ) && $field['responsive'] ) || ( isset( $field['mobile_options'] ) && $field['mobile_options'] );
if ( $supports_responsive ) {
// Get tab and toggle slugs value.
$tab_slug = isset( $field['tab_slug'] ) ? $field['tab_slug'] : '';
$toggle_slug = isset( $field['toggle_slug'] ) ? $field['toggle_slug'] : '';
foreach ( $responsive_suffixes as $responsive_suffix ) {
$responsive_field_name = "{$field_name}_{$responsive_suffix}";
$fields[ $responsive_field_name ] = array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
);
}
}
}
// Add general fields for modules including Columns.
if ( ( ! isset( $this->type ) || 'child' !== $this->type ) || in_array( $this->slug, array( 'et_pb_column', 'et_pb_column_inner' ), true ) ) {
$i18n =& self::$i18n;
if ( ! isset( $i18n['complete'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['complete'] = array(
'section' => esc_html__( 'section', 'et_builder' ),
'row' => esc_html__( 'row', 'et_builder' ),
'module' => esc_html__( 'module', 'et_builder' ),
'disabled' => array(
'label' => esc_html__( 'Disable on', 'et_builder' ),
'description' => esc_html__( 'This will disable the %1$s on selected devices', 'et_builder' ),
),
'admin' => array(
'description' => esc_html__( 'This will change the label of the module in the builder for easy identification.', 'et_builder' ),
),
'id' => array(
'label' => esc_html__( 'CSS ID', 'et_builder' ),
'description' => esc_html__( "Assign a unique CSS ID to the element which can be used to assign custom CSS styles from within your child theme or from within Divi's custom CSS inputs.", 'et_builder' ),
),
'class' => array(
'label' => esc_html__( 'CSS Class', 'et_builder' ),
'description' => esc_html__( "Assign any number of CSS Classes to the element, separated by spaces, which can be used to assign custom CSS styles from within your child theme or from within Divi's custom CSS inputs.", 'et_builder' ),
),
'' => array(),
);
// phpcs:enable
}
$disabled_on_fields = array();
$slug_labels = array(
'et_pb_section' => $i18n['complete']['section'],
'et_pb_row' => $i18n['complete']['row'],
);
$disable_label = isset( $slug_labels[ $this->slug ] ) ? $slug_labels[ $this->slug ] : $i18n['complete']['module'];
$disabled_on_fields = array(
'disabled_on' => array(
'label' => $i18n['complete']['disabled']['label'],
'description' => sprintf( $i18n['complete']['disabled']['description'], $disable_label ),
'type' => 'multiple_checkboxes',
'options' => array(
'phone' => et_builder_i18n( 'Phone' ),
'tablet' => et_builder_i18n( 'Tablet' ),
'desktop' => et_builder_i18n( 'Desktop' ),
),
'additional_att' => 'disable_on',
'option_category' => 'configuration',
'tab_slug' => 'custom_css',
'toggle_slug' => 'visibility',
),
);
$common_general_fields = array(
'admin_label' => array(
'label' => et_builder_i18n( 'Admin Label' ),
'description' => $i18n['complete']['admin']['description'],
'type' => 'text',
'option_category' => 'configuration',
'toggle_slug' => 'admin_label',
),
'module_id' => array(
'label' => $i18n['complete']['id']['label'],
'description' => $i18n['complete']['id']['description'],
'type' => 'text',
'option_category' => 'configuration',
'tab_slug' => 'custom_css',
'toggle_slug' => 'classes',
'option_class' => 'et_pb_custom_css_regular',
),
'module_class' => array(
'label' => $i18n['complete']['class']['label'],
'description' => $i18n['complete']['class']['description'],
'type' => 'text',
'option_category' => 'configuration',
'tab_slug' => 'custom_css',
'toggle_slug' => 'classes',
'option_class' => 'et_pb_custom_css_regular',
),
);
$general_fields = array_merge( $disabled_on_fields, $common_general_fields );
$fields = array_merge( $fields, apply_filters( 'et_builder_module_general_fields', $general_fields ) );
}
return $fields;
}
/**
* Get configuration for module's advanced fields. This method is meant to be overridden in module classes.
*
* @since 3.1
*
* @return array[] {@see self::$advanced_fields}
*/
public function get_advanced_fields_config() {
return $this->advanced_fields;
}
/**
* Get configuration for module's custom css fields. This method is meant to be overridden in module classes.
*
* @since 3.1
*
* @return array[] {@see self::$custom_css_fields}
*/
public function get_custom_css_fields_config() {
return $this->custom_css_fields;
}
/**
* Returns Global Presets settings
*/
public static function get_global_presets() {
return self::$global_presets_manager->get_global_presets();
}
/**
* Get custom tabs for the module's settings modal. This method is meant to be overridden in module classes.
*
* @since 3.1
*
* @return array[] {@see self::$settings_modal_tabs}
*/
public function get_settings_modal_tabs() {
return $this->settings_modal_tabs;
}
/**
* Get toggles for the module's settings modal. This method is meant to be overridden in module classes.
*
* @since 3.1
*
* @return array[] {@see self::$settings_modal_toggles}
*/
public function get_settings_modal_toggles() {
return $this->settings_modal_toggles;
}
/**
* Generate column fields.
*
* @param integer $column_number number of column.
* @param array $base_fields base fields for column.
*
* @return array column fields
*/
public function get_column_fields( $column_number = 1, $base_fields = array() ) {
$fields = array();
// Loop column's base fields.
foreach ( $base_fields as $field_name => $field ) {
// Loop (number of column) times.
for ( $index = 1; $index <= $column_number; $index++ ) {
// Some attribute's id is not located at the bottom of the attribute name.
if ( isset( $field['has_custom_index_location'] ) && $field['has_custom_index_location'] ) {
$column_name = str_replace( '%column_index%', $index, $field_name );
} else {
$column_name = "{$field_name}_{$index}";
}
$fields[ $column_name ] = array(
'type' => 'skip',
);
// Most column field is an empty-type attribute. Non-empty attribute are likely
// attribute for computed field which needs to have suffix ID.
if ( ! empty( $field ) ) {
// Append suffix to the module variable.
foreach ( $field as $attr_name => $attr_value ) {
if ( 'has_custom_index_location' === $attr_name ) {
continue;
}
if ( is_array( $attr_value ) && 'computed_callback' !== $attr_name ) {
$attr_value = $this->_append_suffix( $attr_value, $index );
}
$fields[ $column_name ][ $attr_name ] = $attr_value;
}
}
}
}
return $fields;
}
/**
* Append suffix to simple array value.
*
* @param array $values array value.
* @param string $suffix intended suffix for output's array.
*
* @return array suffixed value
*/
public function _append_suffix( $values, $suffix ) {
$output = array();
foreach ( $values as $value ) {
$output[] = "{$value}_{$suffix}";
}
return $output;
}
/**
* Returns module style priority.
*
* @return int
*/
public function get_style_priority() {
return $this->_style_priority;
}
/**
* Get current post's post type.
*
* @return string
*/
public function get_post_type() {
global $post, $et_builder_post_type;
// phpcs:disable WordPress.Security.NonceVerification -- This function does not change any state, and is therefore not susceptible to CSRF.
if ( isset( $_POST['et_post_type'] ) && ! $et_builder_post_type ) {
$et_builder_post_type = sanitize_text_field( $_POST['et_post_type'] );
}
// phpcs:enable
if ( is_a( $post, 'WP_POST' ) && ( is_admin() || ! isset( $et_builder_post_type ) ) ) {
return $post->post_type;
} else {
$layout_type = self::get_theme_builder_layout_type();
if ( $layout_type ) {
return $layout_type;
}
return isset( $et_builder_post_type ) ? $et_builder_post_type : 'post';
}
}
/**
* Removed extra tabs/newlines from template.
*
* @param string $content Template content.
*
* @return string|string[]
*/
public static function optimize_bb_chunk( $content ) {
if ( ! ET_BUILDER_OPTIMIZE_TEMPLATES ) {
return $content;
}
return str_replace( self::$_unique_bb_strip, '', $content );
}
/**
* Optimize template content.
*
* @param string $content Template content.
*
* @return string|string[]
*/
public static function get_unique_bb_key( $content ) {
if ( ! ET_BUILDER_OPTIMIZE_TEMPLATES ) {
return $content;
}
$content = self::optimize_bb_chunk( $content );
if ( isset( self::$_unique_bb_keys_map[ $content ] ) ) {
$key = self::$_unique_bb_keys_map[ $content ];
} else {
self::$_unique_bb_keys_values[] = $content;
$key = count( self::$_unique_bb_keys_values ) - 1;
self::$_unique_bb_keys_map[ $content ] = $key;
}
$content = "<!-- $key -->";
return $content;
}
/**
* Wrap settings option in wrapper div e.g `.et-pb-option-standard`.
*
* @param string $option_output Option markup.
* @param array $field Field settings.
* @param string $name Field name.
*
* @return string|string[]
*/
public function wrap_settings_option( $option_output, $field, $name = '' ) {
// Option template convert array field into string id; return early to prevent error.
if ( is_string( $field ) ) {
return self::get_unique_bb_key( $option_output );
}
$depends = false;
$new_depends = isset( $field['show_if'] ) || isset( $field['show_if_not'] );
$depends_attr = '';
if ( ! $new_depends && ( isset( $field['depends_show_if'] ) || isset( $field['depends_show_if_not'] ) ) ) {
$depends = true;
if ( isset( $field['depends_show_if_not'] ) ) {
$depends_show_if_not = is_array( $field['depends_show_if_not'] ) ? implode( ',', $field['depends_show_if_not'] ) : $field['depends_show_if_not'];
$depends_attr = sprintf( ' data-depends_show_if_not="%s"', esc_attr( $depends_show_if_not ) );
} else {
$depends_attr = sprintf( ' data-depends_show_if="%s"', esc_attr( $field['depends_show_if'] ) );
}
}
if ( isset( $field['depends_on_responsive'] ) ) {
$depends_attr .= sprintf( ' data-depends_on_responsive="%s"', esc_attr( implode( ',', $field['depends_on_responsive'] ) ) );
}
// Overriding background color's attribute, turning it into appropriate background attributes.
if ( isset( $field['type'] ) && isset( $field['name'] ) && 'background_color' === $field['name'] && ! self::$_->array_get( $field, 'skip_background_ui' ) ) {
$field['type'] = 'background';
// Removing depends default variable which hides background color for unified background field UI.
if ( isset( $field['depends_show_if'] ) ) {
unset( $field['depends_show_if'] );
}
}
$output = sprintf(
'%6$s<div class="et-pb-option et-pb-option--%10$s%1$s%2$s%3$s%8$s%9$s%12$s%13$s"%4$s tabindex="-1" data-option_name="%11$s">%5$s</div>%7$s',
( ! empty( $field['type'] ) && 'tiny_mce' === $field['type'] ? ' et-pb-option-main-content' : '' ),
$depends || $new_depends ? ' et-pb-depends' : '',
( ! empty( $field['type'] ) && 'hidden' === $field['type'] ? ' et_pb_hidden' : '' ),
( $depends ? $depends_attr : '' ),
"\n\t\t\t\t" . $option_output . "\n\t\t\t",
"\t",
"\n\n\t\t",
( ! empty( $field['type'] ) && 'hidden' === $field['type'] ? esc_attr( sprintf( ' et-pb-option-%1$s', $field['name'] ) ) : '' ),
( ! empty( $field['option_class'] ) ? ' ' . $field['option_class'] : '' ),
isset( $field['type'] ) ? esc_attr( $field['type'] ) : '',
esc_attr( $field['name'] ),
isset( $field['specialty_only'] ) && 'yes' === $field['specialty_only'] ? ' et-pb-specialty-only-option' : '',
$new_depends ? ' et-pb-new-depends' : ''
);
if ( ! empty( $field['hover'] ) ) {
if ( 'tabs' === $field['hover'] ) {
$this->last_hover_tab_field = $name;
}
$hover = $this->last_hover_tab_field;
if ( $hover ) {
$begin = '<div class="et-pb-option ';
$pos = strpos( $output, $begin );
if ( $pos >= 0 ) {
$output = substr_replace(
$output,
"<div data-depends_hover=\"$hover\" class=\"et-pb-option-standard et-pb-option ",
$pos,
strlen( $begin )
);
}
}
}
return self::get_unique_bb_key( $output );
}
/**
* Get field renderer data e.g renderer method.
*
* @param array $field Field options.
*
* @return array|mixed|void
*/
public function get_field_renderer( $field ) {
if ( ! isset( $field['type'] ) && ! isset( $field['renderer'] ) ) {
return array();
}
// Make it backward compatible with old 3rd party modules which use custom render methods.
$renderer_method = isset( $field['renderer'] ) ? $field['renderer'] : '';
$renderer_with_field = isset( $field['renderer_with_field'] ) ? $field['renderer_with_field'] : false;
$renderer_data = array();
if ( isset( $field['type'] ) ) {
switch ( $field['type'] ) {
case 'categories':
// after 3rd party support release taxonomy name for Shop module has been changed to `product_cat`
// so check also for `product_category` for backward compatibility.
if ( isset( $field['taxonomy_name'] ) && self::$_->includes( $field['taxonomy_name'], 'product' ) ) {
$renderer_method = 'et_builder_include_categories_shop_option';
} else {
$renderer_method = 'et_builder_include_categories_option';
}
break;
case 'select_sidebar':
$renderer_method = 'et_builder_get_widget_areas';
break;
case 'select_icon':
if ( isset( $field['renderer_options'] ) && isset( $field['renderer_options']['icons_list'] ) && 'icon_down' === $field['renderer_options']['icons_list'] ) {
$renderer_method = 'et_pb_get_font_down_icon_list';
} else {
$renderer_method = 'et_pb_get_font_icon_list';
}
$renderer_with_field = true;
break;
case 'upload_gallery':
$renderer_method = 'et_builder_get_gallery_settings';
break;
case 'center_map':
$renderer_method = 'et_builder_generate_center_map_setting';
break;
case 'border-radius':
$renderer_method = array(
'class' => 'ET_Builder_Module_Field_Template_Border_Radius',
);
break;
case 'composite':
if ( isset( $field['composite_type'] ) && 'default' === $field['composite_type'] ) {
$renderer_method = array(
'class' => 'ET_Builder_Module_Field_Template_Tabbed',
);
} elseif ( isset( $field['composite_type'] ) && 'tabbed' === $field['composite_type'] && 'border' === $field['option_category'] ) {
$renderer_method = array(
'class' => 'ET_Builder_Module_Field_Template_Border_Styles',
);
}
break;
}
}
if ( '' !== $renderer_method ) {
$renderer_data = array(
'renderer' => $renderer_method,
'renderer_options' => isset( $field['renderer_options'] ) ? $field['renderer_options'] : array(),
'renderer_with_field' => $renderer_with_field,
);
}
return apply_filters( 'et_bb_field_renderer_data', $renderer_data, $field );
}
/**
* Prepare module field (option) for use within BB microtemplates.
* The own field renderer can be used.
*
* @param array $field Module field.
*
* @param string $name Unused name param.
*
* @return mixed|string Html code of the field
*/
public function wrap_settings_option_field( $field, $name = '' ) {
$use_container_wrapper = isset( $field['use_container_wrapper'] ) && ! $field['use_container_wrapper'] ? false : true;
$field_renderer = $this->get_field_renderer( $field );
if ( ! empty( $field_renderer ) && is_array( $field_renderer['renderer'] ) && ! empty( $field_renderer['renderer']['class'] ) ) {
// cut off 'ET_Builder_Module_Field_Template_' part from renderer definition.
$class_name_without_prefix = strtolower( str_replace( 'ET_Builder_Module_Field_Template_', '', $field_renderer['renderer']['class'] ) );
// split class name string by underscore symbol.
$file_name_parts = explode( '_', $class_name_without_prefix );
if ( ! empty( $file_name_parts ) ) {
// the first symbol of class name must be uppercase.
$last_index = count( $file_name_parts ) - 1;
$file_name_parts[ $last_index ] = ucwords( $file_name_parts[ $last_index ] );
// load renderer class from 'module/field/template/' directory accordingly class name and class directory hierarchy.
require_once ET_BUILDER_DIR . 'module/field/template/' . implode( DIRECTORY_SEPARATOR, $file_name_parts ) . '.php';
$renderer = new $field_renderer['renderer']['class']();
// before calling the 'render' method make sure the instantiated class is child of 'ET_Builder_Module_Field_Template_Base'.
if ( is_subclass_of( $field_renderer['renderer']['class'], 'ET_Builder_Module_Field_Template_Base' ) ) {
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found
$field_el = call_user_func( array( $renderer, 'render' ), $field, $this );
}
}
} elseif ( ! empty( $field_renderer ) ) {
$renderer_options = ! empty( $field_renderer['renderer_options'] ) ? $field_renderer['renderer_options'] : $field;
$default_value = isset( $field['default'] ) ? $field['default'] : '';
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found
$field_el = is_callable( $field_renderer['renderer'] ) ? call_user_func( $field_renderer['renderer'], $renderer_options, $default_value ) : $field_renderer['renderer'];
if ( ! empty( $field_renderer['renderer_with_field'] ) && $field_renderer['renderer_with_field'] ) {
$field_el .= $this->render_field( $field, $name );
}
} else {
$field_el = $this->render_field( $field, $name );
}
$description = ! empty( $field['description'] ) ? sprintf( '%2$s<p class="description">%1$s</p>', $field['description'], "\n\t\t\t\t\t" ) : '';
if ( '' === $description && ! $use_container_wrapper ) {
$output = $field_el;
} else {
$output = sprintf(
'%3$s<div class="et-pb-option-container et-pb-option-container--%6$s%5$s">
%1$s
%2$s
%4$s</div>',
$field_el,
$description,
"\n\n\t\t\t\t",
"\t",
( isset( $field['type'] ) && 'custom_css' === $field['type'] ? ' et-pb-custom-css-option' : '' ),
isset( $field['type'] ) ? esc_attr( $field['type'] ) : ''
);
}
$dynamic_content_notice = et_get_safe_localization(
sprintf(
__( 'This field contains a dynamic value which requires the Visual Builder. <a href="#" class="%1$s">Open Visual Builder</a>', 'et_builder' ),
'et-pb-dynamic-content-fb-switch'
)
);
// Conditionally wrap fields depending on whether their values represent dynamic content or not.
$output = sprintf(
'<%% var isDynamic = typeof %1$s !== \'undefined\' && ET_PageBuilder.isDynamicContent(%1$s); %%>
<%% if (isDynamic) { %%>
<div class="et-pb-dynamic-content">
<div class="et-pb-dynamic-content__message">
%2$s
</div>
<div class="et-pb-dynamic-content__field">
<%% } %%>
%3$s
<%% if (isDynamic) { %%>
</div>
</div>
<%% } %%>',
et_core_intentionally_unescaped( $this->get_field_variable_name( $field ), 'underscore_template' ),
et_core_intentionally_unescaped( $this->get_icon( 'lock' ) . $dynamic_content_notice, 'underscore_template' ),
et_core_intentionally_unescaped( $output, 'underscore_template' )
);
return $output;
}
/**
* Wrap setting option label.
*
* @param array $field Field settings.
*
* @return mixed|string
*/
public function wrap_settings_option_label( $field ) {
if ( ! empty( $field['label'] ) ) {
$label = $field['label'];
} else {
return '';
}
$field_name = $this->get_field_name( $field );
if ( isset( $field['type'] ) && 'font' === $field['type'] ) {
$field_name .= '_select';
}
$required = ! empty( $field['required'] ) ? '<span class="required">*</span>' : '';
$attributes = ! ( isset( $field['type'] ) && in_array( $field['type'], array( 'custom_margin', 'custom_padding' ), true ) )
? sprintf( ' for="%1$s"', esc_attr( $field_name ) )
: ' class="et_custom_margin_label"';
$label = sprintf(
'<label%1$s>%2$s%4$s %3$s</label>',
et_core_esc_previously( $attributes ),
et_core_intentionally_unescaped( $label, 'html' ),
et_core_intentionally_unescaped( $required, 'fixed_string' ),
isset( $field['no_colon'] ) && true === $field['no_colon'] ? '' : ':'
);
return $label;
}
/**
* Get svg icon as string.
*
* @param string $icon_name icon name.
*
* @return string div-wrapped svg icon.
*/
public function get_icon( $icon_name ) {
$all_svg_icons = et_pb_get_svg_icons_list();
$icon = isset( $all_svg_icons[ $icon_name ] ) ? $all_svg_icons[ $icon_name ] : '';
if ( '' === $icon ) {
return '';
}
return '<div class="et-pb-icon">
<svg viewBox="0 0 28 28" preserveAspectRatio="xMidYMid meet" shapeRendering="geometricPrecision">' . $icon . '</svg>
</div>';
}
/**
* Get structure of background UI tabs
*
* @param string $base_name Background base.
*
* @return array
*/
public function get_background_fields_structure( $base_name = 'background' ) {
$is_background_attr = 'background' === $base_name;
$use_background_color_gradient = $is_background_attr ? 'use_background_color_gradient' : "{$base_name}_use_color_gradient";
$prefix = $is_background_attr ? '' : "{$base_name}_";
$structure = array(
'color' => array(
"{$base_name}_color",
),
'gradient' => array(
"{$base_name}_color_gradient_start",
"{$base_name}_color_gradient_end",
$use_background_color_gradient,
"{$base_name}_color_gradient_type",
"{$base_name}_color_gradient_direction",
"{$base_name}_color_gradient_direction_radial",
"{$base_name}_color_gradient_start_position",
"{$base_name}_color_gradient_end_position",
"{$base_name}_color_gradient_overlays_image",
),
'image' => array(
"{$base_name}_image",
"{$prefix}parallax",
"{$prefix}parallax_method",
"{$base_name}_size",
"{$base_name}_position",
"{$base_name}_repeat",
"{$base_name}_blend",
),
'video' => array(
"{$base_name}_video_mp4",
"{$base_name}_video_webm",
"{$base_name}_video_width",
"{$base_name}_video_height",
"{$prefix}allow_player_pause",
"{$base_name}_video_pause_outside_viewport",
),
);
if ( $is_background_attr ) {
$structure['color'][] = 'use_background_color';
$structure['image'][] = 'bg_img'; // Column.
}
return $structure;
}
/**
* Get list of background fields names in one dimensional array
*
* @return array
*/
public function get_background_fields_names() {
$background_structure = $this->get_background_fields_structure();
$fields_names = array();
foreach ( $background_structure as $tab_name ) {
foreach ( $tab_name as $field_name ) {
$fields_names[] = $field_name;
}
}
return $fields_names;
}
/**
* Get / extract background fields from all modules fields
*
* @param array $all_fields All modules fields.
*
* @param string $base_name Field base name.
*
* @return array background fields multidimensional array grouped based on its tab
*/
public function get_background_fields( $all_fields, $base_name = 'background' ) {
$background_fields_structure = $this->get_background_fields_structure( $base_name );
$background_tab_names = array_keys( $background_fields_structure );
$background_fields = array_fill_keys( $background_tab_names, array() );
foreach ( $all_fields as $field_name => $field ) {
// Multiple foreaches seem overkill. Use single foreach with little bit if conditions
// redundancy to get background fields grouped into multi-dimensional tab-based array.
if ( in_array( $field_name, $background_fields_structure['color'], true ) ) {
$background_fields['color'][ $field_name ] = $field;
}
if ( in_array( $field_name, $background_fields_structure['gradient'], true ) ) {
$background_fields['gradient'][ $field_name ] = $field;
}
if ( in_array( $field_name, $background_fields_structure['image'], true ) ) {
$background_fields['image'][ $field_name ] = $field;
}
if ( in_array( $field_name, $background_fields_structure['video'], true ) ) {
$background_fields['video'][ $field_name ] = $field;
}
}
return $background_fields;
}
/**
* Generate background fields based on base name
*
* @since 3.23 Add allowed CSS units for gradient start and end position. Override computed callback.
*
* @param string $base_name background base name.
* @param string $background_tab background tab name.
* @param string $tab_slug field's tab slug.
* @param string $toggle_slug field's toggle slug.
* @param string $context field's context.
*
* @return array of background fields
*/
public function generate_background_options( $base_name, $background_tab, $tab_slug, $toggle_slug, $context = null ) {
$baseless_prefix = 'background' === $base_name ? '' : "{$base_name}_";
$options = array();
$i18n =& self::$i18n;
if ( ! isset( $i18n['background'] ) ) {
// phpcs:disable WordPress.WP.I18n.MissingTranslatorsComment
$i18n['background'] = array(
'color' => array(
'label' => esc_html__( 'Background Color', 'et_builder' ),
),
'gradient' => array(
'label' => esc_html__( 'Use Background Color Gradient', 'et_builder' ),
),
'gradient_start' => array(
'label' => esc_html__( 'Gradient Start', 'et_builder' ),
),
'gradient_end' => array(
'label' => esc_html__( 'Gradient End', 'et_builder' ),
),
'gradient_type' => array(
'label' => esc_html__( 'Gradient Type', 'et_builder' ),
'description' => esc_html__( 'Linear gradients radiate in a single direction across one axis. Radial gradients radiate from the center of the background in the shape of a circle.', 'et_builder' ),
),
'gradient_direction' => array(
'label' => esc_html__( 'Gradient Direction', 'et_builder' ),
'description' => esc_html__( 'Change the direction of the gradient by choosing a starting position within a 360 degree range.', 'et_builder' ),
),
'gradient_direction_radial' => array(
'label' => esc_html__( 'Radial Direction', 'et_builder' ),
'description' => esc_html__( 'Change the direction of the gradient by choosing a starting position within a 360 degree range.', 'et_builder' ),
),
'gradient_start_position' => array(
'label' => esc_html__( 'Start Position', 'et_builder' ),
'description' => esc_html__( 'By adjusting the starting position of the gradient, you can control how quickly or slowly each color transitions, and where the transition begins.', 'et_builder' ),
),
'gradient_end_position' => array(
'label' => esc_html__( 'End Position', 'et_builder' ),
'description' => esc_html__( 'By adjusting the ending position of the gradient, you can control how quickly or slowly each color transitions, and where the transition begins.', 'et_builder' ),
),
'gradient_overlay' => array(
'label' => esc_html__( 'Place Gradient Above Background Image', 'et_builder' ),
'description' => esc_html__( 'If enabled, gradient will be positioned on top of background-image', 'et_builder' ),
),
'image' => array(
'label' => esc_html__( 'Background Image', 'et_builder' ),
'choose_text' => esc_attr__( 'Choose a Background Image', 'et_builder' ),
'update_text' => esc_attr__( 'Set As Background', 'et_builder' ),
),
'parallax' => array(
'label' => esc_html__( 'Use Parallax Effect', 'et_builder' ),
'description' => esc_html__( 'If enabled, your background image will stay fixed as your scroll, creating a fun parallax-like effect.', 'et_builder' ),
),
'parallax_method' => array(
'label' => esc_html__( 'Parallax Method', 'et_builder' ),
'description' => esc_html__( 'Define the method, used for the parallax effect.', 'et_builder' ),
'options' => array(
'on' => esc_html__( 'True Parallax', 'et_builder' ),
'off' => esc_html__( 'CSS', 'et_builder' ),
),
),
'size' => array(
'label' => esc_html__( 'Background Image Size', 'et_builder' ),
'description' => esc_html__( 'Choosing "Cover" will force the image to fill the entire background area, clipping the image when necessary. Choosing "Fit" will ensure that the entire image is always visible, but can result in blank spaces around the image. When set to "Actual Size," the image will not be resized at all.', 'et_builder' ),
'options' => array(
'cover' => esc_html__( 'Cover', 'et_builder' ),
'contain' => esc_html__( 'Fit', 'et_builder' ),
'initial' => esc_html__( 'Actual Size', 'et_builder' ),
),
),
'position' => array(
'label' => esc_html__( 'Background Image Position', 'et_builder' ),
'description' => esc_html__( "Choose where you would like the background image to be positioned within this element. You may want to position the background based on the the image's focus point.", 'et_builder' ),
),
'repeat' => array(
'label' => esc_html__( 'Background Image Repeat', 'et_builder' ),
'description' => esc_html__( 'If the background image is smaller than the size of the element, you may want the image to repeat. This result will result in a background image pattern.', 'et_builder' ),
'options' => array(
'no-repeat' => esc_html__( 'No Repeat', 'et_builder' ),
'repeat' => esc_html__( 'Repeat', 'et_builder' ),
'repeat-x' => esc_html__( 'Repeat X (horizontal)', 'et_builder' ),
'repeat-y' => esc_html__( 'Repeat Y (vertical)', 'et_builder' ),
'round' => esc_html__( 'Round', 'et_builder' ),
),
),
'blend' => array(
'label' => esc_html__( 'Background Image Blend', 'et_builder' ),
'description' => esc_html__( 'Background images can be blended with the background color, merging the two and creating unique effects.', 'et_builder' ),
),
'mp4' => array(
'label' => esc_html__( 'Background Video MP4', 'et_builder' ),
'description' => esc_html__( 'All videos should be uploaded in both .MP4 .WEBM formats to ensure maximum compatibility in all browsers. Upload the .MP4 version here.', 'et_builder' ),
'upload_button_text' => esc_attr__( 'Upload a video', 'et_builder' ),
'choose_text' => esc_attr__( 'Choose a Background Video MP4 File', 'et_builder' ),
'update_text' => esc_attr__( 'Set As Background Video', 'et_builder' ),
),
'webm' => array(
'label' => esc_html__( 'Background Video Webm', 'et_builder' ),
'description' => esc_html__( 'All videos should be uploaded in both .MP4 .WEBM formats to ensure maximum compatibility in all browsers. Upload the .WEBM version here.', 'et_builder' ),
'upload_button_text' => esc_attr__( 'Upload a video', 'et_builder' ),
'choose_text' => esc_attr__( 'Choose a Background Video WEBM File', 'et_builder' ),
'update_text' => esc_attr__( 'Set As Background Video', 'et_builder' ),
),
'video_width' => array(
'label' => esc_html__( 'Background Video Width', 'et_builder' ),
'description' => esc_html__( 'In order for videos to be sized correctly, you must input the exact width (in pixels) of your video here.', 'et_builder' ),
),
'video_height' => array(
'label' => esc_html__( 'Background Video Height', 'et_builder' ),
'description' => esc_html__( 'In order for videos to be sized correctly, you must input the exact height (in pixels) of your video here.', 'et_builder' ),
),
'pause' => array(
'label' => esc_html__( 'Pause Video When Another Video Plays', 'et_builder' ),
'description' => esc_html__( 'Allow video to be paused by other players when they begin playing', 'et_builder' ),
),
'viewport' => array(
'label' => esc_html__( 'Pause Video While Not In View', 'et_builder' ),
'description' => esc_html__( 'Allow video to be paused while it is not in the visible area.', 'et_builder' ),
),
);
// phpcs:enable
}
// Not included on skip background tab because background-field is expected to be registered under "background_color" field.
if ( in_array( $background_tab, array( 'all', 'button', 'color' ), true ) ) {
$options[ "{$base_name}_color" ] = self::background_field_template(
'color',
array(
'label' => $i18n['background']['color']['label'],
'type' => 'color-alpha',
'option_category' => 'configuration',
'custom_color' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color',
'hover' => 'tabs',
'last_edited' => 'background',
'mobile_options' => true,
'sticky' => true,
)
);
// This option is used to enable or disable background color on VB or FE. This option has
// different function with use_background_color. Option background_enable_color won't hide
// background color option like what use_background_color does. It's used to ensure if
// current background should be rendered or not by inheriting or applying custom color.
$options[ "{$base_name}_enable_color" ] = self::background_field_template(
'enable_color',
array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'default' => 'on',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
}
if ( in_array( $background_tab, array( 'all', 'button', 'skip', 'gradient' ), true ) ) {
$use_background_color_gradient_name = 'background' === $base_name ? 'use_background_color_gradient' : "{$base_name}_use_color_gradient";
$options[ $use_background_color_gradient_name ] = self::background_field_template(
'use_color_gradient',
array(
'label' => $i18n['background']['gradient']['label'],
'description' => '',
'type' => 'skip' === $background_tab ? 'skip' : 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'No' ),
'on' => et_builder_i18n( 'Yes' ),
),
'default' => 'off',
'default_on_child' => true,
'affects' => array(
"{$base_name}_color_gradient_start",
"{$base_name}_color_gradient_end",
"{$base_name}_color_gradient_start_position",
"{$base_name}_color_gradient_end_position",
"{$base_name}_color_gradient_type",
"{$base_name}_color_gradient_overlays_image",
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'use_color_gradient',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_color_gradient_start" ] = self::background_field_template(
'color_gradient_start',
array(
'label' => $i18n['background']['gradient_start']['label'],
'description' => '',
'type' => 'skip' === $background_tab ? 'skip' : 'color-alpha',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'default' => ET_Global_Settings::get_value( 'all_background_gradient_start' ),
'default_on_child' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_start',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_color_gradient_end" ] = self::background_field_template(
'color_gradient_end',
array(
'label' => $i18n['background']['gradient_end']['label'],
'description' => '',
'type' => 'skip' === $background_tab ? 'skip' : 'color-alpha',
'option_category' => 'configuration',
'depends_show_if' => 'on',
'default' => ET_Global_Settings::get_value( 'all_background_gradient_end' ),
'default_on_child' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_end',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_color_gradient_type" ] = self::background_field_template(
'color_gradient_type',
array(
'label' => $i18n['background']['gradient_type']['label'],
'description' => $i18n['background']['gradient_type']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'select',
'option_category' => 'configuration',
'options' => array(
'linear' => et_builder_i18n( 'Linear' ),
'radial' => et_builder_i18n( 'Radial' ),
),
'affects' => array(
"{$base_name}_color_gradient_direction",
"{$base_name}_color_gradient_direction_radial",
),
'default' => ET_Global_Settings::get_value( 'all_background_gradient_type' ),
'default_on_child' => true,
'description' => '',
'depends_show_if' => 'on',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_type',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_color_gradient_direction" ] = self::background_field_template(
'color_gradient_direction',
array(
'label' => $i18n['background']['gradient_direction']['label'],
'description' => $i18n['background']['gradient_direction']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'range',
'option_category' => 'configuration',
'range_settings' => array(
'min' => 1,
'max' => 360,
'step' => 1,
),
'default' => ET_Global_Settings::get_value( 'all_background_gradient_direction' ),
'default_on_child' => true,
'validate_unit' => true,
'fixed_unit' => 'deg',
'fixed_range' => true,
'depends_show_if' => 'linear',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_direction',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_color_gradient_direction_radial" ] = self::background_field_template(
'color_gradient_direction_radial',
array(
'label' => $i18n['background']['gradient_direction_radial']['label'],
'description' => $i18n['background']['gradient_direction_radial']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'select',
'option_category' => 'configuration',
'options' => array(
'center' => et_builder_i18n( 'Center' ),
'top left' => et_builder_i18n( 'Top Left' ),
'top' => et_builder_i18n( 'Top' ),
'top right' => et_builder_i18n( 'Top Right' ),
'right' => et_builder_i18n( 'Right' ),
'bottom right' => et_builder_i18n( 'Bottom Right' ),
'bottom' => et_builder_i18n( 'Bottom' ),
'bottom left' => et_builder_i18n( 'Bottom Left' ),
'left' => et_builder_i18n( 'Left' ),
),
'default' => ET_Global_Settings::get_value( 'all_background_gradient_direction_radial' ),
'default_on_child' => true,
'description' => '',
'depends_show_if' => 'radial',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_direction_radial',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_color_gradient_start_position" ] = self::background_field_template(
'color_gradient_start_position',
array(
'label' => $i18n['background']['gradient_start_position']['label'],
'description' => $i18n['background']['gradient_start_position']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'range',
'option_category' => 'configuration',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
),
'default' => ET_Global_Settings::get_value( 'all_background_gradient_start_position' ),
'default_on_child' => true,
'validate_unit' => true,
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pc', 'ex', 'vh', 'vw' ),
'default_unit' => '%',
'fixed_range' => true,
'depends_show_if' => 'on',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_start_position',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_color_gradient_end_position" ] = self::background_field_template(
'color_gradient_end_position',
array(
'label' => $i18n['background']['gradient_end_position']['label'],
'description' => $i18n['background']['gradient_end_position']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'range',
'option_category' => 'configuration',
'range_settings' => array(
'min' => 0,
'max' => 100,
'step' => 1,
),
'default' => ET_Global_Settings::get_value( 'all_background_gradient_end_position' ),
'default_on_child' => true,
'validate_unit' => true,
'allowed_units' => array( '%', 'em', 'rem', 'px', 'cm', 'mm', 'in', 'pc', 'ex', 'vh', 'vw' ),
'default_unit' => '%',
'fixed_range' => true,
'depends_show_if' => 'on',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_end_position',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "${base_name}_color_gradient_overlays_image" ] = self::background_field_template(
'color_gradient_overlays_image',
array(
'label' => $i18n['background']['gradient_overlay']['label'],
'description' => $i18n['background']['gradient_overlay']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'No' ),
'on' => et_builder_i18n( 'Yes' ),
),
'default' => ET_Global_Settings::get_value( 'all_background_gradient_overlays_image' ),
'default_on_child' => true,
'depends_show_if' => 'on',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'color_gradient_overlays_image',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
}
if ( in_array( $background_tab, array( 'all', 'button', 'skip', 'image' ), true ) ) {
$options[ "{$base_name}_image" ] = self::background_field_template(
'image',
array(
'label' => $i18n['background']['image']['label'],
'choose_text' => $i18n['background']['image']['choose_text'],
'update_text' => $i18n['background']['image']['update_text'],
'upload_button_text' => et_builder_i18n( 'Upload an image' ),
'type' => 'skip' === $background_tab ? 'skip' : 'upload',
'option_category' => 'configuration',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'image',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
// This option is used to enable or disable background image on VB or FE. It's used to
// ensure if current background should be rendered or not by inheriting or applying
// custom image.
$options[ "{$base_name}_enable_image" ] = self::background_field_template(
'enable_image',
array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'default' => 'on',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
if ( 'button' !== $background_tab ) {
$options[ "${baseless_prefix}parallax" ] = self::background_field_template(
'parallax',
array(
'label' => $i18n['background']['parallax']['label'],
'description' => $i18n['background']['parallax']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'No' ),
'on' => et_builder_i18n( 'Yes' ),
),
'default' => 'off',
'default_on_child' => true,
'affects' => array(
"${baseless_prefix}parallax_method",
"{$base_name}_size",
"{$base_name}_position",
"{$base_name}_repeat",
"{$base_name}_blend",
),
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'parallax',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "${baseless_prefix}parallax_method" ] = self::background_field_template(
'parallax_method',
array(
'label' => $i18n['background']['parallax_method']['label'],
'description' => $i18n['background']['parallax_method']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'select',
'option_category' => 'configuration',
'options' => array(
'on' => $i18n['background']['parallax_method']['options']['on'],
'off' => $i18n['background']['parallax_method']['options']['off'],
),
'default' => self::$_->array_get( $this->advanced_fields, "background.options.{$baseless_prefix}parallax_method.default", 'on' ),
'default_on_child' => true,
'depends_show_if' => 'on',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'parallax_method',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
}
$options[ "{$base_name}_size" ] = self::background_field_template(
'size',
array(
'label' => $i18n['background']['size']['label'],
'description' => $i18n['background']['size']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'select',
'option_category' => 'layout',
'options' => array(
'cover' => $i18n['background']['size']['options']['cover'],
'contain' => $i18n['background']['size']['options']['contain'],
'initial' => $i18n['background']['size']['options']['initial'],
),
'default' => 'cover',
'default_on_child' => true,
'depends_show_if' => 'off',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'size',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_position" ] = self::background_field_template(
'position',
array(
'label' => $i18n['background']['position']['label'],
'description' => $i18n['background']['position']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'select',
'option_category' => 'layout',
'options' => array(
'top_left' => et_builder_i18n( 'Top Left' ),
'top_center' => et_builder_i18n( 'Top Center' ),
'top_right' => et_builder_i18n( 'Top Right' ),
'center_left' => et_builder_i18n( 'Center Left' ),
'center' => et_builder_i18n( 'Center' ),
'center_right' => et_builder_i18n( 'Center Right' ),
'bottom_left' => et_builder_i18n( 'Bottom Left' ),
'bottom_center' => et_builder_i18n( 'Bottom Center' ),
'bottom_right' => et_builder_i18n( 'Bottom Right' ),
),
'default' => 'center',
'default_on_child' => true,
'depends_show_if' => 'off',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'position',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_repeat" ] = self::background_field_template(
'repeat',
array(
'label' => $i18n['background']['repeat']['label'],
'description' => $i18n['background']['repeat']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'select',
'option_category' => 'layout',
'options' => array(
'no-repeat' => $i18n['background']['repeat']['options']['no-repeat'],
'repeat' => $i18n['background']['repeat']['options']['repeat'],
'repeat-x' => $i18n['background']['repeat']['options']['repeat-x'],
'repeat-y' => $i18n['background']['repeat']['options']['repeat-y'],
'space' => et_builder_i18n( 'Space' ),
'round' => $i18n['background']['repeat']['options']['round'],
),
'default' => 'no-repeat',
'default_on_child' => true,
'depends_show_if' => 'off',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'repeat',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_blend" ] = self::background_field_template(
'blend',
array(
'label' => $i18n['background']['blend']['label'],
'description' => $i18n['background']['blend']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'select',
'option_category' => 'layout',
'options' => array(
'normal' => et_builder_i18n( 'Normal' ),
'multiply' => et_builder_i18n( 'Multiply' ),
'screen' => et_builder_i18n( 'Screen' ),
'overlay' => et_builder_i18n( 'Overlay' ),
'darken' => et_builder_i18n( 'Darken' ),
'lighten' => et_builder_i18n( 'Lighten' ),
'color-dodge' => et_builder_i18n( 'Color Dodge' ),
'color-burn' => et_builder_i18n( 'Color Burn' ),
'hard-light' => et_builder_i18n( 'Hard Light' ),
'soft-light' => et_builder_i18n( 'Soft Light' ),
'difference' => et_builder_i18n( 'Difference' ),
'exclusion' => et_builder_i18n( 'Exclusion' ),
'hue' => et_builder_i18n( 'Hue' ),
'saturation' => et_builder_i18n( 'Saturation' ),
'color' => et_builder_i18n( 'Color' ),
'luminosity' => et_builder_i18n( 'Luminosity' ),
),
'default' => 'normal',
'default_on_child' => true,
'depends_show_if' => 'off',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'blend',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
}
if ( in_array( $background_tab, array( 'all', 'skip', 'video' ), true ) ) {
$options[ "{$base_name}_video_mp4" ] = self::background_field_template(
'video_mp4',
array(
'label' => $i18n['background']['mp4']['label'],
'description' => $i18n['background']['mp4']['description'],
'upload_button_text' => $i18n['background']['mp4']['upload_button_text'],
'choose_text' => $i18n['background']['mp4']['choose_text'],
'update_text' => $i18n['background']['mp4']['update_text'],
'type' => 'skip' === $background_tab ? 'skip' : 'upload',
'option_category' => 'configuration',
'data_type' => 'video',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'computed_affects' => array(
"__video_{$base_name}",
),
'field_template' => 'video_mp4',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
'affects_mobile' => true,
)
);
// This option is used to enable or disable background MP4 video on VB or FE. It's used
// to ensure if current background should be rendered or not by inheriting or applying
// custom MP4 video.
$options[ "{$base_name}_enable_video_mp4" ] = self::background_field_template(
'enable_video_mp4',
array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'default' => 'on',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_video_webm" ] = self::background_field_template(
'video_webm',
array(
'label' => $i18n['background']['webm']['label'],
'description' => $i18n['background']['webm']['description'],
'upload_button_text' => $i18n['background']['webm']['upload_button_text'],
'choose_text' => $i18n['background']['webm']['choose_text'],
'update_text' => $i18n['background']['webm']['update_text'],
'type' => 'skip' === $background_tab ? 'skip' : 'upload',
'option_category' => 'configuration',
'data_type' => 'video',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'computed_affects' => array(
"__video_{$base_name}",
),
'field_template' => 'video_webm',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
'affects_mobile' => true,
)
);
// This option is used to enable or disable background Webm video on VB or FE. It's used
// to ensure if current background should be rendered or not by inheriting or applying
// custom Webm video.
$options[ "{$base_name}_enable_video_webm" ] = self::background_field_template(
'enable_video_webm',
array(
'type' => 'skip',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'default' => 'on',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "{$base_name}_video_width" ] = self::background_field_template(
'video_width',
array(
'label' => $i18n['background']['video_width']['label'],
'description' => $i18n['background']['video_width']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'text',
'option_category' => 'configuration',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'computed_affects' => array(
"__video_{$base_name}",
),
'field_template' => 'video_width',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
'affects_mobile' => true,
)
);
$options[ "{$base_name}_video_height" ] = self::background_field_template(
'video_height',
array(
'label' => $i18n['background']['video_height']['label'],
'description' => $i18n['background']['video_height']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'text',
'option_category' => 'configuration',
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'computed_affects' => array(
"__video_{$base_name}",
),
'field_template' => 'video_height',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
'affects_mobile' => true,
)
);
$options[ "${baseless_prefix}allow_player_pause" ] = self::background_field_template(
'allow_player_pause',
array(
'label' => $i18n['background']['pause']['label'],
'description' => $i18n['background']['pause']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'No' ),
'on' => et_builder_i18n( 'Yes' ),
),
'default' => 'off',
'default_on_child' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'allow_player_pause',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "${base_name}_video_pause_outside_viewport" ] = self::background_field_template(
'video_pause_outside_viewport',
array(
'label' => $i18n['background']['viewport']['label'],
'description' => $i18n['background']['viewport']['description'],
'type' => 'skip' === $background_tab ? 'skip' : 'yes_no_button',
'option_category' => 'configuration',
'options' => array(
'off' => et_builder_i18n( 'No' ),
'on' => et_builder_i18n( 'Yes' ),
),
'default' => 'on',
'default_on_child' => true,
'tab_slug' => $tab_slug,
'toggle_slug' => $toggle_slug,
'field_template' => 'video_pause_outside_viewport',
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
$options[ "__video_{$base_name}" ] = self::background_field_template(
'video_computed',
array(
'type' => 'computed',
'computed_callback' => array( 'ET_Builder_Module_Helper_ResponsiveOptions', 'get_video_background' ),
'computed_depends_on' => array(
"{$base_name}_video_mp4",
"{$base_name}_video_webm",
"{$base_name}_video_width",
"{$base_name}_video_height",
),
'computed_minimum' => array(
"{$base_name}_video_mp4",
"{$base_name}_video_webm",
),
'computed_variables' => array(
'base_name' => $base_name,
),
'mobile_options' => true,
'sticky' => true,
'hover' => 'tabs',
)
);
}
foreach ( $options as $option_name => &$option ) {
$option['context'] = null === $context ? $base_name : $context;
}
return $options;
}
/**
* Get string of background fields UI. Used in place of background_color fields UI.
*
* @param array $all_fields list of all module fields.
*
* @param string $base_name background base name.
*
* @return string background fields UI
*/
public function wrap_settings_background_fields( $all_fields, $base_name = 'background' ) {
$tab_structure = $this->get_background_fields_structure( $base_name );
$tab_names = array_keys( $tab_structure );
$background_fields = $this->get_background_fields( $all_fields, $base_name );
// Concatenate background fields UI.
$background = '';
// Label.
$background .= sprintf(
'<label for="et_pb_background">%1$s</label>',
esc_html__( 'Background:', 'et_builder' )
);
// Field wrapper.
$background .= sprintf(
'<div class="et-pb-option-container et-pb-option-container-inner et-pb-option-container--background" data-base_name="%s">',
esc_attr( $base_name )
);
$tab_names_processed = array();
foreach ( $tab_names as $tab_nav_name ) {
if ( ! empty( $background_fields[ $tab_nav_name ] ) ) {
$tab_names_processed[] = sanitize_text_field( $tab_nav_name );
}
}
// Apply background UI if the module has more than one backgroundFields to avoid 3rd party module's field which uses `background_color` field and incorrectly rendered as background UI.
if ( count( $tab_names_processed ) < 2 ) {
return '';
}
// Tab Nav.
$background .= sprintf( '<%%= window.et_builder.options_template_output("background_tabs_nav",%1$s) %%>', wp_json_encode( $tab_names_processed ) );
// Tabs.
foreach ( $tab_names as $tab_name ) {
$background .= sprintf(
'<div class="et_pb_background-tab et_pb_background-tab--%1$s" data-tab="%1$s">',
esc_attr( $tab_name )
);
// Get tab's fields.
$tab_fields = $background_fields[ $tab_name ];
// Render gradient tab's preview.
if ( 'gradient' === $tab_name ) {
$background .= '<%= window.et_builder.options_template_output("background_gradient_buttons") %>';
}
// Tab's fields.
foreach ( $tab_fields as $tab_field_name => $tab_field ) {
if ( 'skip' === $tab_field['type'] ) {
continue;
}
$preview_class = '';
// Append field name.
$tab_field['name'] = $tab_field_name;
// Append preview class name.
if ( in_array( $tab_field['name'], array( "{$base_name}_color", "{$base_name}_image", "{$base_name}_url", "{$base_name}_video_mp4", "{$base_name}_video_webm" ), true ) ) {
$tab_field['has_preview'] = true;
$preview_class = ' et-pb-option--has-preview';
}
// Prepare field list attribute.
$depends = false;
$depends_attr = '';
if ( isset( $tab_field['depends_show_if'] ) || isset( $tab_field['depends_show_if_not'] ) ) {
$depends = true;
if ( isset( $tab_field['depends_show_if_not'] ) ) {
$depends_show_if_not = is_array( $tab_field['depends_show_if_not'] ) ? implode( ',', $tab_field['depends_show_if_not'] ) : $tab_field['depends_show_if_not'];
$depends_attr = sprintf( ' data-depends_show_if_not="%s"', esc_attr( $depends_show_if_not ) );
} else {
$depends_attr = sprintf( ' data-depends_show_if="%s"', esc_attr( $tab_field['depends_show_if'] ) );
}
}
// Append fields UI.
$background .= sprintf(
'<div class="et_pb_background-option et_pb_background-option--%1$s et_pb_background-template--%6$s %5$s et-pb-option--%1$s%2$s"%3$s data-option_name="%4$s">',
esc_attr( $tab_field_name ),
esc_attr( $preview_class ),
$depends_attr,
esc_attr( $tab_field['name'] ),
"{$base_name}_color" === $tab_field['name'] && 'background' !== $base_name ? 'et-pb-option-main' : 'et-pb-option',
isset( $tab_field['field_template'] ) ? esc_attr( $tab_field['field_template'] ) : ''
);
// This adds a CSS class based on whether it is `true` or `false`.
$this->is_background = true;
$background .= $this->wrap_settings_option_label( $tab_field );
$background .= $this->wrap_settings_option_field( $tab_field );
$this->is_background = false;
$background .= '</div>';
}
$background .= '</div>';
}
// End of field wrapper.
$background .= '</div>';
return $background;
}
/**
* Get field name with prefix.
*
* @param array $field Field.
*
* @return mixed|string
*/
public function get_field_name( $field ) {
$prefix = 'et_pb_';
// Option template convert array field into string id; return early to prevent error.
if ( is_string( $field ) ) {
return $prefix . 'option_template_' . $field;
}
// Don't add 'et_pb_' prefix to the "Admin Label" field.
if ( 'admin_label' === $field['name'] ) {
return $field['name'];
}
// Make sure the prefix is not doubled.
if ( strpos( $field['name'], $prefix ) === 0 ) {
return $field['name'];
}
return $prefix . $field['name'];
}
/**
* Get field name for use in underscore templates.
*
* @since 3.17.2
*
* @param array $field Field.
*
* @return string
*/
public function get_field_variable_name( $field ) {
$name = $this->get_field_name( $field );
if ( isset( $this->type ) && 'child' === $this->type ) {
$name = "data.{$name}";
}
$name = str_replace( '-', '_', $name );
return $name;
}
/**
* Process field attributes into markup.
*
* @param array $field Field.
* @param array $attributes Field attributes.
*/
public function process_html_attributes( $field, &$attributes ) {
if ( is_array( $field['attributes'] ) ) {
foreach ( $field['attributes'] as $attribute_key => $attribute_value ) {
$attributes .= ' ' . esc_attr( $attribute_key ) . '="' . esc_attr( $attribute_value ) . '"';
}
} else {
$attributes = ' ' . $field['attributes'];
}
}
/**
* Returns an underscore template for the options settings.
*
* @since 3.23 Disable mobile options (responsive settings) on unsupported field types. It's
* added to adapt Options Harmony v2. Fix unexpected token because composite fields
* with range type load empty last edited value.
*
* @param array $field {
* Associative array.
*
* @type 'id' => (int),
* @type string 'label' => (string),
* @type string 'description' => (string),
* @type string 'class' => (string),
* @type string 'type' => (string),
* @type string 'validate_input' => (bool),
* @type string 'name' => (string),
* @type string 'default' => (string),
* @type string 'defaults' => (array),
* @type string 'options' => (array),
* @type string 'option_category' => (string),
* @type string 'attributes' => (string),
* @type string 'affects' => (string),
* @type string 'before' => (string),
* @type string 'after' => (string),
* @type string 'display_if' => (string),
* @type string 'depends_on' => (string),
* @type string 'depends_show_if' => (string),
* @type string 'depends_show_if_not' => (string),
* @type string 'show_if' => (string),
* @type string 'show_if_not' => (string),
* @type string 'tab_slug' => (string),
* @type string 'toggle_slug' => (string),
* @type string 'composite_type' => (string),
* @type string 'composite_structure' => (array),
* }
* @param string $name Field name.
*
* @return string HTML underscore template.
*/
public function render_field( $field, $name = '' ) {
$classes = array();
$hidden_field = '';
$field_el = '';
$is_custom_color = isset( $field['custom_color'] ) && $field['custom_color'];
$reset_button_html = '<span class="et-pb-reset-setting"></span>';
$need_mobile_options = isset( $field['mobile_options'] ) && $field['mobile_options'] ? true : false;
$only_options = isset( $field['only_options'] ) ? $field['only_options'] : false;
$is_child = isset( $this->type ) && 'child' === $this->type;
// Option template convert array field into string id; return early to prevent error.
if ( is_string( $field ) ) {
return '';
}
// Make sure 'type' is always set to prevent PHP notices.
if ( empty( $field['type'] ) ) {
$field['type'] = 'no-type';
}
// Disable mobile options for unsupported types. Before Options Harmony v2, only custom
// margin/padding, text/number, and range support responsive settings. Later on, we added
// responsive settings to all settings. However BB is no longer supported, so we need to
// disable mobile options on those selected field types.
$unsupported_mobile_options = array( 'upload-gallery', 'background-field', 'warning', 'tiny_mce', 'codemirror', 'textarea', 'custom_css', 'options_list', 'sortable_list', 'conditional_logic', 'text_align', 'align', 'select', 'divider', 'yes_no_button', 'multiple_buttons', 'font', 'select_with_option_groups', 'select_animation', 'presets_shadow', 'select_box_shadow', 'presets', 'color', 'color-alpha', 'upload', 'checkbox', 'multiple_checkboxes', 'hidden' );
if ( $need_mobile_options && in_array( $field['type'], $unsupported_mobile_options, true ) ) {
$need_mobile_options = false;
}
if ( $need_mobile_options ) {
$mobile_settings_tabs = et_pb_generate_mobile_settings_tabs();
}
if ( 0 !== strpos( $field['type'], 'select' ) ) {
$classes = array( 'regular-text' );
}
foreach ( $this->get_validation_class_rules() as $rule ) {
if ( ! empty( $field[ $rule ] ) ) {
$this->validation_in_use = true;
$classes[] = $rule;
}
}
if ( isset( $field['validate_unit'] ) && $field['validate_unit'] ) {
$classes[] = 'et-pb-validate-unit';
}
if ( ! empty( $field['class'] ) ) {
if ( is_string( $field['class'] ) ) {
$field['class'] = array( $field['class'] );
}
$classes = array_merge( $classes, $field['class'] );
}
$field['class'] = implode( ' ', $classes );
$field_name = $this->get_field_name( $field );
$field['id'] = ! empty( $field['id'] ) ? $field['id'] : $field_name;
$field['name'] = $field_name;
if ( $is_child ) {
$field_name = "data.{$field_name}";
}
$field_var_name = $this->get_field_variable_name( $field );
$default_on_front = self::$_->array_get( $field, 'default_on_front', '' );
$default_arr = self::$_->array_get( $field, 'default', $default_on_front );
// Inform that default value is array and last edited value maybe empty string. Decided to
// create new variable, just in case $default_arr will be modified later.
$default_last_edited_is_arr = false;
if ( is_array( $default_arr ) && isset( $default_arr[1] ) && is_array( $default_arr[1] ) ) {
list($default_parent_id, $defaults_list) = $default_arr;
$default_parent_id = sprintf( '%1$set_pb_%2$s', $is_child ? 'data.' : '', $default_parent_id );
$default = esc_attr( wp_json_encode( $default_arr ) );
$default_value = sprintf(
'(typeof(%1$s) !== \'undefined\' ? ( typeof(%1$s) === \'object\' ? (%2$s)[jQuery(%1$s).val()] : (%2$s)[%1$s] ) : \'\')',
$default_parent_id,
wp_json_encode( $defaults_list )
);
$default_is_arr = true;
$default_last_edited_is_arr = true;
} else {
$default_value = $default_arr;
$default = $default_value;
$default_is_arr = false;
}
if ( 'font' === $field['type'] ) {
$default = '' === $default ? '||||||||' : $default;
$default_value = '' === $default_value ? '||||||||' : $default_value;
}
$font_icon_options = array( 'et_pb_font_icon', 'et_pb_button_icon', 'et_pb_button_one_icon', 'et_pb_button_two_icon', 'et_pb_hover_icon' );
if ( in_array( $field_name, $font_icon_options, true ) ) {
$field_value = esc_attr( $field_var_name );
} else {
$field_value = esc_attr( $field_var_name ) . '.replace(/%91/g, "[").replace(/%93/g, "]").replace(/%22/g, "\"")';
}
$value_html = $default_is_arr
? ' value="<%%- typeof( %1$s ) !== \'undefined\' ? %2$s : %3$s %%>" '
: ' value="<%%- typeof( %1$s ) !== \'undefined\' ? %2$s : \'%3$s\' %%>" ';
$value = sprintf(
$value_html,
esc_attr( $field_var_name ),
$field_value,
$default_value
);
$attributes = '';
if ( ! empty( $field['attributes'] ) ) {
$this->process_html_attributes( $field, $attributes );
}
if ( ! empty( $field['affects'] ) ) {
$field['class'] .= ' et-pb-affects';
$attributes .= sprintf( ' data-affects="%s"', esc_attr( implode( ', ', $field['affects'] ) ) );
}
if ( ! empty( $field['responsive_affects'] ) ) {
$field['class'] .= ' et-pb-responsive-affects';
$attributes .= sprintf(
' data-responsive-affects="%1$s" data-responsive-desktop-name="%2$s"',
esc_attr( implode( ', ', $field['responsive_affects'] ) ),
esc_attr( $field['name'] )
);
}
if ( 'font' === $field['type'] ) {
$field['class'] .= ' et-pb-font-select';
}
if ( in_array( $field['type'], array( 'font', 'hidden', 'multiple_checkboxes', 'select_with_option_groups', 'select_animation', 'presets', 'presets_shadow', 'select_box_shadow' ), true ) && ! $only_options ) {
$hidden_field = sprintf(
'<input type="hidden" name="%1$s" id="%2$s" class="et-pb-main-setting %3$s" data-default="%4$s" %5$s %6$s/>',
esc_attr( $field['name'] ),
esc_attr( $field['id'] ),
esc_attr( $field['class'] ),
esc_attr( $default ),
$value,
$attributes
);
if ( 'select_with_option_groups' === $field['type'] ) {
// Since we are using a hidden field to manage the value, we need to clear the data-affects attribute so that
// it doesn't appear on both the `$field` AND the hidden field. This should probably be done for all of these
// field types but don't want to risk breaking anything :-/.
$attributes = preg_replace( '/data-affects="[\w\s,-]*"/', 'data-affects=""', $attributes );
}
}
foreach ( $this->get_validation_attr_rules() as $rule ) {
if ( ! empty( $field[ $rule ] ) ) {
$this->validation_in_use = true;
$attributes .= ' data-rule-' . esc_attr( $rule ) . '="' . esc_attr( $field[ $rule ] ) . '"';
}
}
if ( isset( $field['before'] ) && ! $only_options ) {
$field_el .= $this->render_field_before_after_element( $field['before'] );
}
switch ( $field['type'] ) {
case 'upload-gallery':
$field_el .= sprintf(
'<input type="button" class="button button-upload et-pb-gallery-button" value="%1$s" />' .
'<input type="hidden" name="%3$s" id="%4$s" class="et-pb-gallery" %2$s />',
esc_attr__( 'Update Gallery', 'et_builder' ),
$value,
esc_attr( $field['name'] ),
esc_attr( $field['id'] )
);
break;
case 'background-field':
$field_el .= $this->wrap_settings_background_fields( $field['background_fields'], $field['base_name'] );
break;
case 'warning':
$field_el .= sprintf(
'<div class="et-pb-option-warning" data-name="%2$s" data-display_if="%3$s">%1$s</div>',
html_entity_decode( esc_html( $field['message'] ) ),
esc_attr( $field['name'] ),
esc_attr( $field['display_if'] )
);
break;
case 'tiny_mce':
if ( ! empty( $field['tiny_mce_html_mode'] ) ) {
$field['class'] .= ' html_mode';
}
$main_content_field_name = 'et_pb_content';
$main_content_property_name = $main_content_field_name;
if ( isset( $this->type ) && 'child' === $this->type ) {
$main_content_property_name = "data.{$main_content_property_name}";
}
if ( 'et_pb_signup' === $this->slug ) {
$main_content_field_name = $field['name'];
$main_content_property_name = $main_content_field_name;
}
$field_el .= sprintf(
'<div id="%1$s" class="et_pb_tiny_mce_field"><%%= typeof( %2$s ) !== \'undefined\' ? %2$s : \'\' %%></div>',
esc_attr( $main_content_field_name ),
esc_html( $main_content_property_name )
);
break;
case 'codemirror':
case 'textarea':
case 'custom_css':
case 'options_list':
case 'sortable_list':
$field_custom_value = esc_html( $field_var_name );
if ( in_array( $field['type'], array( 'custom_css', 'options_list', 'sortable_list' ), true ) ) {
$field_custom_value .= '.replace( /\|\|/g, "\n" ).replace( /%22/g, """ ).replace( /%92/g, "\\\" )';
$field_custom_value .= '.replace( /%91/g, "[" ).replace( /%93/g, "]" )';
}
if ( in_array( $field_name, array( 'et_pb_custom_message' ), true ) ) {
// escape html to make sure it's not rendered inside the Textarea field in Settings Modal.
$field_custom_value = sprintf( '_.escape( %1$s )', $field_custom_value );
}
$field_el .= sprintf(
'<textarea class="et-pb-main-setting large-text code%1$s" rows="4" cols="50" id="%2$s"><%%= typeof( %3$s ) !== \'undefined\' ? %4$s : \'\' %%></textarea>',
esc_attr( $field['class'] ),
esc_attr( $field['id'] ),
esc_html( $field_var_name ),
et_core_esc_previously( $field_custom_value )
);
if ( 'options_list' === $field['type'] || 'sortable_list' === $field['type'] ) {
$radio_check = '';
$row_class = 'et_options_list_row';
if ( isset( $field['checkbox'] ) && true === $field['checkbox'] ) {
$radio_check = '<a href="#" class="et_options_list_check"></a>';
$row_class .= ' et_options_list_row_checkbox';
}
if ( isset( $field['radio'] ) && true === $field['radio'] ) {
$radio_check = '<a href="#" class="et_options_list_check"></a>';
$row_class .= ' et_options_list_row_radio';
}
$field_el = sprintf(
'<div class="et_options_list">
<div class="%5$s">
%6$s
<input type="text" />
<div class="et_options_list_actions">
<a href="#" class="et_options_list_move"></a>
<a href="#" class="et_options_list_copy"></a>
<a href="#" class="et_options_list_remove"></a>
</div>
</div>
<textarea class="et-pb-main-setting large-text code%1$s" rows="4" cols="50" id="%2$s"><%%= typeof( %3$s ) !== \'undefined\' ? %4$s : \'\' %%></textarea>
<a href="#" class="et-pb-add-sortable-option"><span>%7$s</span></a>
</div>',
esc_attr( $field['class'] ),
esc_attr( $field['id'] ),
esc_html( $field_var_name ),
et_core_esc_previously( $field_custom_value ),
esc_attr( $row_class ),
$radio_check,
esc_html__( 'Add New Item', 'et_builder' )
);
}
break;
case 'conditional_logic':
$field_custom_value = esc_html( $field_var_name );
$field_custom_value .= '.replace( /\|\|/g, "\n" ).replace( /%22/g, """ ).replace( /%92/g, "\\\" )';
$field_custom_value .= '.replace( /%91/g, "[" ).replace( /%93/g, "]" )';
$field_selects = sprintf(
'<select class="et_conditional_logic_field"></select>
<select class="et_conditional_logic_condition">
<option value="is">%1$s</option>
<option value="is not">%2$s</option>
<option value="is greater">%3$s</option>
<option value="is less">%4$s</option>
<option value="contains">%5$s</option>
<option value="does not contain">%6$s</option>
<option value="is empty">%7$s</option>
<option value="is not empty">%8$s</option>
</select>',
esc_html__( 'equals', 'et_builder' ),
esc_html__( 'does not equal', 'et_builder' ),
esc_html__( 'is greater than', 'et_builder' ),
esc_html__( 'is less than', 'et_builder' ),
esc_html__( 'contains', 'et_builder' ),
esc_html__( 'does not contain', 'et_builder' ),
esc_html__( 'is empty', 'et_builder' ),
esc_html__( 'is not empty', 'et_builder' )
);
$field_el = sprintf(
'<div class="et_options_list et_conditional_logic" data-checked="%6$s" data-unchecked="%7$s">
<div class="et_options_list_row">
%5$s
<a href="#" class="et_options_list_remove"></a>
</div>
<textarea class="et-pb-main-setting large-text code%1$s" rows="4" cols="50" id="%2$s"><%%= typeof( %3$s ) !== \'undefined\' ? %4$s : \'\' %%></textarea>
<a href="#" class="et-pb-add-sortable-option"><span>%8$s</span></a>
</div>',
esc_attr( $field['class'] ),
esc_attr( $field['id'] ),
esc_html( $field_var_name ),
et_core_esc_previously( $field_custom_value ),
$field_selects,
esc_html__( 'checked', 'et_builder' ),
esc_html__( 'not checked', 'et_builder' ),
esc_html__( 'Add New Rule', 'et_builder' )
);
break;
case 'align':
case 'text_align':
case 'select':
case 'divider':
case 'yes_no_button':
case 'multiple_buttons':
case 'font':
case 'select_with_option_groups':
$is_align = in_array( $field['type'], array( 'text_align', 'align' ), true );
if ( 'font' === $field['type'] ) {
$field['id'] .= '_select';
$field_name .= '_select';
$field['class'] .= ' et-pb-helper-field';
$field['options'] = array();
}
if ( $is_align ) {
$field['class'] = 'et-pb-text-align-select';
}
$button_options = array();
if ( 'yes_no_button' === $field['type'] ) {
$button_options = isset( $field['button_options'] ) ? $field['button_options'] : array();
}
if ( $default ) {
$attributes .= sprintf( ' data-default="%1$s"', esc_attr( $default ) );
}
// If default is an array, then $default_value value is an js expression, so it doesn't need to be encoded
// In other case it needs to be encoded.
$select_default = $default_is_arr ? $default_value : wp_json_encode( $default_value );
if ( 'font' === $field['type'] ) {
$group_label = isset( $field['group_label'] ) ? $field['group_label'] : '';
$select = $this->render_font_select( $field_name, $field['id'], $group_label );
} elseif ( 'multiple_buttons' === $field['type'] ) {
if ( isset( $field['toggleable'] ) && $field['toggleable'] ) {
$attributes .= ' data-toggleable="yes"';
}
if ( isset( $field['multi_selection'] ) && $field['multi_selection'] ) {
$attributes .= ' data-multi="yes"';
}
$select = $this->render_multiple_buttons( $field_name, $field['options'], $field['id'], $field['class'], $attributes, $value, $default_value );
} else {
$select = $this->render_select( $field_name, $field['options'], $field['id'], $field['class'], $attributes, $field['type'], $button_options, $select_default, $only_options );
}
if ( $only_options ) {
$field_el = $select;
} else {
$field_el .= $select;
}
if ( 'font' === $field['type'] ) {
$font_style_button_html = sprintf(
'<%%= window.et_builder.options_template_output("font_buttons",%1$s) %%>',
wp_json_encode( array( 'italic', 'uppercase', 'capitalize', 'underline', 'line_through' ) )
);
$field_el .= sprintf(
'<div class="et_builder_font_styles mce-toolbar">
%1$s
</div>',
$font_style_button_html
);
$field_el .= '<%= window.et_builder.options_template_output("font_line_styles") %>';
$field_el .= $hidden_field;
}
if ( $is_align ) {
$text_align_options = ! empty( $field['options'] ) ? array_keys( $field['options'] ) : array( 'left', 'center', 'right', 'justified' );
$is_module_alignment = 'align' === $field['type'] || ( in_array( $field['name'], array( 'et_pb_module_alignment', 'et_pb_button_alignment' ), true ) || ( isset( $field['options_icon'] ) && 'module_align' === $field['options_icon'] ) );
$text_align_style_button_html = sprintf(
'<%%= window.et_builder.options_text_align_buttons_output(%1$s, "%2$s") %%>',
wp_json_encode( $text_align_options ),
$is_module_alignment ? 'module' : 'text'
);
$field_el .= sprintf(
'<div class="et_builder_text_aligns mce-toolbar">
%1$s
</div>',
$text_align_style_button_html
);
$field_el .= $hidden_field;
}
if ( 'select_with_option_groups' === $field['type'] ) {
$field_el .= $hidden_field;
}
break;
case 'select_animation':
$options = $field['options'];
$animation_buttons_array = array();
foreach ( $options as $option_name => $option_title ) {
$animation_buttons_array[ $option_name ] = sanitize_text_field( $option_title );
}
$animation_buttons = sprintf( '<%%= window.et_builder.options_template_output("animation_buttons",%1$s) %%>', wp_json_encode( $animation_buttons_array ) );
$field_el = sprintf(
'<div class="et_select_animation et-pb-main-setting" data-default="none">
%1$s
%2$s
</div>',
$animation_buttons,
$hidden_field
);
break;
case 'presets_shadow':
case 'select_box_shadow':
case 'presets':
$presets = $field['presets'];
$presets_buttons = '';
foreach ( $presets as $preset ) {
$fields = isset( $preset['fields'] )
? htmlspecialchars( wp_json_encode( $preset['fields'] ), ENT_QUOTES, 'UTF-8' )
: '[]';
$presets_buttons .= sprintf(
'<div class="et-preset" data-value="%1$s" data-fields="%2$s">',
esc_attr( $preset['value'] ),
esc_attr( $fields )
);
if ( isset( $preset['title'] ) && ! empty( $preset['title'] ) ) {
$presets_buttons .= sprintf(
'<span class="et-preset-title" >%1$s</span>',
$preset['title']
);
}
if ( isset( $preset['icon'] ) && ! empty( $preset['icon'] ) ) {
$presets_buttons .= sprintf(
'<span class="et-preset-icon">%1$s</span>',
$this->get_icon( $preset['icon'] )
);
}
if ( isset( $preset['content'] ) && ! empty( $preset['content'] ) ) {
if ( is_array( $preset['content'] ) ) {
$content = isset( $preset['content']['content'] ) ? $preset['content']['content'] : '';
$class = isset( $preset['content']['class'] ) ? ' ' . $preset['content']['class'] : '';
} else {
$content = $preset['content'];
$class = '';
}
$presets_buttons .= sprintf(
'<span class="et-preset-content%2$s">%1$s</span>',
$content,
$class
);
}
$presets_buttons .= '</div>';
}
$field_el = sprintf(
'<div class="et-presets et-preset-container et-pb-main-setting %3$s" data-default="none">
%1$s
%2$s
</div>',
$presets_buttons,
$hidden_field,
esc_attr( $field['type'] )
);
break;
case 'color':
case 'color-alpha':
$field['default'] = ! empty( $field['default'] ) ? $field['default'] : '';
if ( $is_custom_color && ( ! isset( $field['default'] ) || '' === $field['default'] ) ) {
$field['default'] = '';
}
$default = ! empty( $field['default'] ) ? sprintf( ' data-default-color="%1$s" data-default="%1$s"', esc_attr( $field['default'] ) ) : '';
$color_id = sprintf( ' id="%1$s"', esc_attr( $field['id'] ) );
$color_value_html = '<%%- typeof( %1$s ) !== \'undefined\' && %1$s !== \'\' ? %1$s : \'%2$s\' %%>';
$main_color_value = sprintf( $color_value_html, esc_attr( $field_var_name ), $field['default'] );
$hidden_color_value = sprintf( $color_value_html, esc_attr( $field_var_name ), '' );
$has_preview = isset( $field['has_preview'] ) && $field['has_preview'];
$field_el = sprintf(
'<input%1$s class="et-pb-color-picker-hex%5$s%8$s%10$s" type="text"%6$s%7$s placeholder="%9$s" data-selected-value="%2$s" value="%2$s"%3$s />
%4$s',
( ! $is_custom_color || $has_preview ? $color_id : '' ),
$main_color_value,
$default,
( ! empty( $field['additional_code'] ) ? $field['additional_code'] : '' ),
( 'color-alpha' === $field['type'] ? ' et-pb-color-picker-hex-alpha' : '' ),
( 'color-alpha' === $field['type'] ? ' data-alpha="true"' : '' ),
( 'color' === $field['type'] ? ' maxlength="7"' : '' ),
( ! $is_custom_color ? ' et-pb-main-setting' : '' ),
esc_attr__( 'Hex Value', 'et_builder' ),
$has_preview ? esc_attr( ' et-pb-color-picker-hex-has-preview' ) : ''
);
if ( $is_custom_color && ! $has_preview ) {
$field_el = sprintf(
'<span class="et-pb-custom-color-button et-pb-choose-custom-color-button"><span>%1$s</span></span>
<div class="et-pb-custom-color-container et_pb_hidden">
%2$s
<input%3$s class="et-pb-main-setting et-pb-custom-color-picker" type="hidden" value="%4$s" %6$s />
%5$s
</div>',
esc_html__( 'Choose Custom Color', 'et_builder' ),
$field_el,
$color_id,
$hidden_color_value,
$reset_button_html,
$attributes
);
}
break;
case 'upload':
$field_data_type = ! empty( $field['data_type'] ) ? $field['data_type'] : 'image';
$field['upload_button_text'] = ! empty( $field['upload_button_text'] ) ? $field['upload_button_text'] : esc_attr__( 'Upload', 'et_builder' );
$field['choose_text'] = ! empty( $field['choose_text'] ) ? $field['choose_text'] : esc_attr__( 'Choose image', 'et_builder' );
$field['update_text'] = ! empty( $field['update_text'] ) ? $field['update_text'] : esc_attr__( 'Set image', 'et_builder' );
$field['class'] = ! empty( $field['class'] ) ? ' ' . $field['class'] : '';
$field_additional_button = ! empty( $field['additional_button'] ) ? "\n\t\t\t\t\t" . $field['additional_button'] : '';
$field_el .= sprintf(
'<input id="%1$s" type="text" class="et-pb-main-setting regular-text et-pb-upload-field%8$s" value="<%%- typeof( %2$s ) !== \'undefined\' ? %2$s : \'\' %%>" %9$s />
<input type="button" class="button button-upload et-pb-upload-button" value="%3$s" data-choose="%4$s" data-update="%5$s" data-type="%6$s" />%7$s',
esc_attr( $field['id'] ),
esc_attr( $field_var_name ),
esc_attr( $field['upload_button_text'] ),
esc_attr( $field['choose_text'] ),
esc_attr( $field['update_text'] ),
esc_attr( $field_data_type ),
$field_additional_button,
esc_attr( $field['class'] ),
$attributes
);
break;
case 'checkbox':
$field_el .= sprintf(
'<input type="checkbox" name="%1$s" id="%2$s" class="et-pb-main-setting" value="on" <%%- typeof( %3$s ) !== \'undefined\' && %3$s === \'on\' ? checked="checked" : "" %%>>',
esc_attr( $field['name'] ),
esc_attr( $field['id'] ),
esc_attr( str_replace( '-', '_', $field['name'] ) )
);
break;
case 'multiple_checkboxes':
$checkboxes_set = '<div class="et_pb_checkboxes_wrapper">';
if ( ! empty( $field['options'] ) ) {
foreach ( $field['options'] as $option_value => $option_label ) {
$checkboxes_set .= sprintf(
'%3$s<label><input type="checkbox" class="et_pb_checkbox_%1$s" value="%1$s"> %2$s</label><br/>',
esc_attr( $option_value ),
esc_html( $option_label ),
"\n\t\t\t\t\t"
);
}
}
// additional option for disable_on option for backward compatibility.
if ( isset( $field['additional_att'] ) && 'disable_on' === $field['additional_att'] ) {
$et_pb_disabled_value = sprintf(
$value_html,
esc_attr( 'et_pb_disabled' ),
esc_attr( 'et_pb_disabled' ),
''
);
$checkboxes_set .= sprintf(
'<input type="hidden" id="et_pb_disabled" class="et_pb_disabled_option"%1$s>',
$et_pb_disabled_value
);
}
$field_el .= $checkboxes_set . $hidden_field . '</div>';
break;
case 'hidden':
$field_el .= $hidden_field;
break;
case 'custom_margin':
case 'custom_padding':
$custom_margin_class = '';
// Fill the array of values for tablet and phone.
if ( $need_mobile_options ) {
$mobile_values_array = array();
$has_saved_value = array();
$mobile_desktop_class = ' et_pb_setting_mobile et_pb_setting_mobile_desktop et_pb_setting_mobile_active';
$mobile_desktop_data = ' data-device="desktop"';
foreach ( array( 'tablet', 'phone' ) as $device ) {
$mobile_values_array[] = sprintf(
$value_html,
esc_attr( $field_var_name . '_' . $device ),
esc_attr( $field_var_name . '_' . $device ),
$default_value
);
$has_saved_value[] = sprintf(
' data-has_saved_value="<%%- typeof( %1$s ) !== \'undefined\' ? \'yes\' : \'no\' %%>" ',
esc_attr( $field_var_name . '_' . $device )
);
}
$value_last_edited = sprintf(
$value_html,
esc_attr( $field_var_name . '_last_edited' ),
esc_attr( $field_var_name . '_last_edited' ),
''
);
// additional field to save the last edited field which will be opened automatically.
$additional_mobile_fields = sprintf(
'<input id="%1$s" type="hidden" class="et_pb_mobile_last_edited_field"%2$s>',
esc_attr( $field_name . '_last_edited' ),
$value_last_edited
);
}
// Add auto_important class to field which automatically append !important tag.
if ( isset( $this->advanced_fields['margin_padding']['css']['important'] ) ) {
$custom_margin_class .= ' auto_important';
}
$has_responsive_affects = isset( $field['responsive_affects'] );
$single_fields_settings = array(
'side' => '',
'label' => '',
'need_mobile' => $need_mobile_options ? 'need_mobile' : '',
'class' => esc_attr( $custom_margin_class ),
);
$field_el .= sprintf(
'<div class="et_margin_padding">
%6$s
%7$s
%8$s
%9$s
<input type="hidden" name="%1$s" data-default="%5$s" id="%2$s" class="et_custom_margin_main et-pb-main-setting%11$s%14$s"%12$s %3$s %4$s/>
%10$s
%13$s
</div>',
esc_attr( $field['name'] ),
esc_attr( $field['id'] ),
$value,
$attributes,
esc_attr( $default ), // #5
! isset( $field['sides'] ) || ( ! empty( $field['sides'] ) && in_array( 'top', $field['sides'], true ) ) ?
sprintf(
'<%%= window.et_builder.options_template_output("padding",%1$s) %%>',
wp_json_encode(
array_merge(
$single_fields_settings,
array(
'side' => 'top',
'label' => et_builder_i18n( 'Top' ),
)
)
)
) : '',
! isset( $field['sides'] ) || ( ! empty( $field['sides'] ) && in_array( 'right', $field['sides'], true ) ) ?
sprintf(
'<%%= window.et_builder.options_template_output("padding",%1$s) %%>',
wp_json_encode(
array_merge(
$single_fields_settings,
array(
'side' => 'right',
'label' => et_builder_i18n( 'Right' ),
)
)
)
) : '',
! isset( $field['sides'] ) || ( ! empty( $field['sides'] ) && in_array( 'bottom', $field['sides'], true ) ) ?
sprintf(
'<%%= window.et_builder.options_template_output("padding",%1$s) %%>',
wp_json_encode(
array_merge(
$single_fields_settings,
array(
'side' => 'bottom',
'label' => et_builder_i18n( 'Bottom' ),
)
)
)
) : '',
! isset( $field['sides'] ) || ( ! empty( $field['sides'] ) && in_array( 'left', $field['sides'], true ) ) ?
sprintf(
'<%%= window.et_builder.options_template_output("padding",%1$s) %%>',
wp_json_encode(
array_merge(
$single_fields_settings,
array(
'side' => 'left',
'label' => et_builder_i18n( 'Left' ),
)
)
)
) : '',
$need_mobile_options ?
sprintf(
'<input type="hidden" name="%1$s_tablet" data-default="%4$s" id="%2$s_tablet" class="et-pb-main-setting et_custom_margin_main et_pb_setting_mobile et_pb_setting_mobile_tablet%9$s" data-device="tablet" %5$s %3$s %7$s/>
<input type="hidden" name="%1$s_phone" data-default="%4$s" id="%2$s_phone" class="et-pb-main-setting et_custom_margin_main et_pb_setting_mobile et_pb_setting_mobile_phone%9$s" data-device="phone" %6$s %3$s %8$s/>',
esc_attr( $field['name'] ),
esc_attr( $field['id'] ),
$attributes,
esc_attr( $default ),
$mobile_values_array[0],
$mobile_values_array[1],
$has_saved_value[0],
$has_saved_value[1],
$has_responsive_affects ? ' et-pb-responsive-affects' : ''
)
: '', // #10
$need_mobile_options ? esc_attr( $mobile_desktop_class ) : '',
$need_mobile_options ? $mobile_desktop_data : '',
$need_mobile_options ? $additional_mobile_fields : '',
$has_responsive_affects ? ' et-pb-responsive-affects' : '' // #14
);
break;
case 'text':
case 'number':
case 'date_picker':
case 'range':
default:
$validate_number = isset( $field['number_validation'] ) && $field['number_validation'] ? true : false;
if ( 'date_picker' === $field['type'] ) {
$field['class'] .= ' et-pb-date-time-picker';
}
$field['class'] .= 'range' === $field['type'] ? ' et-pb-range-input' : ' et-pb-main-setting';
$type = in_array( $field['type'], array( 'text', 'number' ), true ) ? $field['type'] : 'text';
$unit = isset( $field['default_unit'] ) ? 'data-unit="' . esc_attr( $field['default_unit'] ) . '"' : '';
$field_el .= sprintf(
'<input id="%1$s" type="%11$s" class="%2$s%5$s%9$s"%6$s%3$s%8$s%10$s %4$s %12$s/>%7$s',
esc_attr( $field['id'] ),
esc_attr( $field['class'] ),
$value,
$attributes,
( $validate_number ? ' et-validate-number' : '' ),
( $validate_number ? ' maxlength="3"' : '' ),
( ! empty( $field['additional_button'] ) ? $field['additional_button'] : '' ),
( '' !== $default
? sprintf( ' data-default="%1$s"', esc_attr( $default ) )
: ''
),
$need_mobile_options ? ' et_pb_setting_mobile et_pb_setting_mobile_active et_pb_setting_mobile_desktop' : '',
$need_mobile_options ? ' data-device="desktop"' : '',
$type,
$unit
);
// generate additional fields for mobile settings switcher if needed.
if ( $need_mobile_options ) {
$additional_fields = '';
foreach ( array( 'tablet', 'phone' ) as $device_type ) {
$value_mobile = sprintf(
$value_html,
esc_attr( $field_var_name . '_' . $device_type ),
esc_attr( $field_var_name . '_' . $device_type ),
$default_value
);
// additional data attribute to handle default values for the responsive options.
$has_saved_value = sprintf(
' data-has_saved_value="<%%- typeof( %1$s ) !== \'undefined\' ? \'yes\' : \'no\' %%>" ',
esc_attr( $field_var_name . '_' . $device_type )
);
$additional_fields .= sprintf(
'<input id="%2$s" type="%11$s" class="%3$s%5$s et_pb_setting_mobile et_pb_setting_mobile_%9$s"%6$s%8$s%1$s data-device="%9$s" %4$s%10$s/>%7$s',
$value_mobile,
esc_attr( $field['id'] ) . '_' . $device_type,
esc_attr( $field['class'] ),
$attributes,
( $validate_number ? ' et-validate-number' : '' ), // #5
( $validate_number ? ' maxlength="3"' : '' ),
( ! empty( $field['additional_button'] ) ? $field['additional_button'] : '' ),
( '' !== $default
? sprintf( ' data-default="%1$s"', esc_attr( $default ) )
: ''
),
esc_attr( $device_type ),
$has_saved_value, // #10,
$type
);
}
// Replace value HTML of last edited field. Last edited value maybe an empty
// string on some range input under Shadow settings.
$last_edited_value_html = $default_last_edited_is_arr
? ' value="<%%- typeof( %1$s ) !== \'undefined\' ? %2$s : \'%3$s\' %%>" '
: $value_html;
$value_last_edited = sprintf(
$last_edited_value_html,
esc_attr( $field_var_name . '_last_edited' ),
esc_attr( $field_var_name . '_last_edited' ),
''
);
$class_last_edited = array(
'et_pb_mobile_last_edited_field',
);
$attrs = '';
if ( ! empty( $field['responsive_affects'] ) ) {
$class_last_edited[] = 'et-pb-responsive-affects';
$attrs .= sprintf(
' data-responsive-affects="%1$s" data-responsive-desktop-name="%2$s"',
esc_attr( implode( ', ', $field['responsive_affects'] ) ),
esc_attr( $field['name'] )
);
}
// additional field to save the last edited field which will be opened automatically.
$additional_fields .= sprintf(
'<input id="%1$s" type="hidden" class="%3$s"%2$s%4$s>',
esc_attr( $field_name . '_last_edited' ),
$value_last_edited,
esc_attr( implode( ' ', $class_last_edited ) ),
$attrs
);
}
if ( 'range' === $field['type'] ) {
$range_value_html = $default_is_arr
? ' value="<%%- typeof( %1$s ) !== \'undefined\' ? %2$s :parseFloat(%3$s) %%>" '
: ' value="<%%- typeof( %1$s ) !== \'undefined\' ? %2$s : parseFloat(\'%3$s\') %%>" ';
$value = sprintf(
$range_value_html,
esc_attr( $field_var_name ),
esc_attr( sprintf( 'parseFloat( %1$s )', $field_var_name ) ),
$default_value
);
$fixed_range = isset( $field['fixed_range'] ) && $field['fixed_range'];
$range_settings_html = '';
$range_properties = apply_filters( 'et_builder_range_properties', array( 'min', 'max', 'step' ) );
foreach ( $range_properties as $property ) {
if ( isset( $field['range_settings'][ $property ] ) ) {
$range_settings_html .= sprintf(
' %2$s="%1$s"',
esc_attr( $field['range_settings'][ $property ] ),
esc_html( $property )
);
}
}
$range_el = sprintf(
'<input type="range" data-name="%7$s" class="et-pb-main-setting et-pb-range%4$s%6$s" data-default="%2$s"%1$s%3$s%5$s %8$s />',
$value,
esc_attr( $default ),
$range_settings_html,
$need_mobile_options ? ' et_pb_setting_mobile et_pb_setting_mobile_desktop et_pb_setting_mobile_active' : '',
$need_mobile_options ? ' data-device="desktop"' : '',
$fixed_range ? ' et-pb-fixed-range' : '',
esc_attr( $field['name'] ),
$unit
);
if ( $need_mobile_options ) {
foreach ( array( 'tablet', 'phone' ) as $device_type ) {
// additional data attribute to handle default values for the responsive options.
$has_saved_value = sprintf(
' data-has_saved_value="<%%- typeof( %1$s ) !== \'undefined\' ? \'yes\' : \'no\' %%>" ',
esc_attr( $field_var_name . '_' . $device_type )
);
$value_mobile_range = sprintf(
$value_html,
esc_attr( $field_var_name . '_' . $device_type ),
esc_attr( sprintf( 'parseFloat( %1$s )', $field_var_name . '_' . $device_type ) ),
$default_value
);
$range_el .= sprintf(
'<input type="range" class="et-pb-main-setting et-pb-range et_pb_setting_mobile et_pb_setting_mobile_%3$s%6$s" data-default="%1$s"%4$s%2$s data-device="%3$s"%5$s %7$s/>',
esc_attr( $default ),
$range_settings_html,
esc_attr( $device_type ),
$value_mobile_range,
$has_saved_value,
$fixed_range ? ' et-pb-fixed-range' : '',
$unit
);
}
}
$field_el = $range_el . "\n" . $field_el;
}
if ( $need_mobile_options ) {
$field_el = $field_el . $additional_fields;
}
break;
}
if ( isset( $field['has_preview'] ) && $field['has_preview'] ) {
$field_el = sprintf(
'<%%= window.et_builder.options_template_output("option_preview_buttons") %%>
%1$s',
$field_el
);
}
if ( $need_mobile_options ) {
$field_el = $mobile_settings_tabs . "\n" . $field_el;
$field_el .= '<span class="et-pb-mobile-settings-toggle"></span>';
}
if ( isset( $field['type'] ) && isset( $field['tab_slug'] ) && 'advanced' === $field['tab_slug'] && ! $is_custom_color ) {
$field_el .= $reset_button_html;
}
if ( isset( $field['after'] ) && ! $only_options ) {
$field_el .= $this->render_field_before_after_element( $field['after'] );
}
return "\t" . $field_el;
}
/**
* Returns an underscore template for the field before and after elements.
*
* @param array $elements Render field after/before these elements.
*
* @return string
*/
public function render_field_before_after_element( $elements ) {
$field_el = '';
$elements = is_array( $elements ) ? $elements : array( $elements );
foreach ( $elements as $element ) {
$attributes = '';
if ( ! empty( $element['attributes'] ) ) {
$this->process_html_attributes( $element, $attributes );
}
switch ( $element['type'] ) {
case 'button':
$class = isset( $element['class'] ) ? esc_attr( $element['class'] ) : '';
$text = isset( $element['text'] ) ? et_core_esc_previously( $element['text'] ) : '';
$field_el .= sprintf( '<button class="button %1$s"%2$s>%3$s</button>', $class, $attributes, $text );
break;
}
}
return $field_el;
}
/**
* Returns an underscore template for the font select options settings.
*
* @param string $name Field name.
* @param string $id Field id.
* @param string $group_label Field group label.
*
* @return string
*/
public function render_font_select( $name, $id, $group_label ) {
$options_output = '<%= window.et_builder.fonts_template() %>';
$font_weight_output = '<%= window.et_builder.fonts_weight_template() %>';
$output = sprintf(
'<div class="et-pb-select-font-outer" data-group_label="%6$s">
<div class="et-pb-settings-custom-select-wrapper et-pb-settings-option-select-searchable">
<div class="et_pb_select_placeholder"></div>
<ul class="et-pb-settings-option-select et-pb-settings-option-select-advanced et-pb-main-setting">
<li class="et-pb-select-options-filter">
<input type="text" class="et-pb-settings-option-input et-pb-main-setting regular-text et-pb-menu-filter" placeholder="Search Fonts">
</li>
<li class="et_pb_selected_item_container select-option-item">
</li>
<li class="et-pb-option-subgroup et-pb-recent-fonts">
<p class="et-pb-subgroup-title">%4$s</p>
<ul>
</ul>
</li>
%3$s
</ul>
</div>
</div>
%5$s',
esc_attr( $name ),
( ! empty( $id ) ? sprintf( ' id="%s"', esc_attr( $id ) ) : '' ),
$options_output . "\n\t\t\t\t\t",
esc_html__( 'Recent', 'et_builder' ),
$font_weight_output,
esc_attr( $group_label )
);
return $output;
}
/**
* Returns an underscore template for the select options settings.
*
* @param string $name Option name.
* @param array $options Option settings.
* @param string $id Option id.
* @param string $class Option css class.
* @param string $attributes Option html attributes.
* @param string $field_type Whether select field is with option groups.
* @param array $button_options Yes/No button option.
* @param string $default Option default value.
* @param bool $only_options Whether to return only option without <select>.
*
* @return string
*/
public function render_select( $name, $options, $id = '', $class = '', $attributes = '', $field_type = '', $button_options = array(), $default = '', $only_options = false ) {
$options_output = '';
$processed_options = $options;
if ( 'select_with_option_groups' === $field_type ) {
foreach ( $processed_options as $option_group_name => $option_group ) {
$option_group_name = esc_attr( $option_group_name );
$options_output .= '0' !== $option_group_name ? "<optgroup label='{$option_group_name}'>" : '';
$options_output .= sprintf(
'<%%= window.et_builder.options_template_output("select",%1$s,this.model.toJSON()) %%>',
sprintf(
'{select_name: "%1$s", list: %2$s, default: %3$s, }',
$name,
wp_json_encode( $option_group ),
$default
)
);
$options_output .= '0' !== $option_group_name ? '</optgroup>' : '';
}
$class = rtrim( $class );
$id = '';
$name = $id;
} else {
$class = rtrim( 'et-pb-main-setting ' . $class );
$options_output .= sprintf(
'<%%= window.et_builder.options_template_output("select",%1$s,this.model.toJSON()) %%>',
sprintf(
'{select_name: "%1$s", list: %2$s, default: %3$s, }',
$name,
wp_json_encode( $options ),
$default
)
);
}
$output = sprintf(
'%6$s
<select name="%1$s"%2$s%3$s%4$s class="%3$s %8$s"%9$s>%5$s</select>
%7$s',
esc_attr( $name ),
( ! empty( $id ) ? sprintf( ' id="%s"', esc_attr( $id ) ) : '' ),
( ! empty( $class ) ? esc_attr( $class ) : '' ),
( ! empty( $attributes ) ? $attributes : '' ),
$options_output . "\n\t\t\t\t\t",
'yes_no_button' === $field_type ?
sprintf(
'<div class="et_pb_yes_no_button_wrapper %2$s">
%1$s',
sprintf(
'<%%= window.et_builder.options_template_output("yes_no_button",%1$s) %%>',
wp_json_encode(
array(
'on' => esc_html( $processed_options['on'] ),
'off' => esc_html( $processed_options['off'] ),
)
)
),
( ! empty( $button_options['button_type'] ) && 'equal' === $button_options['button_type'] ? ' et_pb_button_equal_sides' : '' )
) : '',
'yes_no_button' === $field_type ? '</div>' : '',
esc_attr( $field_type ),
'' !== $name ? sprintf( ' data-saved_value="<%%= typeof( %1$s ) !== \'undefined\' ? %1$s : \'\' %%>"', esc_attr( str_replace( '-', '_', $name ) ) ) : ''
);
return $only_options ? $options_output : $output;
}
/**
* Returns an underscore template for the multiple button options settings.
*
* @param string $name Option name.
* @param array $options Option settings.
* @param string $id Option id.
* @param string $class Option css class.
* @param string $attributes Option html attributes.
* @param string $value Option value.
* @param string $default Option default value.
*
* @return string
*/
public function render_multiple_buttons( $name, $options, $id = '', $class = '', $attributes = '', $value = '', $default = '' ) {
$class = rtrim( 'et-pb-main-setting ' . $class );
$output = sprintf(
'<div class="et_pb_multiple_buttons_wrapper">
<input id="%1$s" name="%7$s" type="hidden" class="%2$s" %3$s%5$s %4$s/>
%6$s
</div>',
esc_attr( $id ),
esc_attr( $class ),
$value,
$attributes,
( '' !== $default
? sprintf( ' data-default=%1$s', esc_attr( $default ) )
: ''
),
sprintf(
'<%%= window.et_builder.options_template_output("multiple_buttons",%1$s) %%>',
wp_json_encode( $options )
),
esc_attr( $name )
);
return $output;
}
// phpcs:disable -- Deprecated function.
/**
* @deprecated
*/
public function get_main_tabs() {
$tabs = array(
'general' => et_builder_i18n( 'Content' ),
'advanced' => et_builder_i18n( 'Design' ),
'custom_css' => et_builder_i18n( 'Advanced' ),
);
return apply_filters( 'et_builder_main_tabs', $tabs );
}
// phpcs:enable
/**
* Get validation rule attribute.
*
* @return array
*/
public function get_validation_attr_rules() {
return array(
'minlength',
'maxlength',
'min',
'max',
);
}
/**
* Get validation class name to use in underscore template.
*
* @return array
*/
public function get_validation_class_rules() {
return array(
'required',
'email',
'url',
'date',
'dateISO',
'number',
'digits',
'creditcard',
);
}
/**
* Sorting options by priority.
*
* @param array $fields Fields.
*
* @return array
*/
public function sort_fields( $fields ) {
$tabs_fields = array();
$sorted_fields = array();
$i = 0;
// Sort fields array by tab name.
foreach ( $fields as $field_slug => $field_options ) {
// Option template replaces field's array configuration into string which refers to
// saved template data & template id; thus add index order if $field_options is array.
if ( is_array( $field_options ) ) {
$field_options['_order_number'] = $i;
}
$tab_slug = ! empty( $field_options['tab_slug'] ) ? $field_options['tab_slug'] : 'general';
$tabs_fields[ $tab_slug ][ $field_slug ] = $field_options;
$i++;
}
// Sort fields within tabs by priority.
foreach ( $tabs_fields as $tab_fields ) {
uasort( $tab_fields, array( 'self', 'compare_by_priority' ) );
$sorted_fields = array_merge( $sorted_fields, $tab_fields );
}
return $sorted_fields;
}
/**
* Return setting options markup.
*
* @return string
*/
public function get_options() {
$output = '';
$toggle_all_options_slug = 'all_options';
$toggles_used = isset( $this->settings_modal_toggles );
$tabs_output = array( 'general' => array() );
$all_fields = $this->sort_fields( $this->_get_fields() );
$all_fields_keys = array_keys( $all_fields );
$background_fields_names = $this->get_background_fields_names();
$module_has_background_color_field = in_array( 'background_color', $all_fields_keys, true );
$all_toggles = self::get_toggles( 'post' );
foreach ( $all_fields as $field_name => $field ) {
if ( ! empty( $field['type'] ) && ( 'skip' === $field['type'] || 'computed' === $field['type'] ) ) {
continue;
}
if ( ! self::$_->array_get( $field, 'bb_support', true ) ) {
continue;
}
// add only options allowed for current user.
if (
( ! et_pb_is_allowed( 'edit_colors' ) && ( ! empty( $field['type'] ) && in_array( $field['type'], array( 'color', 'color-alpha' ), true ) || ( ! empty( $field['option_category'] ) && 'color_option' === $field['option_category'] ) ) )
||
( ! et_pb_is_allowed( 'edit_content' ) && ! empty( $field['option_category'] ) && 'basic_option' === $field['option_category'] )
||
( ! et_pb_is_allowed( 'edit_layout' ) && ! empty( $field['option_category'] ) && 'layout' === $field['option_category'] )
||
( ! et_pb_is_allowed( 'edit_configuration' ) && ! empty( $field['option_category'] ) && 'configuration' === $field['option_category'] )
||
( ! et_pb_is_allowed( 'edit_fonts' ) && ! empty( $field['option_category'] ) && ( 'font_option' === $field['option_category'] || ( 'button' === $field['option_category'] && ! empty( $field['type'] ) && 'font' === $field['type'] ) ) )
||
( ! et_pb_is_allowed( 'edit_buttons' ) && ! empty( $field['option_category'] ) && 'button' === $field['option_category'] )
||
( ! et_pb_is_allowed( 'edit_borders' ) && ! empty( $field['option_category'] ) && 'border' === $field['option_category'] )
) {
continue;
}
// check for allowed 3rd party custom options categories.
if ( ! empty( $field['option_category'] ) && ! et_pb_is_allowed( $field['option_category'] ) ) {
continue;
}
$option_output = '';
if ( 'background_color' === $field_name ) {
$background_fields_ui = $this->wrap_settings_background_fields( $all_fields );
// Append background fields UI if applicable. Append standard option otherwise.
if ( '' !== $background_fields_ui ) {
// unset depends_show_if because background fields visibility handled in Background UI.
unset( $field['depends_show_if'] );
// append background UI.
$option_output .= $background_fields_ui;
} else {
$field['skip_background_ui'] = true;
$option_output .= $this->wrap_settings_option_label( $field );
$option_output .= $this->wrap_settings_option_field( $field );
}
} elseif ( $module_has_background_color_field && in_array( $field_name, $background_fields_names, true ) ) {
// remove background-related fields from setting modals since it'll be printed by background UI.
continue;
} else {
// append normal fields.
$option_output .= $this->wrap_settings_option_label( $field );
$option_output .= $this->wrap_settings_option_field( $field );
}
$tab_slug = ! empty( $field['tab_slug'] ) ? $field['tab_slug'] : 'general';
$is_toggle_option = isset( $field['toggle_slug'] ) && $toggles_used && isset( $this->settings_modal_toggles[ $tab_slug ] );
$toggle_slug = $is_toggle_option ? $field['toggle_slug'] : $toggle_all_options_slug;
$sub_toggle_slug = 'all_options' !== $toggle_slug && isset( $field['sub_toggle'] ) && '' !== $field['sub_toggle'] ? $field['sub_toggle'] : 'main';
$tabs_output[ $tab_slug ][ $toggle_slug ][ $sub_toggle_slug ][] = $this->wrap_settings_option( $option_output, $field, $field_name );
if ( isset( $field['toggle_slug'] ) && ! isset( $this->settings_modal_toggles[ $tab_slug ]['toggles'][ $toggle_slug ] ) ) {
$toggle = self::$_->array_get( $all_toggles, "{$this->slug}.{$tab_slug}.toggles.{$field['toggle_slug']}" );
if ( $toggle ) {
self::$_->array_set( $this->settings_modal_toggles, "{$tab_slug}.toggles.{$toggle_slug}", $toggle );
}
}
}
$default_tabs_keys = array_keys( $this->main_tabs );
$module_tabs_keys = array_keys( $tabs_output );
$module_default_tabs = array_intersect( $default_tabs_keys, $module_tabs_keys );
$module_custom_tabs = array_diff( $module_tabs_keys, $default_tabs_keys );
// Make sure tabs order is correct for BB, i.e. custom tabs goes after default tabs and default tabs in following order:
// `Content`, `Design`, `Advanced`.
$module_tabs_sorted = array_merge( $module_default_tabs, $module_custom_tabs );
$tabs_output_processed = array();
// reorder tabs to be sure they're correct.
foreach ( $module_tabs_sorted as $tab_slug ) {
$tabs_output_processed[ $tab_slug ] = $tabs_output[ $tab_slug ];
}
foreach ( $tabs_output_processed as $tab_slug => $tab_settings ) {
// Add only tabs allowed for current user.
if ( ! et_pb_is_allowed( $tab_slug . '_settings' ) ) {
continue;
}
$tab_output = '';
$this->used_tabs[] = $tab_slug;
$i = 0;
if ( isset( $tabs_output_processed[ $tab_slug ] ) ) {
// Group field with no explicit toggle_slug then append it on top of other toggles.
if ( isset( $tabs_output_processed[ $tab_slug ][ $toggle_all_options_slug ] ) ) {
$toggle_unclassified_output = '';
foreach ( $tabs_output_processed[ $tab_slug ][ $toggle_all_options_slug ] as $no_toggle_option_data ) {
foreach ( $no_toggle_option_data as $subtoggle_id => $no_toggle_option_output ) {
$toggle_unclassified_output .= $no_toggle_option_output;
}
}
$tab_output .= sprintf(
'<div class="et-pb-options-toggle-container et-pb-options-toggle-disabled">
<h3 class="et-pb-option-toggle-title">%1$s</h3>
<div class="et-pb-option-toggle-content">
%2$s
</div>
</div>',
esc_html( $this->name ),
et_core_esc_previously( $toggle_unclassified_output ),
'et-pb-options-toggle-disabled'
);
}
if ( isset( $this->settings_modal_toggles[ $tab_slug ] ) ) {
$this->settings_modal_toggles[ $tab_slug ]['toggles'] = self::et_pb_order_toggles_by_priority( $this->settings_modal_toggles[ $tab_slug ]['toggles'] );
foreach ( $this->settings_modal_toggles[ $tab_slug ]['toggles'] as $toggle_slug => $toggle_data ) {
$toggle_heading = is_array( $toggle_data ) ? $toggle_data['title'] : $toggle_data;
if ( ! isset( $tabs_output_processed[ $tab_slug ][ $toggle_slug ] ) ) {
continue;
}
$i++;
$toggle_output = '';
$is_accordion_enabled = isset( $this->settings_modal_toggles[ $tab_slug ]['settings']['bb_toggles_enabeld'] ) && $this->settings_modal_toggles[ $tab_slug ]['settings']['bb_toggles_enabled'] ? true : false;
$is_tabbed_subtoggles = isset( $toggle_data['tabbed_subtoggles'] );
$is_bb_icons_support = isset( $toggle_data['bb_icons_support'] );
$subtoggle_tabs_nav = '';
if ( is_array( $toggle_data ) && ! empty( $toggle_data ) ) {
if ( ! isset( $toggle_data['sub_toggles'] ) ) {
$toggle_data['sub_toggles'] = array( 'main' => '' );
}
foreach ( $toggle_data['sub_toggles'] as $sub_toggle_id => $sub_toggle_data ) {
if ( ! isset( $tabs_output_processed[ $tab_slug ][ $toggle_slug ][ $sub_toggle_id ] ) ) {
continue;
}
if ( $is_tabbed_subtoggles ) {
$subtoggle_tabs_nav .= sprintf(
'<li class="subtoggle_tabs_nav_item"><a class="subtoggle_tabs_nav_item_inner%3$s" data-tab_id="%1$s">%2$s</a></li>',
$sub_toggle_id,
$is_bb_icons_support ? '' : esc_html( $sub_toggle_data['name'] ),
$is_bb_icons_support ? sprintf( ' subtoggle_tabs_nav_icon subtoggle_tabs_nav_icon-%1$s', esc_attr( $sub_toggle_data['icon'] ) ) : ''
);
}
$subtoggle_options = '';
foreach ( $tabs_output_processed[ $tab_slug ][ $toggle_slug ][ $sub_toggle_id ] as $toggle_option_output ) {
$subtoggle_options .= $toggle_option_output;
}
if ( 'main' === $sub_toggle_id ) {
$toggle_output .= $subtoggle_options;
} else {
$toggle_output .= sprintf(
'<div class="et_pb_subtoggle_section%2$s"%3$s>
%1$s
</div>',
$subtoggle_options,
$is_tabbed_subtoggles ? ' et_pb_tabbed_subtoggle' : '',
$is_tabbed_subtoggles ? sprintf( ' data-tab_id="%1$s"', esc_attr( $sub_toggle_id ) ) : ''
);
}
}
} else {
foreach ( $tabs_output_processed[ $tab_slug ][ $toggle_slug ] as $toggle_option_id => $toggle_option_data ) {
foreach ( $toggle_option_data as $toggle_option_output ) {
$toggle_output .= $toggle_option_output;
}
}
}
if ( '' === $toggle_output ) {
continue;
}
$toggle_output = sprintf(
'<div class="et-pb-options-toggle-container%3$s%4$s%5$s">
<h3 class="et-pb-option-toggle-title">%1$s</h3>
%6$s
<div class="et-pb-option-toggle-content">
%2$s
</div>
</div>',
esc_html( $toggle_heading ),
$toggle_output,
( $is_accordion_enabled ? ' et-pb-options-toggle-enabled' : ' et-pb-options-toggle-disabled' ),
( 1 === $i && $is_accordion_enabled ? ' et-pb-option-toggle-content-open' : '' ),
$is_tabbed_subtoggles ? ' et_pb_contains_tabbed_subtoggle' : '',
$is_tabbed_subtoggles && '' !== $subtoggle_tabs_nav ? sprintf( '<ul class="subtoggle_tabs_nav">%1$s</ul>', $subtoggle_tabs_nav ) : ''
);
$tab_output .= $toggle_output;
}
}
}
$output .= sprintf(
'<div class="et-pb-options-tab et-pb-options-tab-%1$s">
%3$s
%2$s
</div>',
esc_attr( $tab_slug ),
$tab_output,
( 'general' === $tab_slug ? $this->children_settings() : '' )
);
}
// return error message if no tabs allowed for current user.
if ( '' === $output ) {
$output = esc_html__( "You don't have sufficient permissions to access the settings", 'et_builder' );
}
return $output;
}
/**
* Return children(general) setting options markup.
*
* @return string
*/
public function children_settings() {
$output = '';
if ( ! empty( $this->child_slug ) ) {
$child_module = self::get_module( $this->child_slug );
if ( isset( $child_module->bb_support ) && ! $child_module->bb_support ) {
return $output;
}
$output = sprintf(
'%6$s<div class="et-pb-option-advanced-module-settings" data-module_type="%1$s">
<ul class="et-pb-sortable-options">
</ul>
%2$s
</div>
<div class="et-pb-option et-pb-option-main-content et-pb-option-advanced-module">
<label for="et_pb_content">%3$s</label>
<div class="et-pb-option-container">
<div id="et_pb_content"><%%= typeof( et_pb_content )!== \'undefined\' && \'\' !== et_pb_content.trim() ? et_pb_content : \'%7$s\' %%></div>
<p class="description">%4$s</p>
</div>
</div>%5$s',
esc_attr( $this->child_slug ),
! in_array( $this->child_slug, array( 'et_pb_column', 'et_pb_column_inner' ), true ) ? sprintf( '<a href="#" class="et-pb-add-sortable-option"><span>%1$s</span></a>', esc_html( $this->add_new_child_text() ) ) : '',
et_builder_i18n( 'Content' ),
esc_html__( 'Here you can define the content that will be placed within the current tab.', 'et_builder' ),
"\n\n",
"\t",
$this->predefined_child_modules()
);
}
return $output;
}
/**
* Return add new item(module) text.
*
* @return mixed|string|null
*/
public function add_new_child_text() {
$child_slug = ! empty( $this->child_item_text ) ? $this->child_item_text : '';
$child_slug = '' === $child_slug ? esc_html__( 'Add New Item', 'et_builder' ) : sprintf( esc_html__( 'Add New %s', 'et_builder' ), $child_slug );
return $child_slug;
}
/**
* Wrap module settings underscore template.
*
* @param string $output Module template content.
*
* @return string
*/
public function wrap_settings( $output ) {
$tabs_output = '';
$i = 0;
$tabs = array();
// General Settings Tab should be added to all modules if allowed.
if ( et_pb_is_allowed( 'general_settings' ) ) {
$tabs['general'] = isset( $this->main_tabs['general'] ) ? $this->main_tabs['general'] : esc_html__( 'General Settings', 'et_builder' );
}
foreach ( $this->used_tabs as $tab_slug ) {
if ( 'general' === $tab_slug ) {
continue;
}
// Add only tabs allowed for current user.
if ( et_pb_is_allowed( $tab_slug . '_settings' ) ) {
if ( isset( $this->main_tabs[ $tab_slug ] ) ) {
// if it's one of 3 default tabs.
$tabs[ $tab_slug ] = $this->main_tabs[ $tab_slug ];
} else {
// Use tab name if it's properly registered custom tab. Fallback to tab slug otherwise.
$tabs[ $tab_slug ] = isset( $this->settings_modal_tabs ) && isset( $this->settings_modal_tabs[ $tab_slug ] ) ? $this->settings_modal_tabs[ $tab_slug ]['name'] : $tab_slug;
}
}
}
$tabs_array = array();
$tabs_json = '';
foreach ( $tabs as $tab_slug => $tab_name ) {
$i++;
$tabs_array[ $i ] = array(
'slug' => $tab_slug,
'label' => $tab_name,
);
$tabs_json = wp_json_encode( $tabs_array );
}
$tabs_output = sprintf( '<%%= window.et_builder.settings_tabs_output(%1$s) %%>', $tabs_json );
$preview_tabs_output = '<%= window.et_builder.preview_tabs_output() %>';
$output = sprintf(
'%2$s
%3$s
<div class="et-pb-options-tabs">
%1$s
</div>
<div class="et-pb-preview-tab"></div>
',
$output,
$tabs_output,
$preview_tabs_output
);
return sprintf(
'%2$s<div class="et-pb-main-settings">%1$s</div>%3$s',
"\n\t\t" . $output,
"\n\t\t",
"\n"
);
}
/**
* Wrap module template into validation form.
*
* @param string $output Module template.
*
* @return string
*/
public function wrap_validation_form( $output ) {
return '<form class="et-builder-main-settings-form validate">' . $output . '</form>';
}
/**
* Get the module's props mapped to their default values.
*
* @since 3.1 Renamed from `get_shortcode_fields()` to `get_default_props()`.
* @since 1.0
*
* @return array
*/
public function get_default_props() {
if ( method_exists( $this, 'get_shortcode_fields' ) ) {
// Backwards compatibility.
return $this->__call( 'get_shortcode_fields', array() );
}
// Get module's default props from static property If current module's default props
// have been generated before.
if ( isset( self::$_default_props[ $this->slug ] ) ) {
return self::$_default_props[ $this->slug ];
}
$fields = array();
// Resolve option template.
foreach ( $this->process_fields( $this->fields_unprocessed ) as $field_name => $field ) {
$value = '';
if ( isset( $field['composite_type'], $field['composite_structure'] ) ) {
require_once ET_BUILDER_DIR . 'module/field/attribute/composite/Parser.php';
$composite_atts = ET_Builder_Module_Field_Attribute_Composite_Parser::parse( $field['composite_type'], $field['composite_structure'] );
$fields = array_merge( $fields, $composite_atts );
} else {
if ( isset( $field['default_on_front'] ) ) {
$value = $field['default_on_front'];
} elseif ( isset( $field['default'] ) ) {
$value = $field['default'];
}
$fields[ $field_name ] = $value;
}
}
$fields['disabled'] = 'off';
$fields['disabled_on'] = '';
$fields['global_module'] = '';
$fields['temp_global_module'] = '';
$fields['global_parent'] = '';
$fields['temp_global_parent'] = '';
$fields['saved_tabs'] = '';
$fields['ab_subject'] = '';
$fields['ab_subject_id'] = '';
$fields['ab_goal'] = '';
$fields['locked'] = '';
$fields['template_type'] = '';
$fields['inline_fonts'] = '';
$fields['collapsed'] = '';
$fields['global_colors_info'] = '';
// Default props of each modules are always identical; thus saves it as static prop
// so the next same modules doesn't need to process all of these again repetitively.
self::$_default_props[ $this->slug ] = $fields;
return $fields;
}
/**
* Get module data attributes.
*
* @return string
*/
public function get_module_data_attributes() {
$attributes = apply_filters(
"{$this->slug}_data_attributes",
array(),
$this->props,
$this->render_count()
);
$data_attributes = '';
if ( ! empty( $attributes ) ) {
foreach ( $attributes as $name => $value ) {
$data_attributes .= sprintf(
' data-%1$s="%2$s"',
sanitize_title( $name ),
esc_attr( $value )
);
}
}
return $data_attributes;
}
/**
* Build underscore template for the module.
*
* @return string
*/
public function build_microtemplate() {
$this->validation_in_use = false;
$template_output = '';
if ( 'child' === $this->type ) {
$id_attr = sprintf( 'et-builder-advanced-setting-%s', $this->slug );
} else {
$id_attr = sprintf( 'et-builder-%s-module-template', $this->slug );
}
if ( ! isset( $this->settings_text ) ) {
$settings_text = sprintf(
__( '%1$s %2$s Settings', 'et_builder' ),
esc_html( $this->name ),
'child' === $this->type ? esc_html__( 'Item', 'et_builder' ) : esc_html__( 'Module', 'et_builder' )
);
} else {
$settings_text = $this->settings_text;
}
if ( file_exists( ET_BUILDER_DIR . 'microtemplates/' . $this->slug . '.php' ) ) {
ob_start();
include ET_BUILDER_DIR . 'microtemplates/' . $this->slug . '.php';
$output = ob_get_clean();
} else {
$output = $this->get_options();
}
$output = $this->wrap_settings( $output );
if ( $this->validation_in_use ) {
$output = $this->wrap_validation_form( $output );
}
$template_output = sprintf(
'<script type="text/template" id="%1$s">
<h3 class="et-pb-settings-heading">%2$s</h3>
%3$s
</script>',
esc_attr( $id_attr ),
esc_html( $settings_text ),
et_core_intentionally_unescaped( $output, 'html' )
);
if ( 'child' === $this->type ) {
$title_var = esc_js( $this->child_title_var );
$title_var = false === strpos( $title_var, 'et_pb_' ) && 'admin_label' !== $title_var ? 'et_pb_' . $title_var : $title_var;
$title_fallback_var = esc_js( $this->child_title_fallback_var );
$title_fallback_var = false === strpos( $title_fallback_var, 'et_pb_' ) ? 'et_pb_' . $title_fallback_var : $title_fallback_var;
$add_new_text = isset( $this->advanced_setting_title_text ) ? $this->advanced_setting_title_text : $this->add_new_child_text();
$template_output .= sprintf(
'%6$s<script type="text/template" id="et-builder-advanced-setting-%1$s-title">
<%% if ( typeof( %2$s ) !== \'undefined\' && typeof( %2$s ) === \'string\' && %2$s !== \'\' ) { %%>
<%% if ( ET_PageBuilder.isDynamicContent(%2$s) ) { %%>
%7$s
<%% } else { %%>
<%%- %2$s.replace( /%%91/g, "[" ).replace( /%%93/g, "]" ) %%>
<%% } %%>
<%% } else if ( typeof( %3$s ) !== \'undefined\' && typeof( %3$s ) === \'string\' && %3$s !== \'\' ) { %%>
<%% if ( ET_PageBuilder.isDynamicContent(%3$s) ) { %%>
%7$s
<%% } else { %%>
<%%- %3$s.replace( /%%91/g, "[" ).replace( /%%93/g, "]" ) %%>
<%% } %%>
<%% } else { %%>
<%%- \'%4$s\' %%>
<%% } %%>
</script>%5$s',
esc_attr( $this->slug ),
esc_html( $title_var ),
esc_html( $title_fallback_var ),
esc_html( $add_new_text ),
"\n\n",
"\t",
$this->get_icon( 'lock' ) . esc_html__( 'Dynamic Content', 'et_builder' )
);
}
return $template_output;
}
/**
* Generate gradient background.
*
* @param array $args Settings.
*
* @return string
*/
public function get_gradient( $args ) {
$defaults = apply_filters(
'et_pb_default_gradient',
array(
'type' => ET_Global_Settings::get_value( 'all_background_gradient_type' ),
'direction' => ET_Global_Settings::get_value( 'all_background_gradient_direction' ),
'radial_direction' => ET_Global_Settings::get_value( 'all_background_gradient_direction_radial' ),
'color_start' => ET_Global_Settings::get_value( 'all_background_gradient_start' ),
'color_end' => ET_Global_Settings::get_value( 'all_background_gradient_end' ),
'start_position' => ET_Global_Settings::get_value( 'all_background_gradient_start_position' ),
'end_position' => ET_Global_Settings::get_value( 'all_background_gradient_end_position' ),
)
);
$args = wp_parse_args( array_filter( $args ), $defaults );
$direction = 'linear' === $args['type'] ? $args['direction'] : "circle at {$args['radial_direction']}";
$start_position = et_sanitize_input_unit( $args['start_position'], false, '%' );
$end_position = et_sanitize_input_unit( $args['end_position'], false, '%' );
return esc_html(
"{$args['type']}-gradient(
{$direction},
{$args['color_start']} ${start_position},
{$args['color_end']} ${end_position}
)"
);
}
/**
* Get values for the rel attribute.
*
* @return array
*/
public function get_rel_values() {
return array(
'bookmark',
'external',
'nofollow',
'noreferrer',
'noopener',
);
}
/**
* Get rel attributes.
*
* @param string $saved_value Rel values.
* @param bool $add_tag Whether to add rel attribute.
*
* @return string
*/
public function get_rel_attributes( $saved_value, $add_tag = true ) {
$rel_attributes = array();
if ( $saved_value ) {
$rel_values = $this->get_rel_values();
$selected_rels = explode( '|', $saved_value );
foreach ( $selected_rels as $index => $selected_rel ) {
if ( ! $selected_rel || 'off' === $selected_rel ) {
continue;
}
$rel_attributes[] = $rel_values[ $index ];
}
}
$attr = empty( $rel_attributes ) ? '' : implode( ' ', $rel_attributes );
return ( $add_tag && '' !== $attr ) ? sprintf( ' rel="%1$s"', esc_attr( $attr ) ) : $attr;
}
/**
* Get text orientation.
*
* @since 3.23 Add device and desktop default parameter to get responsive value.
*
* @param string $device Device name.
* @param string $desktop_default Default desktop value.
* @return string RTL ready text alignment value.
*/
public function get_text_orientation( $device = 'desktop', $desktop_default = '' ) {
$text_orientation = 'desktop' === $device && isset( $this->props['text_orientation'] ) ? $this->props['text_orientation'] : '';
if ( 'desktop' !== $device ) {
$text_orientation = et_pb_responsive_options()->get_any_value( $this->props, "text_orientation_{$device}", $desktop_default );
}
return et_pb_get_alignment( $text_orientation );
}
/**
* Get text orientation class.
*
* @param bool $print_default Whether.
*
* @return string Text orientation class names.
* @since 3.23 Generate text orientation classes for tablet and phone.
*/
public function get_text_orientation_classname( $print_default = false ) {
$text_orientation = $this->get_text_orientation();
$text_orientation_tablet = $this->get_text_orientation( 'tablet' );
$text_orientation_phone = $this->get_text_orientation( 'phone' );
// Should be `justified` instead of justify in classname.
$text_orientation = 'justify' === $text_orientation ? 'justified' : $text_orientation;
$text_orientation_tablet = 'justify' === $text_orientation_tablet ? 'justified' : $text_orientation_tablet;
$text_orientation_phone = 'justify' === $text_orientation_phone ? 'justified' : $text_orientation_phone;
$default_classname = $print_default ? ' et_pb_text_align_left' : '';
$text_orientation_classname = '';
if ( '' !== $text_orientation ) {
$text_orientation_classname .= " et_pb_text_align_{$text_orientation}";
}
if ( '' !== $text_orientation_tablet ) {
$text_orientation_classname .= " et_pb_text_align_{$text_orientation_tablet}-tablet";
}
if ( '' !== $text_orientation_phone ) {
$text_orientation_classname .= " et_pb_text_align_{$text_orientation_phone}-phone";
}
return '' !== $text_orientation_classname ? $text_orientation_classname : $default_classname;
}
/**
* Intended to be overridden as needed.
*
* @return string
*/
public function get_max_width_additional_css() {
return '';
}
/**
* Get type of element
*/
public function get_type() {
return $this->type;
}
/**
* Remove suffix of a string
*
* @param string $string Input string.
* @param string $separator Suffix to remove.
*
* @return string
*/
public function remove_suffix( $string, $separator = '_' ) {
$string_as_array = explode( $separator, $string );
array_pop( $string_as_array );
return implode( $separator, $string_as_array );
}
/**
* Determine field visibility against its dependency.
*
* @param array $field Field.
*
* @return bool
*/
protected function _is_field_applicable( $field ) {
$result = true;
// Field can be undefined/empty in some 3rd party modules without VB support. Handle this situation.
if ( ! $field ) {
return $result;
}
$depends_on = self::$_->array_get( $field, 'depends_on', false );
$depends_show_if = self::$_->array_get( $field, 'depends_show_if', false );
if ( $depends_on && $depends_show_if ) {
foreach ( $depends_on as $attr_name ) {
if ( $result && self::$_->array_get( $this->props, $attr_name ) !== $depends_show_if ) {
$result = false;
break;
}
}
}
return $result;
}
/**
* Update global colors info to match replace with value.
*
* @since 4.9.0
*
* @return void
*/
protected function _prepare_global_colors_info() {
// Retrive global_colors_info from post meta, which saved as string[][].
$props_gc_info = str_replace(
array( '[', ']' ),
array( '[', ']' ),
$this->props['global_colors_info']
);
$gc_info = json_decode( $props_gc_info, true );
$global_colors = et_builder_get_all_global_colors();
if ( empty( $gc_info ) || ! is_array( $gc_info ) || ! is_array( $global_colors ) ) {
return;
}
$gc_info = $this->_remove_inactive_global_colors_module_info( $gc_info, $global_colors );
foreach ( $gc_info as $key => $old_info ) {
if (
empty( $global_colors[ $key ] )
|| ! is_array( $global_colors[ $key ] )
|| ! array_key_exists( 'replaced_with', $global_colors[ $key ] )
) {
continue;
}
$replaced_id = $global_colors[ $key ]['replaced_with'];
$new_info = array();
if ( isset( $gc_info[ $replaced_id ] ) ) {
$new_info = $gc_info[ $replaced_id ];
}
// remove data from prev global color id.
$gc_info[ $key ] = array();
// add data to new global color id.
$gc_info[ $replaced_id ] = array_merge( $old_info, $new_info );
}
$this->props['global_colors_info'] = wp_json_encode( $gc_info );
}
/**
* Remove inactive global colors info from module.
*
* @since 4.9.0
*
* @param string $gc_info Module's global colors info.
* @param array $global_colors Global colors.
*
* @return array
*/
protected function _remove_inactive_global_colors_module_info( $gc_info, $global_colors ) {
foreach ( $gc_info as $key => $info ) {
if ( isset( $global_colors[ $key ]['active'] ) && 'no' === $global_colors[ $key ]['active'] ) {
// Empty out module's global color info by global color ID.
$gc_info[ $key ] = array();
}
}
return $gc_info;
}
/**
* Process global colors.
* If there is a global color id need to be replaced, that is done here.
*
* @since 4.9.0
*
* @return void
*/
public function process_global_colors() {
if ( empty( $this->props['global_colors_info'] ) ) {
return;
}
$this->_prepare_global_colors_info();
foreach ( $this->props as $attr_key => $attr_value ) {
if ( empty( $attr_key ) || strpos( $attr_key, 'color' ) === false ) {
continue;
}
// if color value starts with `gcid-`.
if ( ! empty( $attr_value ) && strpos( $attr_value, 'gcid-' ) === 0 ) {
$global_color_info = et_builder_get_global_color_info( $attr_value );
// Making sure we skip empty value, if for any reason that happen.
if ( ! empty( $global_color_info['color'] ) ) {
$this->props[ $attr_key ] = esc_attr( $global_color_info['color'] );
}
}
}
}
/**
* Process the fields.
*
* @since 3.23 Add function to process advanced form field options set.
*
* @param string $function_name String of the function_name.
* @return void
*/
public function process_additional_options( $function_name ) {
$module = $this;
if ( $function_name && $function_name !== $this->slug ) {
$module = self::get_module( $function_name, $this->get_post_type() );
if ( ! $module ) {
$module = $this;
} else {
$module->props = $this->props;
$module->classname = $this->classname;
}
}
if ( ! isset( $module->advanced_fields ) || false === $module->advanced_fields ) {
return;
}
$module->process_advanced_fonts_options( $function_name );
// Process Text Shadow CSS.
$module->text_shadow->process_advanced_css( $module, $function_name );
$module->process_advanced_background_options( $function_name );
$module->process_advanced_text_options( $function_name );
$module->process_advanced_borders_options( $function_name );
$module->process_advanced_filter_options( $function_name );
$module->process_height_options( $function_name );
$module->process_overflow_options( $function_name );
$module->process_advanced_custom_margin_options( $function_name );
$module->process_max_width_options( $function_name );
$module->process_advanced_button_options( $function_name );
// Process Form Field CSS.
$module->process_advanced_form_field_options( $function_name );
$this->process_box_shadow( $function_name );
$this->process_position( $function_name );
$this->process_transform( $function_name );
// Process Margin & Padding CSS.
$module->margin_padding->process_advanced_css( $module, $function_name );
$this->setup_hover_transitions( $function_name );
}
/**
* Process inline fonts options into CSS style.
*
* @param string $fonts_list Font list.
*/
public function process_inline_fonts_option( $fonts_list ) {
if ( '' === $fonts_list ) {
return;
}
$fonts_list_array = explode( ',', $fonts_list );
foreach ( $fonts_list_array as $font_name ) {
et_builder_enqueue_font( $font_name );
}
}
/**
* Process advanced font styles.
*
* @since 3.23 Add support to generate responsive styles of font, text color, and text align.
* And also process styles of block elements sub options group.
* @since 4.6.0 Add sticky style support
*
* @param string $function_name Module slug.
*/
public function process_advanced_fonts_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
if ( ! self::$_->array_get( $this->advanced_fields, 'fonts', false ) ) {
return;
}
$font_options = array();
$slugs = array(
'font',
'font_size',
'text_color',
'letter_spacing',
'line_height',
'text_align',
);
$mobile_options_slugs = array(
'font_tablet',
'font_phone',
'font_size_tablet',
'font_size_phone',
'text_color_tablet',
'text_color_phone',
'line_height_tablet',
'line_height_phone',
'letter_spacing_tablet',
'letter_spacing_phone',
'text_align_tablet',
'text_align_phone',
);
$slugs = array_merge( $slugs, $mobile_options_slugs ); // merge all slugs into single array to define them in one place.
// Separetely defined and merged *_last_edited slugs. It needs to be merged as reference but shouldn't be looped for calling mobile attributes.
$mobile_options_last_edited_slugs = array(
'font_last_edited',
'text_color_last_edited',
'font_size_last_edited',
'line_height_last_edited',
'letter_spacing_last_edited',
'text_align_last_edited',
);
$slugs = array_merge( $slugs, $mobile_options_last_edited_slugs );
foreach ( $this->advanced_fields['fonts'] as $option_name => $option_settings ) {
$style = '';
$hover_style = '';
$sticky_style = '';
$important_options = array();
$is_important_set = isset( $option_settings['css']['important'] );
$is_placeholder = isset( $option_settings['css']['placeholder'] );
$use_global_important = $is_important_set && 'all' === $option_settings['css']['important'];
if ( ! $use_global_important && $is_important_set && 'plugin_only' === $option_settings['css']['important'] && et_builder_has_limitation( 'force_use_global_important' ) ) {
$use_global_important = true;
}
if ( $is_important_set && is_array( $option_settings['css']['important'] ) ) {
$important_options = $option_settings['css']['important'];
if ( et_builder_has_limitation( 'force_use_global_important' ) && in_array( 'plugin_all', $option_settings['css']['important'], true ) ) {
$use_global_important = true;
}
}
foreach ( $slugs as $font_option_slug ) {
if ( isset( $this->props[ "{$option_name}_{$font_option_slug}" ] ) ) {
$font_options[ "{$option_name}_{$font_option_slug}" ] = $this->props[ "{$option_name}_{$font_option_slug}" ];
}
}
$field_key = "{$option_name}_{$slugs[0]}";
$global_setting_name = $this->get_global_setting_name( $field_key );
$global_setting_value = ET_Global_Settings::get_value( $global_setting_name );
// Add default parameter to override global setting value, just in case we need to
// use another default.
$field_option_default = isset( $this->fields_unprocessed[ $field_key ]['default'] ) ? $this->fields_unprocessed[ $field_key ]['default'] : $global_setting_value;
$field_option_value = isset( $font_options[ $field_key ] ) ? $font_options[ $field_key ] : '';
if ( '' !== $field_option_value || ! $global_setting_value ) {
$important = in_array( 'font', $important_options, true ) || $use_global_important ? ' !important' : '';
$font_styles = et_builder_set_element_font( $field_option_value, ( '' !== $important ), $field_option_default );
// Get font custom breakpoint if needed on desktop.
$font_custom_desktop_breakpoint = et_pb_font_options()->get_breakpoint_by_font_value( $font_options, $field_key );
if ( isset( $option_settings['css']['font'] ) || ! empty( $font_custom_desktop_breakpoint ) ) {
// Prepare font styles args.
$font_styles_args = array(
'selector' => et_pb_font_options()->get_font_selector( $option_settings, $this->main_css_element ),
'declaration' => rtrim( $font_styles ),
'priority' => $this->_style_priority,
);
// Set custom media query if needed.
if ( ! empty( $font_custom_desktop_breakpoint ) ) {
$font_styles_args['media_query'] = self::get_media_query( $font_custom_desktop_breakpoint );
}
self::set_style( $function_name, $font_styles_args );
} else {
$style .= $font_styles;
}
}
$size_option_name = "{$option_name}_{$slugs[1]}";
$default_size = isset( $this->fields_unprocessed[ $size_option_name ]['default'] ) ? $this->fields_unprocessed[ $size_option_name ]['default'] : '';
$size_option_value = '';
if ( isset( $font_options[ $size_option_name ] ) && ! in_array( trim( $font_options[ $size_option_name ] ), array( '', 'px', $default_size ), true ) ) {
$important = in_array( 'size', $important_options, true ) || $use_global_important ? ' !important' : '';
$size_option_value = et_builder_process_range_value( $font_options[ $size_option_name ] );
$style .= sprintf(
'font-size: %1$s%2$s; ',
esc_html( $size_option_value ),
esc_html( $important )
);
}
// Hover font size.
$size_hover = trim( et_pb_hover_options()->get_value( $size_option_name, $this->props, '' ) );
if ( ! in_array( $size_hover, array( '', 'px', $size_option_value ), true ) ) {
$important = in_array( 'size', $important_options, true ) || $use_global_important ? ' !important' : '';
$hover_style .= sprintf(
'font-size: %1$s%2$s; ',
esc_html( et_builder_process_range_value( $size_hover ) ),
esc_html( $important )
);
}
// Sticky font size.
$size_sticky = trim( et_pb_sticky_options()->get_value( $size_option_name, $this->props, '' ) );
if ( ! in_array( $size_sticky, array( '', 'px', $size_option_value ), true ) ) {
$important = in_array( 'size', $important_options, true ) || $use_global_important ? ' !important' : '';
$sticky_style .= sprintf(
'font-size: %1$s%2$s; ',
esc_html( et_builder_process_range_value( $size_sticky ) ),
esc_html( $important )
);
}
$text_color_option_name = "{$option_name}_{$slugs[2]}";
$color_selector = isset( $option_settings['css']['color'] ) ? $option_settings['css']['color'] : '';
// Ensure if text color option is not disabled on current font options.
$hide_text_color = isset( $option_settings['hide_text_color'] ) && true === $option_settings['hide_text_color'];
// handle the value from old option.
$old_option_ref = isset( $option_settings['text_color'] ) && isset( $option_settings['text_color']['old_option_ref'] ) ? $option_settings['text_color']['old_option_ref'] : '';
$old_option_val = '' !== $old_option_ref && isset( $this->props[ $old_option_ref ] ) ? $this->props[ $old_option_ref ] : '';
$default_value = '' !== $old_option_val && isset( $option_settings['text_color'] ) && isset( $option_settings['text_color']['default'] ) ? $option_settings['text_color']['default'] : '';
if ( isset( $font_options[ $text_color_option_name ] ) && '' !== $font_options[ $text_color_option_name ] && ! $hide_text_color ) {
$important = ' !important';
if ( $default_value !== $font_options[ $text_color_option_name ] ) {
if ( ! empty( $color_selector ) ) {
$el_style = array(
'selector' => $color_selector,
'declaration' => sprintf(
'color: %1$s%2$s;',
esc_html( $font_options[ $text_color_option_name ] ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
} else {
$style .= sprintf(
'color: %1$s%2$s; ',
esc_html( $font_options[ $text_color_option_name ] ),
esc_html( $important )
);
}
}
}
// Text Color Hover.
$text_color_hover = et_pb_hover_options()->get_value( $text_color_option_name, $this->props );
$hover_has_text_color = $default_value !== $text_color_hover && ! empty( $text_color_hover ) && ! $hide_text_color;
$default_hover_color_selector = et_pb_hover_options()->add_hover_to_selectors( $color_selector );
$hover_text_color_selector = self::$_->array_get( $option_settings, 'css.color_hover', $default_hover_color_selector );
if ( $hover_has_text_color ) {
$important = ' !important';
if ( ! empty( $color_selector ) ) {
$el_style = array(
'selector' => $hover_text_color_selector,
'declaration' => sprintf(
'color: %1$s%2$s;',
esc_html( $text_color_hover ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
} else {
$hover_style .= sprintf(
'color: %1$s%2$s; ',
esc_html( $text_color_hover ),
esc_html( $important )
);
}
}
// Text Color Sticky.
$text_color_sticky = et_pb_sticky_options()->get_value( $text_color_option_name, $this->props );
if ( $default_value !== $text_color_sticky && ! empty( $text_color_sticky ) && ! $hide_text_color ) {
$important = ' !important';
if ( ! empty( $color_selector ) ) {
$sel = et_pb_sticky_options()->add_sticky_to_selectors(
$color_selector,
$this->is_sticky_module
);
$el_style = array(
'selector' => et_()->array_get( $option_settings, 'css.color_sticky', $sel ),
'declaration' => sprintf(
'color: %1$s%2$s;',
esc_html( $text_color_sticky ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
// Add hover style in sticky state.
if ( $hover_has_text_color ) {
$el_style = array(
'selector' => et_pb_sticky_options()->add_sticky_to_selectors(
$hover_text_color_selector,
$this->is_sticky_module
),
'declaration' => sprintf(
'color: %1$s%2$s;',
esc_html( $text_color_hover ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
} else {
$sticky_style .= sprintf(
'color: %1$s%2$s; ',
esc_html( $text_color_sticky ),
esc_html( $important )
);
}
}
$letter_spacing_option_name = "{$option_name}_{$slugs[3]}";
$default_letter_spacing = isset( $this->fields_unprocessed[ $letter_spacing_option_name ]['default'] ) ? $this->fields_unprocessed[ $letter_spacing_option_name ]['default'] : '';
$letter_spacing_selector = isset( $option_settings['css']['letter_spacing'] ) ? $option_settings['css']['letter_spacing'] : '';
$letter_spacing_value = '';
if ( isset( $font_options[ $letter_spacing_option_name ] ) && ! in_array( trim( $font_options[ $letter_spacing_option_name ] ), array( '', 'px', $default_letter_spacing ), true ) ) {
$important = in_array( 'letter-spacing', $important_options, true ) || $use_global_important ? ' !important' : '';
$letter_spacing_value = et_builder_process_range_value( $font_options[ $letter_spacing_option_name ], 'letter_spacing' );
$style .= sprintf(
'letter-spacing: %1$s%2$s; ',
esc_html( $letter_spacing_value ),
esc_html( $important )
);
if ( ! empty( $letter_spacing_selector ) ) {
$el_style = array(
'selector' => $letter_spacing_selector,
'declaration' => sprintf(
'letter-spacing: %1$s%2$s;',
esc_html( $letter_spacing_value ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
// Hover letter spacing.
$letter_spacing_hover = trim( et_pb_hover_options()->get_value( $letter_spacing_option_name, $this->props, '' ) );
$hover_has_letter_spacing = ! in_array( $letter_spacing_hover, array( '', 'px', $letter_spacing_value ), true );
$hover_letter_spacing_selector = isset( $option_settings['css']['letter_spacing_hover'] ) ? $option_settings['css']['letter_spacing_hover'] : '';
if ( $hover_has_letter_spacing ) {
$important = in_array( 'letter-spacing', $important_options, true ) || $use_global_important ? ' !important' : '';
if ( et_builder_is_hover_enabled( $letter_spacing_option_name, $this->props ) ) {
if ( ! empty( $hover_letter_spacing_selector ) ) {
$el_style = array(
'selector' => $hover_letter_spacing_selector,
'declaration' => sprintf(
'letter-spacing: %1$s%2$s;',
esc_html( et_builder_process_range_value( $letter_spacing_hover ) ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
} else {
$hover_style .= sprintf(
'letter-spacing: %1$s%2$s; ',
esc_html( et_builder_process_range_value( $letter_spacing_hover ) ),
esc_html( $important )
);
}
}
if ( isset( $option_settings['css']['letter_spacing'] ) ) {
if ( et_builder_is_hover_enabled( $letter_spacing_option_name, $this->props ) ) {
if ( $default_letter_spacing !== $letter_spacing_hover ) {
if ( isset( $option_settings['css']['color'] ) ) {
$sel = et_pb_hover_options()->add_hover_to_selectors( $option_settings['css']['letter_spacing'] );
$el_style = array(
'selector' => self::$_->array_get( $option_settings, 'css.letter_spacing_hover', $sel ),
'declaration' => sprintf(
'color: %1$s%2$s;',
esc_html( $letter_spacing_hover ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
}
}
}
// Sticky letter spacing.
$letter_spacing_sticky = trim( et_pb_sticky_options()->get_value( $letter_spacing_option_name, $this->props, '' ) );
if ( ! in_array( $letter_spacing_sticky, array( '', 'px', $letter_spacing_value ), true ) ) {
$important = in_array( 'letter-spacing', $important_options, true ) || $use_global_important ? ' !important' : '';
if ( et_pb_sticky_options()->is_enabled( $letter_spacing_option_name, $this->props ) ) {
if ( isset( $option_settings['css']['letter_spacing_sticky'] ) ) {
$el_style = array(
'selector' => $option_settings['css']['letter_spacing_sticky'],
'declaration' => sprintf(
'letter-spacing: %1$s%2$s;',
esc_html( et_builder_process_range_value( $letter_spacing_sticky ) ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
// Add hover style in sticky state.
if ( $hover_has_letter_spacing && ! empty( $hover_letter_spacing_selector ) ) {
$el_style = array(
'selector' => et_pb_sticky_options()->add_sticky_to_selectors(
$hover_letter_spacing_selector,
$this->is_sticky_module
),
'declaration' => sprintf(
'letter-spacing: %1$s%2$s;',
esc_html( et_builder_process_range_value( $letter_spacing_hover ) ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
} else {
$sticky_style .= sprintf(
'letter-spacing: %1$s%2$s; ',
esc_html( et_builder_process_range_value( $letter_spacing_sticky ) ),
esc_html( $important )
);
}
}
if ( isset( $option_settings['css']['letter_spacing'] ) ) {
if ( et_builder_is_sticky_enabled( $letter_spacing_option_name, $this->props ) ) {
if ( $default_letter_spacing !== $letter_spacing_sticky ) {
if ( isset( $option_settings['css']['color'] ) ) {
$sel = et_pb_sticky_options()->add_sticky_to_selectors(
$option_settings['css']['letter_spacing'],
$this->is_sticky_module
);
$el_style = array(
'selector' => self::$_->array_get( $option_settings, 'css.letter_spacing_sticky', $sel ),
'declaration' => sprintf(
'color: %1$s%2$s;',
esc_html( $letter_spacing_sticky ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
}
}
}
$line_height_option_name = "{$option_name}_{$slugs[4]}";
$line_height_selector = isset( $option_settings['css']['line_height'] ) ? $option_settings['css']['line_height'] : '';
$line_height_value = '';
if ( isset( $font_options[ $line_height_option_name ] ) ) {
$default_line_height = isset( $this->fields_unprocessed[ $line_height_option_name ]['default'] ) ? $this->fields_unprocessed[ $line_height_option_name ]['default'] : '';
if ( ! in_array( trim( $font_options[ $line_height_option_name ] ), array( '', 'px', $default_line_height ), true ) ) {
$important = in_array( 'line-height', $important_options, true ) || $use_global_important ? ' !important' : '';
$line_height_value = et_builder_process_range_value( $font_options[ $line_height_option_name ], 'line_height' );
$style .= sprintf(
'line-height: %1$s%2$s; ',
esc_html( $line_height_value ),
esc_html( $important )
);
if ( isset( $option_settings['css']['line_height'] ) ) {
$el_style = array(
'selector' => $option_settings['css']['line_height'],
'declaration' => sprintf(
'line-height: %1$s%2$s;',
esc_html( $line_height_value ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
}
// Hover line height.
$line_height_hover = trim( et_pb_hover_options()->get_value( $line_height_option_name, $this->props, '' ) );
$hover_has_line_height = ! in_array( $line_height_hover, array( '', 'px', $line_height_value ), true );
$hover_line_height_selector = self::$_->array_get( $option_settings, 'css.line_height_hover', et_pb_hover_options()->add_hover_to_selectors( $line_height_selector ) );
if ( $hover_has_line_height ) {
$important = in_array( 'line-height', $important_options, true ) || $use_global_important ? ' !important' : '';
if ( et_builder_is_hover_enabled( $line_height_option_name, $this->props ) ) {
$hover_style .= sprintf(
'line-height: %1$s%2$s; ',
esc_html( et_builder_process_range_value( $line_height_hover, 'line_height' ) ),
esc_html( $important )
);
}
if ( ! empty( $line_height_selector ) ) {
if ( et_builder_is_hover_enabled( $line_height_option_name, $this->props ) ) {
if ( isset( $option_settings['css']['color'] ) ) {
$el_style = array(
'selector' => $hover_line_height_selector,
'declaration' => sprintf(
'line-height: %1$s%2$s;',
esc_html( $line_height_hover ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
}
}
// Sticky line height.
$line_height_sticky = trim( et_pb_sticky_options()->get_value( $line_height_option_name, $this->props, '' ) );
if ( ! in_array( $line_height_sticky, array( '', 'px', $line_height_value ), true ) ) {
$important = in_array( 'line-height', $important_options, true ) || $use_global_important ? ' !important' : '';
if ( et_pb_sticky_options()->is_enabled( $line_height_option_name, $this->props ) ) {
$sticky_style .= sprintf(
'line-height: %1$s%2$s; ',
esc_html( et_builder_process_range_value( $line_height_sticky, 'line_height' ) ),
esc_html( $important )
);
}
if ( ! empty( $line_height_selector ) ) {
if ( et_pb_sticky_options()->is_enabled( $line_height_option_name, $this->props ) ) {
if ( isset( $option_settings['css']['color'] ) ) {
$sel = et_pb_sticky_options()->add_sticky_to_selectors(
$line_height_selector,
$this->is_sticky_module
);
$el_style = array(
'selector' => et_()->array_get( $option_settings, 'css.line_height_sticky', $sel ),
'declaration' => sprintf(
'line-height: %1$s%2$s;',
esc_html( $line_height_sticky ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
// Add hover style in sticky state.
if ( $hover_has_line_height ) {
$el_style = array(
'selector' => et_pb_sticky_options()->add_sticky_to_selectors(
$hover_line_height_selector,
$this->is_sticky_module
),
'declaration' => sprintf(
'line-height: %1$s%2$s;',
esc_html( $line_height_hover ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
}
}
}
$text_align_option_name = "{$option_name}_{$slugs[5]}";
// Ensure to not print text alignment if current font hide text alignment option.
$hide_text_align = self::$_->array_get( $option_settings, 'hide_text_align', false );
if ( isset( $font_options[ $text_align_option_name ] ) && '' !== $font_options[ $text_align_option_name ] && ! $hide_text_align ) {
$important = in_array( 'text-align', $important_options, true ) || $use_global_important ? ' !important' : '';
$text_align = et_pb_get_alignment( $font_options[ $text_align_option_name ] );
if ( isset( $option_settings['css']['text_align'] ) ) {
$el_style = array(
'selector' => $option_settings['css']['text_align'],
'declaration' => sprintf(
'text-align: %1$s%2$s;',
esc_html( $text_align ),
esc_html( $important )
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
} else {
$style .= sprintf(
'text-align: %1$s%2$s; ',
esc_html( $text_align ),
esc_html( $important )
);
}
}
if ( isset( $option_settings['use_all_caps'] ) && $option_settings['use_all_caps'] && 'on' === $this->props[ "{$option_name}_all_caps" ] ) {
$important = in_array( 'all_caps', $important_options, true ) || $use_global_important ? ' !important' : '';
$style .= sprintf( 'text-transform: uppercase%1$s; ', esc_html( $important ) );
}
// apply both default and hover styles.
$style_states = array( 'default', 'hover', 'sticky' );
foreach ( $style_states as $style_state ) {
$is_hover = 'hover' === $style_state;
$is_sticky = 'sticky' === $style_state;
$style = $is_hover ? $hover_style : $style;
if ( $is_hover ) {
$style = $hover_style;
}
if ( $is_sticky ) {
$style = $sticky_style;
}
if ( '' !== $style ) {
$css_element = ! empty( $option_settings['css']['main'] ) ? $option_settings['css']['main'] : $this->main_css_element;
// use different selector for plugin if defined.
if ( et_builder_has_limitation( 'use_limited_main' ) && ! empty( $option_settings['css']['limited_main'] ) ) {
$css_element = $option_settings['css']['limited_main'];
}
// $css_element might be an array, for example to apply the css for placeholders
if ( is_array( $css_element ) ) {
foreach ( $css_element as $selector ) {
$hover_selector = self::$_->array_get( $option_settings, 'css.hover', $this->add_hover_to_selectors( $selector, $is_hover ) );
if ( $is_hover ) {
$selector = $hover_selector;
}
if ( $is_sticky ) {
$selector = et_()->array_get(
$option_settings,
'css.sticky',
et_pb_sticky_options()->add_sticky_to_selectors(
$selector,
$this->is_sticky_module
)
);
// Add hover style in sticky state.
if ( '' !== $hover_style && '' !== $hover_selector ) {
$sticky_hover_selector = et_pb_sticky_options()->add_sticky_to_selectors(
$hover_selector,
$this->is_sticky_module
);
$el_style = array(
'selector' => $sticky_hover_selector,
'declaration' => et_core_esc_previously( rtrim( $hover_style ) ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
$el_style = array(
'selector' => $selector,
'declaration' => et_core_esc_previously( rtrim( $style ) ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
$this->maybe_push_element_to_letter_spacing_fix_list( $selector, array( 'body.safari ', 'body.iphone ', 'body.uiwebview ' ), rtrim( $style ), $default_letter_spacing );
}
} else {
$hover_selector = self::$_->array_get( $option_settings, 'css.hover', $this->add_hover_to_selectors( $css_element, $is_hover ) );
if ( $is_hover ) {
$css_element = $hover_selector;
}
if ( $is_sticky ) {
$css_element = et_()->array_get(
$option_settings,
'css.sticky',
et_pb_sticky_options()->add_sticky_to_selectors(
$css_element,
$this->is_sticky_module
)
);
// Add hover style in sticky state.
if ( '' !== $hover_style && '' !== $hover_selector ) {
$sticky_hover_selector = et_pb_sticky_options()->add_sticky_to_selectors(
$hover_selector,
$this->is_sticky_module
);
$el_style = array(
'selector' => $sticky_hover_selector,
'declaration' => et_core_esc_previously( rtrim( $hover_style ) ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
$el_style = array(
'selector' => $css_element,
'declaration' => et_core_esc_previously( rtrim( $style ) ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
$this->maybe_push_element_to_letter_spacing_fix_list( $css_element, array( 'body.safari ', 'body.iphone ', 'body.uiwebview ' ), rtrim( $style ), $default_letter_spacing );
if ( $is_placeholder ) {
$el_style = array(
'selector' => $this->_maybe_add_hover_to_order_class( $css_element . '::-webkit-input-placeholder', $is_hover ),
'declaration' => rtrim( $style ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => $this->_maybe_add_hover_to_order_class( $css_element . '::-moz-placeholder', $is_hover ),
'declaration' => rtrim( $style ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => $this->_maybe_add_hover_to_order_class( $css_element . '::-ms-input-placeholder', $is_hover ),
'declaration' => rtrim( $style ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
}
}
// process mobile options.
foreach ( $mobile_options_slugs as $mobile_option ) {
$current_option_name = "{$option_name}_{$mobile_option}";
if ( isset( $font_options[ $current_option_name ] ) && '' !== $font_options[ $current_option_name ] ) {
$current_desktop_option = $this->remove_suffix( $mobile_option );
$current_last_edited_slug = "{$option_name}_{$current_desktop_option}_last_edited";
$current_last_edited = isset( $font_options[ $current_last_edited_slug ] ) ? $font_options[ $current_last_edited_slug ] : '';
$current_responsive_status = et_pb_get_responsive_status( $current_last_edited );
// Don't print mobile styles if responsive UI isn't toggled on.
if ( ! $current_responsive_status ) {
continue;
}
$current_media_query = false === strpos( $mobile_option, 'phone' ) ? 'max_width_980' : 'max_width_767';
$main_option_name = str_replace( array( '_tablet', '_phone' ), '', $mobile_option );
// 1. Generate CSS property.
$css_property = str_replace( '_', '-', $main_option_name );
if ( 'text_color' === $main_option_name ) {
$css_property = 'color';
}
// 2. Custom important.
$css_option_name = 'font-size' === $css_property ? 'size' : $css_property;
$important = in_array( $css_option_name, $important_options, true ) || $use_global_important ? ' !important' : '';
// As default, text color should be important on tablet and phone.
if ( 'text_color' === $main_option_name ) {
$important = ' !important';
}
// Allow specific selector tablet and mobile, simply add _tablet or _phone suffix.
if ( isset( $option_settings['css'][ $mobile_option ] ) && '' !== $option_settings['css'][ $mobile_option ] ) {
$selector = $option_settings['css'][ $mobile_option ];
} elseif ( 'text_color' === $main_option_name && ! empty( $option_settings['css']['color'] ) ) {
// We define custom selector for text color as 'color', not 'text_color'.
$selector = $option_settings['css']['color'];
} elseif ( isset( $option_settings['css'][ $main_option_name ] ) || isset( $option_settings['css']['main'] ) ) {
$selector = isset( $option_settings['css'][ $main_option_name ] ) ? $option_settings['css'][ $main_option_name ] : $option_settings['css']['main'];
} elseif ( et_builder_has_limitation( 'use_limited_main' ) && ! empty( $option_settings['css']['limited_main'] ) ) {
$selector = $option_settings['css']['limited_main'];
} else {
$selector = $this->main_css_element;
}
// 3. Process value based on property name.
$text_range_inputs = array( 'font_size', 'line_height', 'letter_spacing' );
$processed_value = $font_options[ $current_option_name ];
if ( in_array( $main_option_name, $text_range_inputs, true ) ) {
$processed_value = et_builder_process_range_value( $font_options[ $current_option_name ] );
}
// 4. Declare CSS property, value, and important status.
if ( 'font' === $main_option_name ) {
$global_font_name = $this->get_global_setting_name( $current_option_name );
$global_font_value = ET_Global_Settings::get_value( $global_font_name );
$declaration = et_builder_set_element_font( $processed_value, ( '' !== $important ), $global_font_value );
} else {
$declaration = sprintf(
'%1$s: %2$s%3$s;',
esc_html( $css_property ),
esc_html( $processed_value ),
esc_html( $important )
);
}
// Reset font style: italic/normal, uppercase/normal/smallcaps, underline/
// linethrough. There is a case where a font option group inherit font style
// value from another font option group. Most of the time, we can't toggle
// on/off the inherited options.
if ( 'font' === $main_option_name ) {
$processed_prev_value = et_pb_responsive_options()->get_default_value( $this->props, $current_option_name );
$reset_declaration = et_builder_set_reset_font_style( $processed_value, $processed_prev_value, '' !== $important );
$declaration .= ! empty( $reset_declaration ) ? $reset_declaration : '';
}
// $selector might be an array, for example to apply the css for placeholders
if ( is_array( $selector ) ) {
foreach ( $selector as $selector_item ) {
$el_style = array(
'selector' => $selector_item,
'declaration' => $declaration,
'priority' => $this->_style_priority,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
} else {
$el_style = array(
'selector' => $selector,
'declaration' => $declaration,
'priority' => $this->_style_priority,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
if ( ! empty( $selector ) && in_array( $mobile_option, array( 'letter_spacing_phone', 'letter_spacing_tablet' ), true ) ) {
switch ( $mobile_option ) {
case 'letter_spacing_phone':
$css_prefix = 'body.iphone ';
break;
case 'letter_spacing_tablet':
$css_prefix = 'body.uiwebview ';
break;
}
$this->maybe_push_element_to_letter_spacing_fix_list( $selector, $css_prefix, $declaration, $default_letter_spacing );
}
if ( $is_placeholder ) {
$el_style = array(
'selector' => $selector . '::-webkit-input-placeholder',
'declaration' => $declaration,
'priority' => $this->_style_priority,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => $selector . '::-moz-placeholder',
'declaration' => $declaration,
'priority' => $this->_style_priority,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => $selector . '::-ms-input-placeholder',
'declaration' => $declaration,
'priority' => $this->_style_priority,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
}
}
}
$sub_toggle = isset( $option_settings['sub_toggle'] ) ? $option_settings['sub_toggle'] : '';
// Ignore the process if the current module is Text since the process will be handled
// by the module itself.
if ( 'et_pb_text' !== $function_name ) {
// Build sub toggle selector.
$sub_toggle_selector = '';
if ( et_builder_has_limitation( 'use_limited_main' ) && ! empty( $option_settings['css']['limited_main'] ) ) {
$sub_toggle_selector = $option_settings['css']['limited_main'];
} elseif ( isset( $option_settings['css']['main'] ) ) {
$sub_toggle_selector = $option_settings['css']['main'];
}
// Additional ul and ol option slugs.
if ( in_array( $sub_toggle, array( 'ul', 'ol' ), true ) ) {
$list_selector = '' !== $sub_toggle_selector ? $sub_toggle_selector : "{$this->main_css_element} {$sub_toggle}";
// Option ul / ol type.
$list_type_name = "{$option_name}_type";
$is_list_type_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, $list_type_name );
$list_type_values = array(
'desktop' => esc_html( et_pb_responsive_options()->get_any_value( $this->props, $list_type_name, '', false, 'desktop' ) ),
'tablet' => $is_list_type_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$list_type_name}_tablet" ) ) : '',
'phone' => $is_list_type_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$list_type_name}_tablet" ) ) : '',
);
et_pb_responsive_options()->generate_responsive_css( $list_type_values, $list_selector, 'list-style-type', $function_name, ' !important;', 'select' );
// Option ul / ol position.
$list_position_name = "{$option_name}_position";
$is_list_position_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, $list_position_name );
$list_position_values = array(
'desktop' => esc_html( et_pb_responsive_options()->get_any_value( $this->props, $list_position_name ) ),
'tablet' => $is_list_position_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$list_position_name}_tablet" ) ) : '',
'phone' => $is_list_position_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$list_position_name}_phone" ) ) : '',
);
et_pb_responsive_options()->generate_responsive_css( $list_position_values, $list_selector, 'list-style-position', $function_name, '', 'select' );
// Option ul / ol indent.
$list_indent_name = "{$option_name}_item_indent";
$is_list_indent_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, $list_indent_name );
$list_indent_values = array(
'desktop' => esc_html( et_pb_responsive_options()->get_any_value( $this->props, $list_indent_name ) ),
'tablet' => $is_list_indent_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$list_indent_name}_tablet" ) ) : '',
'phone' => $is_list_indent_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$list_indent_name}_phone" ) ) : '',
);
$list_item_indent_selector = et_()->array_get( $option_settings, 'css.item_indent', $list_selector );
et_pb_responsive_options()->generate_responsive_css( $list_indent_values, $list_item_indent_selector, 'padding-left', $function_name, ' !important;' );
}
// Additional quote option slugs.
if ( 'quote' === $sub_toggle ) {
$quote_selector = '' !== $sub_toggle_selector ? $sub_toggle_selector : "{$this->main_css_element} blockquote";
// Option quote border weight.
$border_weight_name = "{$option_name}_border_weight";
$is_border_weight_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, $border_weight_name );
$border_weight_values = array(
'desktop' => esc_html( et_pb_responsive_options()->get_any_value( $this->props, $border_weight_name ) ),
'tablet' => $is_border_weight_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$border_weight_name}_tablet" ) ) : '',
'phone' => $is_border_weight_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$border_weight_name}_phone" ) ) : '',
);
et_pb_responsive_options()->generate_responsive_css( $border_weight_values, $quote_selector, 'border-width', $function_name );
// Option quote border weight on hover.
$border_weight_hover_value = et_pb_hover_options()->get_value( $border_weight_name, $this->props );
if ( '' !== $border_weight_hover_value && et_builder_is_hover_enabled( $border_weight_name, $this->props ) ) {
$el_style = array(
'selector' => "{$quote_selector}:hover",
'declaration' => sprintf(
'border-width: %1$s%2$s;',
esc_html( et_builder_process_range_value( $border_weight_hover_value ) ),
esc_html( $important )
),
);
self::set_style( $function_name, $el_style );
}
// Option quote border color.
$border_color_name = "{$option_name}_border_color";
$is_border_color_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, $border_color_name );
$border_color_values = array(
'desktop' => esc_html( et_pb_responsive_options()->get_any_value( $this->props, $border_color_name ) ),
'tablet' => $is_border_color_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$border_color_name}_tablet" ) ) : '',
'phone' => $is_border_color_responsive ? esc_html( et_pb_responsive_options()->get_any_value( $this->props, "{$border_color_name}_phone" ) ) : '',
);
et_pb_responsive_options()->generate_responsive_css( $border_color_values, $quote_selector, 'border-color', $function_name, '', 'color' );
// Option quote border weight on hover.
$border_color_hover_value = et_pb_hover_options()->get_value( $border_color_name, $this->props );
if ( '' !== $border_color_hover_value && et_builder_is_hover_enabled( $border_color_name, $this->props ) ) {
$el_style = array(
'selector' => "{$quote_selector}:hover",
'declaration' => sprintf(
'border-color: %1$s%2$s;',
esc_html( $border_color_hover_value ),
esc_html( $important )
),
);
self::set_style( $function_name, $el_style );
}
}
}
}
// sets ligatures disabling for all selectors
// from the list $this->letter_spacing_fix_selectors.
foreach ( $this->letter_spacing_fix_selectors as $selector_with_prefix ) {
$el_style = array(
'selector' => $selector_with_prefix,
'declaration' => 'font-variant-ligatures: no-common-ligatures;',
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
/**
* Maybe push element to the letter spacing fix list
*
* @since 4.4.7 Checks a element for the having of the letter-spacing property,
* adds a prefix to all its selectors, push prefixed selector
* to the array ($this->letter_spacing_fix_selectors) of elements
* that need to have ligature fix (same elements will be overridden).
*
* @param string $selector CSS selector of the current element.
* @param array $css_prefixes array or string of CSS prefixes which will be added to the current element selector.
* @param string $declaration CSS declaration of the current element.
* @param string $default_letter_spacing default letter-spacing value at the current element.
*/
public function maybe_push_element_to_letter_spacing_fix_list( $selector, $css_prefixes, $declaration, $default_letter_spacing ) {
if ( false === strpos( trim( $declaration ), 'letter-spacing' ) || empty( $css_prefixes ) || empty( $selector ) ) {
return;
}
$selectors = ! is_array( $selector ) ? array( $selector ) : $selector;
foreach ( $selectors as $selector ) {
if ( empty( $selector ) ) {
continue;
}
$css_value = str_replace( 'letter-spacing', '', $declaration );
$css_value = preg_replace( '/[^a-zA-Z0-9]/', '', $css_value );
if ( ! is_array( $css_prefixes ) ) {
$css_prefixes = array( $css_prefixes );
}
foreach ( $css_prefixes as $css_prefix ) {
$selector_with_prefix = '';
$selector_elements = explode( ',', $selector );
if ( is_array( $selector_elements ) && count( $selector_elements ) > 0 ) {
$selector_with_prefix = implode( ',', preg_filter( '/^/', $css_prefix, $selector_elements ) );
}
if ( ! empty( $selector_with_prefix ) ) {
$hash_id_for_fix_selectors = crc32( $selector_with_prefix );
// Checking: if the current value of the sector is the default,
// given that the default value can be set in a different css-unit
// (px, em, rem... etc) than the current value
// (for example, the predefined default value can be '0px', while the current selector value is '0em').
$maybe_selector_has_default_value = 0 === intval( $default_letter_spacing ) && 0 === intval( $css_value ) || ( $css_value === $default_letter_spacing );
if ( ! ( $maybe_selector_has_default_value ) ) {
$this->letter_spacing_fix_selectors[ $hash_id_for_fix_selectors ] = $selector_with_prefix;
} elseif ( isset( $this->letter_spacing_fix_selectors[ $hash_id_for_fix_selectors ] ) ) {
// If the selector has a default value, should delete it from
// array of selectors ($this->letter_spacing_fix_selectors) that need to be fixed,
// if it was added earlier.
unset( $this->letter_spacing_fix_selectors[ $hash_id_for_fix_selectors ] );
}
}
}
}
}
/**
* Process background CSS styles.
*
* @since 3.23 Add responsive support.
* @since 4.6.0 Add sticky style support.
*
* @param string $function_name Module slug.
*/
public function process_advanced_background_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
if ( ! self::$_->array_get( $this->advanced_fields, 'background', false ) ) {
return;
}
// Reset processed background.
if ( $this->save_processed_background ) {
$this->processed_background = array();
}
$settings = $this->advanced_fields['background'];
$important = isset( $settings['css']['important'] ) && $settings['css']['important'] ? ' !important' : '';
// Helpers.
$responsive = et_pb_responsive_options();
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
// Possible values for use_background_* variables are true, false, or 'fields_only'.
$has_background_color_toggle_options = $this->advanced_fields['background']['has_background_color_toggle'];
$use_background_color_gradient_options = $this->advanced_fields['background']['use_background_color_gradient'];
$use_background_image_options = $this->advanced_fields['background']['use_background_image'];
$use_background_color_options = $this->advanced_fields['background']['use_background_color'];
$use_background_color_reset_options = et_()->array_get( $this->advanced_fields, 'background.use_background_color_reset', true );
// Place to store processed background. It will be compared with the smaller device background
// processed value to avoid rendering the same styles.
$processed_background_color = '';
$processed_background_image = '';
$gradient_properties_desktop = array();
$processed_background_blend = '';
$background_color_gradient_overlays_image_desktop = 'off';
// Store background images status because the process is extensive.
$background_image_status = array(
'desktop' => false,
'tablet' => false,
'phone' => false,
);
$style_hover = '';
$style_sticky = '';
$dynamic_attributes = $this->_get_enabled_dynamic_attributes( $this->props );
// Background Desktop, Tablet, and Phone.
foreach ( $responsive->get_modes() as $device ) {
$is_desktop = 'desktop' === $device;
$suffix = ! $is_desktop ? "_{$device}" : '';
$style = '';
$has_background_color_gradient = false;
$has_background_image = false;
$has_background_gradient_and_image = false;
$is_background_color_gradient_disabled = false;
$is_background_image_disabled = false;
// Ensure responsive settings is enabled on mobile.
if ( ! $is_desktop && ! $responsive->is_responsive_enabled( $this->props, 'background' ) ) {
continue;
}
$background_image_style = '';
$background_color_style = '';
$background_images = array();
$background_color_gradient_overlays_image = 'off';
// A. Background Gradient.
if ( $use_background_color_gradient_options && 'fields_only' !== $use_background_color_gradient_options ) {
$use_background_color_gradient = $responsive->get_inheritance_background_value( $this->props, 'use_background_color_gradient', $device, 'background', $this->fields_unprocessed );
// 1. Ensure gradient color is active.
if ( 'on' === $use_background_color_gradient ) {
$background_color_gradient_overlays_image = $responsive->get_any_value( $this->props, "background_color_gradient_overlays_image{$suffix}", '', true );
$gradient_properties = array(
'type' => $responsive->get_any_value( $this->props, "background_color_gradient_type{$suffix}", '', true ),
'direction' => $responsive->get_any_value( $this->props, "background_color_gradient_direction{$suffix}", '', true ),
'radial_direction' => $responsive->get_any_value( $this->props, "background_color_gradient_direction_radial{$suffix}", '', true ),
'color_start' => $responsive->get_any_value( $this->props, "background_color_gradient_start{$suffix}", '', true ),
'color_end' => $responsive->get_any_value( $this->props, "background_color_gradient_end{$suffix}", '', true ),
'start_position' => $responsive->get_any_value( $this->props, "background_color_gradient_start_position{$suffix}", '', true ),
'end_position' => $responsive->get_any_value( $this->props, "background_color_gradient_end_position{$suffix}", '', true ),
);
// Will be used as default of Gradient hover.
if ( $is_desktop ) {
$gradient_properties_desktop = $gradient_properties;
$background_color_gradient_overlays_image_desktop = $background_color_gradient_overlays_image;
}
// Save background gradient into background images list.
$background_gradient = $this->get_gradient( $gradient_properties );
$background_images[] = $background_gradient;
// Save resulted gradient into property for later usage.
if ( $this->save_processed_background ) {
et_()->array_set( $this->processed_background, "{$device}.gradient", $background_gradient );
}
// Flag to inform BG Color if current module has Gradient.
$has_background_color_gradient = true;
} elseif ( 'off' === $use_background_color_gradient ) {
$is_background_color_gradient_disabled = true;
}
}
// B. Background Image.
if ( $use_background_image_options && 'fields_only' !== $use_background_image_options ) {
$background_image = $responsive->get_inheritance_background_value( $this->props, 'background_image', $device, 'background', $this->fields_unprocessed );
$parallax = $responsive->get_any_value( $this->props, "parallax{$suffix}", 'off' );
// Determine whether force inline styles.
if ( ! self::$forced_inline_styles ) {
$background_image_field = $responsive->get_field_name( 'background_image', $device );
$raw = isset( $this->attrs_unprocessed[ $background_image_field ] ) ? $this->attrs_unprocessed[ $background_image_field ] : '';
if ( $this->_is_dynamic_value( $background_image_field, $raw, $dynamic_attributes ) ) {
self::$forced_inline_styles = true;
}
}
// Featured image as background is in higher priority.
if ( $this->featured_image_background ) {
$featured_image = et_()->array_get( $this->props, 'featured_image', '' );
$featured_placement = et_()->array_get( $this->props, 'featured_placement', '' );
$featured_image_src_obj = wp_get_attachment_image_src( get_post_thumbnail_id( self::_get_main_post_id() ), 'full' );
$featured_image_src = isset( $featured_image_src_obj[0] ) ? $featured_image_src_obj[0] : '';
if ( 'on' === $featured_image && 'background' === $featured_placement && '' !== $featured_image_src ) {
$background_image = $featured_image_src;
}
}
// BG image and parallax status.
$is_background_image_active = '' !== $background_image && 'on' !== $parallax;
$background_image_status[ $device ] = $is_background_image_active;
// 1. Ensure image exists and parallax is off.
if ( $is_background_image_active ) {
// Flag to inform BG Color if current module has Image.
$has_background_image = true;
// Check previous BG image status. Needed to get the correct value.
$is_prev_background_image_active = true;
if ( ! $is_desktop ) {
$is_prev_background_image_active = 'tablet' === $device ? $background_image_status['desktop'] : $background_image_status['tablet'];
}
// Size.
$background_size_default = et_()->array_get( $this->fields_unprocessed, 'background_size.default', '' );
$background_size = $responsive->get_any_value( $this->props, "background_size{$suffix}", $background_size_default, ! $is_prev_background_image_active );
if ( '' !== $background_size ) {
$style .= sprintf(
'background-size: %1$s; ',
esc_html( $background_size )
);
}
// Position.
$background_position_default = et_()->array_get( $this->fields_unprocessed, 'background_position.default', '' );
$background_position = $responsive->get_any_value( $this->props, "background_position{$suffix}", $background_position_default, ! $is_prev_background_image_active );
if ( '' !== $background_position ) {
$style .= sprintf(
'background-position: %1$s; ',
esc_html( str_replace( '_', ' ', $background_position ) )
);
}
// Repeat.
$background_repeat_default = et_()->array_get( $this->fields_unprocessed, 'background_repeat.default', '' );
$background_repeat = $responsive->get_any_value( $this->props, "background_repeat{$suffix}", $background_repeat_default, ! $is_prev_background_image_active );
if ( '' !== $background_repeat ) {
$style .= sprintf(
'background-repeat: %1$s; ',
esc_html( $background_repeat )
);
}
// Blend.
$background_blend_default = et_()->array_get( $this->fields_unprocessed, 'background_blend.default', '' );
$background_blend = $responsive->get_any_value( $this->props, "background_blend{$suffix}", $background_blend_default, ! $is_prev_background_image_active );
$background_blend_inherit = $responsive->get_any_value( $this->props, "background_blend{$suffix}", '', true );
if ( '' !== $background_blend_inherit ) {
// Don't print the same image blend style.
if ( '' !== $background_blend ) {
$style .= sprintf(
'background-blend-mode: %1$s; ',
esc_html( $background_blend )
);
}
// Reset - If background has image and gradient, force background-color: initial.
if ( $has_background_color_gradient && $has_background_image && 'fields_only' !== $use_background_color_reset_options && $background_blend_inherit !== $background_blend_default ) {
$has_background_gradient_and_image = true;
$background_color_style = 'initial';
$style .= sprintf( 'background-color: initial%1$s; ', esc_html( $important ) );
}
$processed_background_blend = $background_blend;
}
// Only append background image when the image is exist.
$background_images[] = sprintf( 'url(%1$s)', esc_url( $background_image ) );
} elseif ( '' === $background_image ) {
// Reset - If background image is disabled, ensure we reset prev background blend mode.
if ( '' !== $processed_background_blend ) {
$style .= 'background-blend-mode: normal; ';
$processed_background_blend = '';
}
$is_background_image_disabled = true;
}
}
if ( ! empty( $background_images ) ) {
// The browsers stack the images in the opposite order to what you'd expect.
if ( 'on' !== $background_color_gradient_overlays_image ) {
$background_images = array_reverse( $background_images );
} else {
// Save gradient setting into property for later usage.
if ( $this->save_processed_background ) {
et_()->array_set( $this->processed_background, "{$device}.gradient_overlays_image", true );
}
}
// Set background image styles only it's different compared to the larger device.
$background_image_style = join( ', ', $background_images );
if ( $processed_background_image !== $background_image_style ) {
$style .= sprintf(
'background-image: %1$s%2$s;',
esc_html( $background_image_style ),
$important
);
}
} elseif ( ! $is_desktop && $is_background_color_gradient_disabled && $is_background_image_disabled ) {
// Reset - If background image and gradient are disabled, reset current background image.
$background_image_style = 'initial';
$style .= sprintf(
'background-image: %1$s%2$s;',
esc_html( $background_image_style ),
$important
);
}
// Save processed background images.
$processed_background_image = $background_image_style;
// C. Background Color.
if ( $use_background_color_options && 'fields_only' !== $use_background_color_options ) {
$use_background_color_value = $responsive->get_any_value( $this->props, "use_background_color{$suffix}", 'on', true );
if ( ! $has_background_gradient_and_image && 'off' !== $use_background_color_value ) {
$background_color = $responsive->get_inheritance_background_value( $this->props, 'background_color', $device, 'background', $this->fields_unprocessed );
$background_color = ! $is_desktop && '' === $background_color ? 'initial' : $background_color;
$background_color_style = $background_color;
if ( '' !== $background_color && $processed_background_color !== $background_color ) {
$style .= sprintf(
'background-color: %1$s%2$s; ',
esc_html( $background_color ),
esc_html( $important )
);
// If text module has background color set position to relative, as opposed to set text module as relative by default.
// Changing background selector to point to et_pb_text_inner will not render background correctly
// If position options are set they will override this value.
if ( 'et_pb_text' === $function_name ) {
$style .= 'position: relative; ';
}
}
} elseif ( $has_background_color_toggle_options && 'off' === $use_background_color_value && ! $is_desktop ) {
// Reset - If current module has background color toggle, it's off, and current mode
// it's not desktop, we should reset the background color.
$style .= sprintf(
'background-color: initial %1$s; ',
esc_html( $important )
);
}
}
// Save processed background color.
$processed_background_color = $background_color_style;
// Render background styles.
if ( '' !== $style ) {
// Add media query parameter.
$background_args = array();
if ( ! $is_desktop ) {
$current_media_query = 'tablet' === $device ? 'max_width_980' : 'max_width_767';
$background_args['media_query'] = self::get_media_query( $current_media_query );
}
$css_element = ! empty( $settings['css']['main'] ) ? $settings['css']['main'] : $this->main_css_element;
$style_defaults = array(
'selector' => $css_element,
'declaration' => rtrim( $style ),
'priority' => $this->_style_priority,
);
$el_style = wp_parse_args( $background_args, $style_defaults );
self::set_style( $function_name, $el_style );
}
}
// Background Hover.
if ( $hover->is_enabled( 'background', $this->props ) ) {
$background_images_hover = array();
$has_background_color_gradient_hover = false;
$has_background_image_hover = false;
$has_background_gradient_and_image_hover = false;
$is_background_color_gradient_hover_disabled = false;
$is_background_image_hover_disabled = false;
$background_color_gradient_overlays_image_hover = 'off';
// Background Gradient Hover.
// This part is little bit different compared to other hover implementation. In this case,
// hover is enabled on the background field, not on the each of those fields. So, built
// in function get_value() doesn't work in this case. Temporarily, we need to fetch the
// the value from get_raw_value().
if ( $use_background_color_gradient_options && 'fields_only' !== $use_background_color_gradient_options ) {
$use_background_color_gradient_hover = $responsive->get_inheritance_background_value( $this->props, 'use_background_color_gradient', 'hover', 'background', $this->fields_unprocessed );
// 1. Ensure gradient color is active and values are not null.
if ( 'on' === $use_background_color_gradient_hover ) {
// Desktop value as default.
$background_color_gradient_type_desktop = et_()->array_get( $gradient_properties_desktop, 'type', '' );
$background_color_gradient_direction_desktop = et_()->array_get( $gradient_properties_desktop, 'direction', '' );
$background_color_gradient_radial_direction_desktop = et_()->array_get( $gradient_properties_desktop, 'radial_direction', '' );
$background_color_gradient_color_start_desktop = et_()->array_get( $gradient_properties_desktop, 'color_start', '' );
$background_color_gradient_color_end_desktop = et_()->array_get( $gradient_properties_desktop, 'color_end', '' );
$background_color_gradient_start_position_desktop = et_()->array_get( $gradient_properties_desktop, 'start_position', '' );
$background_color_gradient_end_position_desktop = et_()->array_get( $gradient_properties_desktop, 'end_position', '' );
// Hover value.
$background_color_gradient_type_hover = $hover->get_raw_value( 'background_color_gradient_type', $this->props, $background_color_gradient_type_desktop );
$background_color_gradient_direction_hover = $hover->get_raw_value( 'background_color_gradient_direction', $this->props, $background_color_gradient_direction_desktop );
$background_color_gradient_direction_radial_hover = $hover->get_raw_value( 'background_color_gradient_direction_radial', $this->props, $background_color_gradient_radial_direction_desktop );
$background_color_gradient_start_hover = $hover->get_raw_value( 'background_color_gradient_start', $this->props, $background_color_gradient_color_start_desktop );
$background_color_gradient_end_hover = $hover->get_raw_value( 'background_color_gradient_end', $this->props, $background_color_gradient_color_end_desktop );
$background_color_gradient_start_position_hover = $hover->get_raw_value( 'background_color_gradient_start_position', $this->props, $background_color_gradient_start_position_desktop );
$background_color_gradient_end_position_hover = $hover->get_raw_value( 'background_color_gradient_end_position', $this->props, $background_color_gradient_end_position_desktop );
$background_color_gradient_overlays_image_hover = $hover->get_raw_value( 'background_color_gradient_overlays_image', $this->props, $background_color_gradient_overlays_image_desktop );
// Flag to inform BG Color if current module has Gradient.
$has_background_color_gradient_hover = true;
$gradient_values_hover = array(
'type' => '' !== $background_color_gradient_type_hover ? $background_color_gradient_type_hover : $background_color_gradient_type_desktop,
'direction' => '' !== $background_color_gradient_direction_hover ? $background_color_gradient_direction_hover : $background_color_gradient_direction_desktop,
'radial_direction' => '' !== $background_color_gradient_direction_radial_hover ? $background_color_gradient_direction_radial_hover : $background_color_gradient_radial_direction_desktop,
'color_start' => '' !== $background_color_gradient_start_hover ? $background_color_gradient_start_hover : $background_color_gradient_color_start_desktop,
'color_end' => '' !== $background_color_gradient_end_hover ? $background_color_gradient_end_hover : $background_color_gradient_color_end_desktop,
'start_position' => '' !== $background_color_gradient_start_position_hover ? $background_color_gradient_start_position_hover : $background_color_gradient_start_position_desktop,
'end_position' => '' !== $background_color_gradient_end_position_hover ? $background_color_gradient_end_position_hover : $background_color_gradient_end_position_desktop,
);
$background_gradient_hover = $this->get_gradient( $gradient_values_hover );
$background_images_hover[] = $background_gradient_hover;
// Save resulted gradient into property for later usage.
if ( $this->save_processed_background ) {
et_()->array_set( $this->processed_background, 'hover.gradient', $background_gradient_hover );
}
} elseif ( 'off' === $use_background_color_gradient_hover ) {
$is_background_color_gradient_hover_disabled = true;
}
}
// Background Image Hover.
// This part is little bit different compared to other hover implementation. In this case,
// hover is enabled on the background field, not on the each of those fields. So, built
// in function get_value() doesn't work in this case. Temporarily, we need to fetch the
// the value from get_raw_value().
if ( $use_background_image_options && 'fields_only' !== $use_background_image_options ) {
$background_image_hover = $responsive->get_inheritance_background_value( $this->props, 'background_image', 'hover', 'background', $this->fields_unprocessed );
$parallax_hover = $hover->get_raw_value( 'parallax', $this->props );
// Determine whether force inline styles.
if ( ! self::$forced_inline_styles ) {
$background_image_field = 'background_image__hover';
$raw = isset( $this->attrs_unprocessed[ $background_image_field ] ) ? $this->attrs_unprocessed[ $background_image_field ] : '';
if ( $this->_is_dynamic_value( $background_image_field, $raw, $dynamic_attributes ) ) {
self::$forced_inline_styles = true;
}
}
// Featured image as background is in higher priority.
if ( $this->featured_image_background ) {
$featured_image = et_()->array_get( $this->props, 'featured_image', '' );
$featured_placement = et_()->array_get( $this->props, 'featured_placement', '' );
$featured_image_src_obj = wp_get_attachment_image_src( get_post_thumbnail_id( self::_get_main_post_id() ), 'full' );
$featured_image_src = isset( $featured_image_src_obj[0] ) ? $featured_image_src_obj[0] : '';
if ( 'on' === $featured_image && 'background' === $featured_placement && '' !== $featured_image_src ) {
$background_image_hover = $featured_image_src;
}
}
if ( '' !== $background_image_hover && null !== $background_image_hover && 'on' !== $parallax_hover ) {
// Flag to inform BG Color if current module has Image.
$has_background_image_hover = true;
// Size.
$background_size_hover = $hover->get_raw_value( 'background_size', $this->props );
$background_size_desktop = et_()->array_get( $this->props, 'background_size', '' );
$is_same_background_size = $background_size_hover === $background_size_desktop;
if ( empty( $background_size_hover ) && ! empty( $background_size_desktop ) ) {
$background_size_hover = $background_size_desktop;
}
if ( ! empty( $background_size_hover ) && ! $is_same_background_size ) {
$style_hover .= sprintf(
'background-size: %1$s; ',
esc_html( $background_size_hover )
);
}
// Position.
$background_position_hover = $hover->get_raw_value( 'background_position', $this->props );
$background_position_desktop = et_()->array_get( $this->props, 'background_position', '' );
$is_same_background_position = $background_position_hover === $background_position_desktop;
if ( empty( $background_position_hover ) && ! empty( $background_position_desktop ) ) {
$background_position_hover = $background_position_desktop;
}
if ( ! empty( $background_position_hover ) && ! $is_same_background_position ) {
$style_hover .= sprintf(
'background-position: %1$s; ',
esc_html( str_replace( '_', ' ', $background_position_hover ) )
);
}
// Repeat.
$background_repeat_hover = $hover->get_raw_value( 'background_repeat', $this->props );
$background_repeat_desktop = et_()->array_get( $this->props, 'background_repeat', '' );
$is_same_background_repeat = $background_repeat_hover === $background_repeat_desktop;
if ( empty( $background_repeat_hover ) && ! empty( $background_repeat_desktop ) ) {
$background_repeat_hover = $background_repeat_desktop;
}
if ( ! empty( $background_repeat_hover ) && ! $is_same_background_repeat ) {
$style_hover .= sprintf(
'background-repeat: %1$s; ',
esc_html( $background_repeat_hover )
);
}
// Blend.
$background_blend_hover = $hover->get_raw_value( 'background_blend', $this->props );
$background_blend_default = et_()->array_get( $this->fields_unprocessed, 'background_blend.default', '' );
$background_blend_desktop = et_()->array_get( $this->props, 'background_blend', '' );
$is_same_background_blend = $background_blend_hover === $background_blend_desktop;
if ( empty( $background_blend_hover ) && ! empty( $background_blend_desktop ) ) {
$background_blend_hover = $background_blend_desktop;
}
if ( ! empty( $background_blend_hover ) ) {
// Don't print the same background blend.
if ( ! $is_same_background_blend ) {
$style_hover .= sprintf(
'background-blend-mode: %1$s; ',
esc_html( $background_blend_hover )
);
}
// Force background-color: initial;.
if ( $has_background_color_gradient_hover && $has_background_image_hover && $background_blend_hover !== $background_blend_default ) {
$has_background_gradient_and_image_hover = true;
$style_hover .= sprintf( 'background-color: initial%1$s; ', esc_html( $important ) );
}
}
// Only append background image when the image is exist.
$background_images_hover[] = sprintf( 'url(%1$s)', esc_url( $background_image_hover ) );
} elseif ( '' === $background_image_hover ) {
$is_background_image_hover_disabled = true;
}
}
if ( ! empty( $background_images_hover ) ) {
// The browsers stack the images in the opposite order to what you'd expect.
if ( 'on' !== $background_color_gradient_overlays_image_hover ) {
$background_images_hover = array_reverse( $background_images_hover );
} else {
// Save gradient setting into property for later usage.
if ( $this->save_processed_background ) {
et_()->array_set( $this->processed_background, 'hover.gradient_overlays_image', true );
}
}
$style_hover .= sprintf(
'background-image: %1$s%2$s;',
esc_html( join( ', ', $background_images_hover ) ),
$important
);
} elseif ( $is_background_color_gradient_hover_disabled && $is_background_image_hover_disabled ) {
$style_hover .= sprintf(
'background-image: initial %1$s;',
$important
);
}
// Background Color Hover.
if ( $use_background_color_options && 'fields_only' !== $use_background_color_options ) {
$use_background_color_hover_value = et_()->array_get( $this->props, 'use_background_color__hover', '' );
$use_background_color_hover_value = ! empty( $use_background_color_hover_value ) ? $use_background_color_hover_value : et_()->array_get( $this->props, 'use_background_color', 'on' );
if ( ! $has_background_gradient_and_image_hover && 'off' !== $use_background_color_hover_value ) {
$background_color_hover = $responsive->get_inheritance_background_value( $this->props, 'background_color', 'hover', 'background', $this->fields_unprocessed );
$background_color_hover = '' !== $background_color_hover ? $background_color_hover : 'transparent';
if ( '' !== $background_color_hover ) {
$style_hover .= sprintf(
'background-color: %1$s%2$s; ',
esc_html( $background_color_hover ),
esc_html( $important )
);
}
} elseif ( $has_background_color_toggle_options && 'off' === $use_background_color_hover_value ) {
// Reset - If current module has background color toggle, it's off, and current mode
// it's not desktop, we should reset the background color.
$style .= sprintf(
'background-color: initial %1$s; ',
esc_html( $important )
);
}
}
// Render background hover styles.
if ( '' !== $style_hover ) {
$css_element_main = et_()->array_get( $settings, 'css.main', $this->main_css_element );
$css_element_hover = et_()->array_get( $settings, 'css.hover', $hover->add_hover_to_order_class( $css_element_main ) );
$el_style = array(
'selector' => $css_element_hover,
'declaration' => rtrim( $style_hover ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
// Background Sticky.
// Mostly similar with how hover works but there are edge cases where different logic is applied.
if ( $sticky->is_enabled( 'background', $this->props ) ) {
$background_images_sticky = array();
$has_background_color_gradient_sticky = false;
$has_background_image_sticky = false;
$has_background_gradient_and_image_sticky = false;
$is_background_color_gradient_sticky_disabled = false;
$is_background_image_sticky_disabled = false;
$background_color_gradient_overlays_image_sticky = 'off';
// Background Gradient Sticky.
if ( $use_background_color_gradient_options && 'fields_only' !== $use_background_color_gradient_options ) {
$use_background_color_gradient_sticky = $responsive->get_inheritance_background_value( $this->props, 'use_background_color_gradient', 'sticky', 'background', $this->fields_unprocessed );
// 1. Ensure gradient color is active and values are not null.
if ( 'on' === $use_background_color_gradient_sticky ) {
// Desktop value as default.
$background_color_gradient_type_desktop = et_()->array_get( $gradient_properties_desktop, 'type', '' );
$background_color_gradient_direction_desktop = et_()->array_get( $gradient_properties_desktop, 'direction', '' );
$background_color_gradient_radial_direction_desktop = et_()->array_get( $gradient_properties_desktop, 'radial_direction', '' );
$background_color_gradient_color_start_desktop = et_()->array_get( $gradient_properties_desktop, 'color_start', '' );
$background_color_gradient_color_end_desktop = et_()->array_get( $gradient_properties_desktop, 'color_end', '' );
$background_color_gradient_start_position_desktop = et_()->array_get( $gradient_properties_desktop, 'start_position', '' );
$background_color_gradient_end_position_desktop = et_()->array_get( $gradient_properties_desktop, 'end_position', '' );
// sticky value.
$background_color_gradient_type_sticky = $sticky->get_raw_value( 'background_color_gradient_type', $this->props, $background_color_gradient_type_desktop );
$background_color_gradient_direction_sticky = $sticky->get_raw_value( 'background_color_gradient_direction', $this->props, $background_color_gradient_direction_desktop );
$background_color_gradient_direction_radial_sticky = $sticky->get_raw_value( 'background_color_gradient_direction_radial', $this->props, $background_color_gradient_radial_direction_desktop );
$background_color_gradient_start_sticky = $sticky->get_raw_value( 'background_color_gradient_start', $this->props, $background_color_gradient_color_start_desktop );
$background_color_gradient_end_sticky = $sticky->get_raw_value( 'background_color_gradient_end', $this->props, $background_color_gradient_color_end_desktop );
$background_color_gradient_start_position_sticky = $sticky->get_raw_value( 'background_color_gradient_start_position', $this->props, $background_color_gradient_start_position_desktop );
$background_color_gradient_end_position_sticky = $sticky->get_raw_value( 'background_color_gradient_end_position', $this->props, $background_color_gradient_end_position_desktop );
$background_color_gradient_overlays_image_sticky = $sticky->get_raw_value( 'background_color_gradient_overlays_image', $this->props, $background_color_gradient_overlays_image_desktop );
// Flag to inform BG Color if current module has Gradient.
$has_background_color_gradient_sticky = true;
$gradient_values_sticky = array(
'type' => '' !== $background_color_gradient_type_sticky ? $background_color_gradient_type_sticky : $background_color_gradient_type_desktop,
'direction' => '' !== $background_color_gradient_direction_sticky ? $background_color_gradient_direction_sticky : $background_color_gradient_direction_desktop,
'radial_direction' => '' !== $background_color_gradient_direction_radial_sticky ? $background_color_gradient_direction_radial_sticky : $background_color_gradient_radial_direction_desktop,
'color_start' => '' !== $background_color_gradient_start_sticky ? $background_color_gradient_start_sticky : $background_color_gradient_color_start_desktop,
'color_end' => '' !== $background_color_gradient_end_sticky ? $background_color_gradient_end_sticky : $background_color_gradient_color_end_desktop,
'start_position' => '' !== $background_color_gradient_start_position_sticky ? $background_color_gradient_start_position_sticky : $background_color_gradient_start_position_desktop,
'end_position' => '' !== $background_color_gradient_end_position_sticky ? $background_color_gradient_end_position_sticky : $background_color_gradient_end_position_desktop,
);
$background_gradient_sticky = $this->get_gradient( $gradient_values_sticky );
$background_images_sticky[] = $background_gradient_sticky;
// Save resulted gradient into property for later usage.
if ( $this->save_processed_background ) {
et_()->array_set( $this->processed_background, 'sticky.gradient', $background_gradient_sticky );
}
} elseif ( 'off' === $use_background_color_gradient_sticky ) {
$is_background_color_gradient_sticky_disabled = true;
}
}
// Background Image Sticky.
if ( $use_background_image_options && 'fields_only' !== $use_background_image_options ) {
$background_image_sticky = $responsive->get_inheritance_background_value( $this->props, 'background_image', 'sticky', 'background', $this->fields_unprocessed );
$parallax_sticky = $sticky->get_raw_value( 'parallax', $this->props );
// Determine whether force inline styles.
if ( ! self::$forced_inline_styles ) {
$background_image_field = 'background_image__sticky';
$raw = isset( $this->attrs_unprocessed[ $background_image_field ] ) ? $this->attrs_unprocessed[ $background_image_field ] : '';
if ( $this->_is_dynamic_value( $background_image_field, $raw, $dynamic_attributes ) ) {
self::$forced_inline_styles = true;
}
}
// Featured image as background is in higher priority.
if ( $this->featured_image_background ) {
$featured_image = et_()->array_get( $this->props, 'featured_image', '' );
$featured_placement = et_()->array_get( $this->props, 'featured_placement', '' );
$featured_image_src_obj = wp_get_attachment_image_src( get_post_thumbnail_id( self::_get_main_post_id() ), 'full' );
$featured_image_src = isset( $featured_image_src_obj[0] ) ? $featured_image_src_obj[0] : '';
if ( 'on' === $featured_image && 'background' === $featured_placement && '' !== $featured_image_src ) {
$background_image_sticky = $featured_image_src;
}
}
if ( '' !== $background_image_sticky && null !== $background_image_sticky && 'on' !== $parallax_sticky ) {
// Flag to inform BG Color if current module has Image.
$has_background_image_sticky = true;
// Size.
$background_size_sticky = $sticky->get_raw_value( 'background_size', $this->props );
$background_size_desktop = et_()->array_get( $this->props, 'background_size', '' );
$is_same_background_size = $background_size_sticky === $background_size_desktop;
if ( empty( $background_size_sticky ) && ! empty( $background_size_desktop ) ) {
$background_size_sticky = $background_size_desktop;
}
if ( ! empty( $background_size_sticky ) && ! $is_same_background_size ) {
$style_sticky .= sprintf(
'background-size: %1$s; ',
esc_html( $background_size_sticky )
);
}
// Position.
$background_position_sticky = $sticky->get_raw_value( 'background_position', $this->props );
$background_position_desktop = et_()->array_get( $this->props, 'background_position', '' );
$is_same_background_position = $background_position_sticky === $background_position_desktop;
if ( empty( $background_position_sticky ) && ! empty( $background_position_desktop ) ) {
$background_position_sticky = $background_position_desktop;
}
if ( ! empty( $background_position_sticky ) && ! $is_same_background_position ) {
$style_sticky .= sprintf(
'background-position: %1$s; ',
esc_html( str_replace( '_', ' ', $background_position_sticky ) )
);
}
// Repeat.
$background_repeat_sticky = $sticky->get_raw_value( 'background_repeat', $this->props );
$background_repeat_desktop = et_()->array_get( $this->props, 'background_repeat', '' );
$is_same_background_repeat = $background_repeat_sticky === $background_repeat_desktop;
if ( empty( $background_repeat_sticky ) && ! empty( $background_repeat_desktop ) ) {
$background_repeat_sticky = $background_repeat_desktop;
}
if ( ! empty( $background_repeat_sticky ) && ! $is_same_background_repeat ) {
$style_sticky .= sprintf(
'background-repeat: %1$s; ',
esc_html( $background_repeat_sticky )
);
}
// Blend.
$background_blend_sticky = $sticky->get_raw_value( 'background_blend', $this->props );
$background_blend_default = et_()->array_get( $this->fields_unprocessed, 'background_blend.default', '' );
$background_blend_desktop = et_()->array_get( $this->props, 'background_blend', '' );
$is_same_background_blend = $background_blend_sticky === $background_blend_desktop;
if ( empty( $background_blend_sticky ) && ! empty( $background_blend_desktop ) ) {
$background_blend_sticky = $background_blend_desktop;
}
if ( ! empty( $background_blend_sticky ) ) {
// Don't print the same background blend.
if ( ! $is_same_background_blend ) {
$style_sticky .= sprintf(
'background-blend-mode: %1$s; ',
esc_html( $background_blend_sticky )
);
}
// Force background-color value to initial.
if ( $has_background_color_gradient_sticky && $has_background_image_sticky && $background_blend_sticky !== $background_blend_default ) {
$has_background_gradient_and_image_sticky = true;
$style_sticky .= sprintf( 'background-color: initial%1$s; ', esc_html( $important ) );
}
}
// Only append background image when the image is exist.
$background_images_sticky[] = sprintf( 'url(%1$s)', esc_url( $background_image_sticky ) );
} elseif ( '' === $background_image_sticky ) {
$is_background_image_sticky_disabled = true;
}
}
if ( ! empty( $background_images_sticky ) ) {
// The browsers stack the images in the opposite order to what you'd expect.
if ( 'on' !== $background_color_gradient_overlays_image_sticky ) {
$background_images_sticky = array_reverse( $background_images_sticky );
} else {
// Save gradient setting into property for later usage.
if ( $this->save_processed_background ) {
et_()->array_set( $this->processed_background, 'sticky.gradient_overlays_image', true );
}
}
$style_sticky .= sprintf(
'background-image: %1$s%2$s;',
esc_html( join( ', ', $background_images_sticky ) ),
$important
);
} elseif ( $is_background_color_gradient_sticky_disabled && $is_background_image_sticky_disabled ) {
$style_sticky .= sprintf(
'background-image: initial %1$s;',
$important
);
}
// Background Color Sticky.
if ( $use_background_color_options && 'fields_only' !== $use_background_color_options ) {
$use_background_color_sticky_value = et_()->array_get( $this->props, 'use_background_color__sticky', '' );
$use_background_color_sticky_value = ! empty( $use_background_color_sticky_value ) ? $use_background_color_sticky_value : et_()->array_get( $this->props, 'use_background_color', 'on' );
if ( ! $has_background_gradient_and_image_sticky && 'off' !== $use_background_color_sticky_value ) {
$background_color_sticky = $responsive->get_inheritance_background_value( $this->props, 'background_color', 'sticky', 'background', $this->fields_unprocessed );
$background_color_sticky = '' !== $background_color_sticky ? $background_color_sticky : '';
if ( '' !== $background_color_sticky ) {
$style_sticky .= sprintf(
'background-color: %1$s%2$s; ',
esc_html( $background_color_sticky ),
esc_html( $important )
);
}
}
}
// Render Background Sticky styles.
if ( '' !== $style_sticky ) {
$css_element_main = et_()->array_get( $settings, 'css.main', $this->main_css_element );
$css_element_sticky = $sticky->add_sticky_to_order_class( $css_element_main, $this->is_sticky_module );
$css_element_sticky = et_()->array_get( $settings, 'css.sticky', $css_element_sticky );
$el_style = array(
'selector' => $css_element_sticky,
'declaration' => rtrim( $style_sticky ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
// Add hover styles in sticky state.
if ( '' !== $style_hover ) {
$el_style = array(
'selector' => $sticky->add_sticky_to_order_class(
$css_element_hover,
$this->is_sticky_module
),
'declaration' => rtrim( $style_hover ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
}
}
/**
* Process advanced text options.
*
* @since 3.23 Add support to generate responsive styles of text orientation.
*
* @param string $function_name Module slug.
*/
public function process_advanced_text_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
if ( ! self::$_->array_get( $this->advanced_fields, 'text', false ) ) {
return;
}
$text_options = $this->advanced_fields['text'];
if ( isset( $text_options['css'] ) && is_array( $text_options['css'] ) ) {
$text_css = $text_options['css'];
$text_orientation_default = isset( $this->fields_unprocessed['text_orientation']['default'] ) ? $this->fields_unprocessed['text_orientation']['default'] : '';
$text_orientation = $this->get_text_orientation() !== $text_orientation_default ? $this->get_text_orientation() : '';
$text_orientation_tablet = $this->get_text_orientation( 'tablet', $text_orientation_default );
$text_orientation_phone = $this->get_text_orientation( 'phone', $text_orientation_default );
// Normally, text orientation attr adds et_pb_text_align_* class name to its module wrapper
// In some cases, it needs to target particular children inside the module. Thus, only prints
// styling if selector is given.
if ( isset( $text_css['text_orientation'] ) ) {
$text_orientation_values = array(
'desktop' => esc_attr( $text_orientation ),
'tablet' => esc_attr( $text_orientation_tablet ),
'phone' => esc_attr( $text_orientation_phone ),
);
et_pb_responsive_options()->generate_responsive_css( $text_orientation_values, $text_css['text_orientation'], 'text-align', $function_name, '', 'alignment', $this->_style_priority );
}
}
}
/**
* Output border and border radius styling
*
* @param string $function_name Function name.
*
* @since 3.23 Add support to generate responsive styles of border styles and radii.]
* @since 4.6.0 Add sticky style support.
*/
public function process_advanced_borders_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
global $et_fb_processing_shortcode_object;
$borders = self::$_->array_get( $this->advanced_fields, 'borders', array( 'default' => array() ) );
$border_field = ET_Builder_Module_Fields_Factory::get( 'Border' );
$sticky = et_pb_sticky_options();
if ( is_array( $borders ) && ! empty( $borders ) ) {
foreach ( $borders as $border_name => $border ) {
if ( false === $border ) {
continue;
}
if ( 'image' === $border_name && 'et_pb_blurb' === $this->slug && 'on' === self::$_->array_get( $this->props, 'use_icon' ) ) {
continue;
}
if ( 'fullwidth' === $border_name && 'et_pb_blog' === $this->slug && 'on' !== self::$_->array_get( $this->props, 'fullwidth' ) ) {
continue;
}
if ( 'fields_focus' === $border_name && in_array( $this->slug, array( 'et_pb_login', 'et_pb_signup' ), true ) && 'on' !== self::$_->array_get( $this->props, 'use_focus_border_color' ) ) {
continue;
}
// Enable module to disable border options.
// Blurb image specific adjustment.
// Blog specific adjustment.
// Login & signup specific adjustment.
// Check field visibility against its dependency.
if ( ! $this->_is_field_applicable( $border ) ) {
continue;
}
$is_border_default = 'default' === $border_name;
$suffix = $is_border_default ? '' : "_{$border_name}";
if ( $is_border_default && $this->slug !== $function_name ) {
// This module's shortcode callback is being used to render another module (like accordion item
// uses toggle ) so we need to make sure border option overrides are taken from the other module
// instead of this one.
$fields = self::get_advanced_fields( $this->get_post_type(), 'all', $function_name );
$border = self::$_->array_get( $fields, 'advanced_common.border', array() );
}
// Backward compatibility. For 3rd party modules which define `_add_additional_border_fields` and do not have `process_advanced_border_options`.
if ( $is_border_default && method_exists( $this, '_add_additional_border_fields' ) ) {
$border = self::$_->array_get( $this->advanced_fields, 'border', array() );
}
// Do not add overflow:hidden for some modules.
$no_overflow_module = array(
'et_pb_social_media_follow',
'et_pb_social_media_follow_network',
'et_pb_menu',
'et_pb_fullwidth_menu',
);
$overflow = ! in_array( $function_name, $no_overflow_module, true );
$overflow_x = ! in_array( self::$_->array_get( $this->props, 'overflow-x' ), array( '', 'hidden' ), true );
$overflow_y = ! in_array( self::$_->array_get( $this->props, 'overflow-y' ), array( '', 'hidden' ), true );
// Remove "overflow: hidden" if both overflow-x and overflow-y are not empty or not set to "hidden"
// Add "overflow-y: hidden" if overflow-x is not empty or not set to "hidden" (or vice versa).
if ( $overflow_x && $overflow_y ) {
$overflow = false;
} elseif ( $overflow_x ) {
$overflow = 'overflow-y';
} elseif ( $overflow_y ) {
$overflow = 'overflow-x';
}
// Render border radii for all devices.
foreach ( et_pb_responsive_options()->get_modes() as $device ) {
$border_radii_attrs = array(
'selector' => self::$_->array_get( $border, 'css.main.border_radii', $this->main_css_element ),
'declaration' => $border_field->get_radii_style( $this->props, $this->advanced_fields, $suffix, $overflow, false, $device ),
'priority' => $this->_style_priority,
);
// Set media query attribute for non-desktop.
if ( 'desktop' !== $device ) {
$media_query = 'tablet' === $device ? 'max_width_980' : 'max_width_767';
$border_radii_attrs['media_query'] = self::get_media_query( $media_query );
}
self::set_style( $function_name, $border_radii_attrs );
}
if ( et_builder_is_hover_enabled( "border_radii$suffix", $this->props ) ) {
$main = self::$_->array_get( $border, 'css.hover', $this->main_css_element );
$main = self::$data_utils->array_get( $border, 'css.main.border_radii', $main );
$main = 'default' !== $border_name ? et_pb_hover_options()->add_hover_to_selectors( $main ) : et_pb_hover_options()->add_hover_to_order_class( $main );
$selector = self::$data_utils->array_get( $border, 'css.main.border_radii_hover', $main );
$el_style = array(
'selector' => $selector,
'declaration' => $border_field->get_radii_style( $this->props, $this->advanced_fields, $suffix, $overflow, true ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
if ( $sticky->is_enabled( "border_radii$suffix", $this->props ) ) {
$main = et_()->array_get( $border, 'css.sticky', $this->main_css_element );
$main = et_()->array_get( $border, 'css.main.border_radii', $main );
$main = 'default' !== $border_name ? $sticky->add_sticky_to_selectors( $main, $this->is_sticky_module ) : $sticky->add_sticky_to_order_class( $main, $this->is_sticky_module );
$selector = et_()->array_get( $border, 'css.main.border_radii_sticky', $main );
$el_style = array(
'selector' => $selector,
'declaration' => $border_field->get_radii_style(
$this->props,
$this->advanced_fields,
$suffix,
$overflow,
false,
'desktop',
true
),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
// Render border styles for all devices.
foreach ( et_pb_responsive_options()->get_modes() as $device ) {
$border_styles_attrs = array(
'selector' => self::$_->array_get( $border, 'css.main.border_styles', $this->main_css_element ),
'declaration' => $border_field->get_borders_style( $this->props, $this->advanced_fields, $suffix, false, $device ),
'priority' => $this->_style_priority,
);
// Set media query attribute for non-desktop.
if ( 'desktop' !== $device ) {
$media_query = 'tablet' === $device ? 'max_width_980' : 'max_width_767';
$border_styles_attrs['media_query'] = self::get_media_query( $media_query );
}
self::set_style( $function_name, $border_styles_attrs );
}
$main = self::$_->array_get( $border, 'css.hover', $this->main_css_element );
$main = self::$data_utils->array_get( $border, 'css.main.border_styles', $main );
$main = 'default' !== $border_name ? et_pb_hover_options()->add_hover_to_selectors( $main ) : et_pb_hover_options()->add_hover_to_order_class( $main );
$selector = self::$data_utils->array_get( $border, 'css.main.border_styles_hover', $main );
$el_style = array(
'selector' => $selector,
'declaration' => $border_field->get_borders_style( $this->props, $this->advanced_fields, $suffix, true ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
$main = et_()->array_get( $border, 'css.sticky', $this->main_css_element );
$main = et_()->array_get( $border, 'css.main.border_styles', $main );
$main = 'default' !== $border_name ? $sticky->add_sticky_to_selectors( $main, $this->is_sticky_module ) : $sticky->add_sticky_to_order_class( $main, $this->is_sticky_module );
$selector = et_()->array_get( $border, 'css.main.border_styles_sticky', $main );
$el_style = array(
'selector' => $selector,
'declaration' => $border_field->get_borders_style( $this->props, $this->advanced_fields, $suffix, false, 'desktop', true ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
}
if ( ! $et_fb_processing_shortcode_object && $border_field->needs_border_reset_class( $function_name, $this->props ) ) {
// Try to apply old method for plugins without vb support.
if ( 'on' !== $this->vb_support ) {
add_filter( "{$function_name}_shortcode_output", array( $border_field, 'add_border_reset_class' ), 10, 2 );
}
$this->add_classname( 'et_pb_with_border' );
}
if ( method_exists( $this, 'process_advanced_border_options' ) ) {
// Backwards Compatibility
// Call it after processing default fields because it's additional processing and is not replacement.
$this->process_advanced_border_options( $function_name );
}
}
/**
* Get active position locations.
*
* @return array
*/
public function get_position_locations() {
return $this->position_locations;
}
/**
* Set active position locations.
*
* @param string $locations Location name e.x center_center, top_left_is_default.
*/
public function set_position_locations( $locations ) {
$this->position_locations = $locations;
}
/**
* Process transform options.
*
* @param string $function_name Function name.
*
* @since 4.6.0 Add sticky style support.
*/
public function process_transform( $function_name ) {
$transform = self::$_->array_get( $this->advanced_fields, 'transform', array() );
if ( false === $transform || ! is_array( $transform ) ) {
return;
}
// @codingStandardsIgnoreLine
$selector = self::$_->array_get( $transform, 'css.main', '%%order_class%%' );
/**
* The "a" element of the button module is the one that should be
* scaled and not its wrapper
*/
if ( 'et_pb_button' === $function_name ) {
$selector .= ' a';
}
$important = self::$_->array_get( $transform, 'css.important', false );
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
$is_hover_enabled = $hover->is_enabled( 'transform_styles', $this->props );
$is_sticky_enabled = $sticky->is_enabled( 'transform_styles', $this->props );
$is_responsive_enabled = isset( $this->props['transform_styles_last_edited'] ) && et_pb_get_responsive_status( $this->props['transform_styles_last_edited'] );
$responsive_direction = isset( $this->props['animation_direction_last_edited'] ) && et_pb_get_responsive_status( $this->props['animation_direction_last_edited'] );
$animation_type = self::$_->array_get( $this->props, 'animation_style', 'none' );
/** Transform field class instance. @var $class ET_Builder_Module_Field_Transform */
$class = ET_Builder_Module_Fields_Factory::get( 'Transform' );
$class->set_props( $this->props + array( 'transforms_important' => $important ) );
$position_locations = $this->get_position_locations();
$views = array( 'desktop' );
if ( $is_hover_enabled || isset( $position_locations['hover'] ) ) {
array_push( $views, 'hover' );
}
if ( $is_sticky_enabled || isset( $position_locations['sticky'] ) ) {
array_push( $views, 'sticky' );
}
if ( $is_responsive_enabled || ( 'none' !== $animation_type && $responsive_direction )
|| ( isset( $position_locations['hover'] ) || isset( $position_locations['phone'] ) ) ) {
array_push( $views, 'tablet', 'phone' );
}
foreach ( $views as $view ) {
$view_selector = $selector;
$device = $view;
if ( ! $is_responsive_enabled && in_array( $view, array( 'phone', 'tablet' ), true ) || ( 'hover' === $view && ! $is_hover_enabled ) || ( 'sticky' === $view && ! $is_sticky_enabled ) ) {
$device = 'desktop';
}
$elements = $class->get_elements( $device );
$media_query = array();
if ( 'hover' === $view ) {
$view_selector = $selector . ':hover';
} elseif ( 'sticky' === $view ) {
$view_selector = $sticky->add_sticky_to_selectors( $selector, $this->is_sticky_module );
} elseif ( 'tablet' === $view ) {
$media_query = array(
'media_query' => self::get_media_query( 'max_width_980' ),
);
} elseif ( 'phone' === $view ) {
$media_query = array(
'media_query' => self::get_media_query( 'max_width_767' ),
);
}
if ( isset( $position_locations[ $view ] ) ) {
$default_strpos = strpos( $position_locations[ $view ], '_is_default' );
$location = $position_locations[ $view ];
if ( false !== $default_strpos ) {
$location = substr( $position_locations[ $view ], 0, $default_strpos );
}
if ( ! isset( $elements['transform']['translateX'] ) ) {
if ( in_array( $location, array( 'top_center', 'bottom_center', 'center_center' ), true ) ) {
$elements['transform']['translateX'] = '-50%';
} elseif ( 'desktop' !== $view ) {
$elements['transform']['translateX'] = '0px';
}
}
if ( ! isset( $elements['transform']['translateY'] ) ) {
if ( in_array( $location, array( 'center_left', 'center_right', 'center_center' ), true ) ) {
$elements['transform']['translateY'] = '-50%';
} elseif ( 'desktop' !== $view ) {
$elements['transform']['translateY'] = '0px';
}
}
}
if ( ! empty( $elements['transform'] ) || ! empty( $elements['origin'] ) ) {
if ( 'hover' !== $view && 'sticky' !== $view && ! empty( $animation_type ) && 'none' !== $animation_type && 'fade' !== $animation_type ) {
$transformed_animation = $class->transformedAnimation( $animation_type, $elements, $function_name, $device );
if ( ! empty( $transformed_animation ) ) {
self::set_style( $function_name, $transformed_animation['keyframe'] + $media_query );
self::set_style( $function_name, $transformed_animation['animationRules'] + $media_query );
$el_style = array(
'selector' => $view_selector,
'declaration' => $transformed_animation['declaration'],
'priority' => $this->_style_priority,
) + $media_query;
self::set_style( $function_name, $el_style );
}
} else {
$declaration = '';
if ( ! empty( $elements['transform'] ) ) {
$declaration .= $class->getTransformDeclaration( $elements['transform'], $view );
}
if ( ! empty( $elements['origin'] ) ) {
if ( $important ) {
array_push( $elements['origin'], '!important' );
}
$declaration .= sprintf( 'transform-origin:%s;', implode( ' ', $elements['origin'] ) );
}
$el_style = array(
'selector' => $view_selector,
'declaration' => $declaration,
'priority' => $this->_style_priority,
) + $media_query;
self::set_style( $function_name, $el_style );
// Flag sticky module that uses transform uses classname on module wrapper
// so its offset calculation can be adjusted (jQuery offsets() gets the edge
// of transformed module so its offset will be outside its parent).
if ( 'sticky' !== $view && $this->is_sticky_module ) {
$this->add_classname( 'et_pb_sticky--has-transform' );
}
}
}
}
}
/**
* Process position options.
*
* @param string $function_name Module slug.
*/
public function process_position( $function_name ) {
global $et_fb_processing_shortcode_object;
/**
* Position field instance. @var $position_class of `ET_Builder_Module_Field_Position`.
*/
$position_class = ET_Builder_Module_Fields_Factory::get( 'Position' );
$position_class->set_module( $this );
$position_class->process( $function_name );
// Expose position settings on layout block preview so necesary adjustment can be applied.
if ( ET_GB_Block_Layout::is_layout_block_preview() ) {
$layout_block_settings = $position_class->get_layout_block_settings( $function_name );
if ( is_array( $layout_block_settings ) && ! empty( $layout_block_settings ) ) {
self::$layout_block_assistive_settings['position'][] = array(
'selector' => '.' . self::get_module_order_class( $function_name ),
'settings' => $layout_block_settings,
);
}
}
// Exposes `position: relative` offsets settings. Offsets need to be rendered as inline
// style because `top`, `right`, `bottom`, and `left` are used to render sticky state
// in the module as inline module.
$responsive = et_pb_responsive_options();
$sticky = et_pb_sticky_options();
$positioning = $responsive->get_checked_property_value( $this->props, 'positioning', '', true );
$is_relative = is_string( $positioning ) && 'relative' === $positioning;
$has_relative = is_array( $positioning ) && in_array( 'relative', $positioning, true );
if ( ! $et_fb_processing_shortcode_object && $this->is_sticky_module && ( $is_relative || $has_relative ) ) {
$order_class = self::get_module_order_class( $this->slug );
// Set position style.
et_()->array_set(
self::$sticky_elements,
$order_class . '.styles.positioning',
$positioning
);
// Attributes list.
$relative_attributes = array(
'position_origin_r' => array(
'default' => 'top_left',
),
'horizontal_offset' => array(
'default' => '',
),
'vertical_offset' => array(
'default' => '',
),
);
// Loop over attributes list and save sticky style.
foreach ( $relative_attributes as $attr_name => $attr ) {
// Position origin should fallback to non-sticky value to avoid broken calculation.
$is_relative = 'position_origin_r' === $attr_name;
$attr_value_default = $is_relative ? et_()->array_get( $this->props, $attr_name, '' ) : '';
$attr_value = $sticky->get_value(
$attr_name,
$this->props,
$attr_value_default
);
et_()->array_set(
self::$sticky_elements,
$order_class . '.stickyStyles.' . $attr_name,
$attr_value
);
}
}
}
/**
* Adds Filter styles to the page custom css code
*
* Wrapper for `generate_css_filters` used for module defaults
*
* @param string $function_name Module slug.
*
* @return string|void
*/
public function process_advanced_filter_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
// Module has to explicitly set false to disable filters options.
if ( false === self::$_->array_get( $this->advanced_fields, 'filters', false ) ) {
return;
}
return $this->generate_css_filters( $function_name );
}
/**
* Process max width options
*
* @param string $function_name Function name.
*
* @since 4.6.0 Add sticky style support.
*/
public function process_max_width_options( $function_name ) {
global $et_fb_processing_shortcode_object;
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'max_width', false ) ) ) {
return;
}
$max_width = self::$_->array_get( $this->advanced_fields, 'max_width', array() );
$fields = array_merge( array( '' => $max_width ), self::$_->array_get( $max_width, 'extra', array() ) );
$order_class = self::get_module_order_class( $this->slug );
foreach ( $fields as $prefix => $field ) {
$is_customized = ! self::$_->array_get( $field, 'use_max_width', true ) && ! self::$_->array_get( $field, 'use_width', true );
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
if ( 'et_pb_section' === $this->slug && 'inner' === $prefix && 'on' !== $this->prop( 'specialty' ) ) {
// https://github.com/elegantthemes/Divi/issues/14445
// This is a hot fix due to the fact that in near future
// modules will be processed and rendered in VB
// The real solution requires handling modules fields dependencies in FE
// As section inner sizing depends on section `speciality`.
continue;
}
// Max width.
foreach ( array( 'width', 'max_width' ) as $key ) {
if ( ! self::$_->array_get( $field, "use_$key", true ) ) {
continue;
}
$slug = et_builder_add_prefix( $prefix, $key );
$css_prop = $this->field_to_css_prop( $key );
$option = self::$_->array_get( $this->fields_unprocessed, $slug, array() );
$width_options_css = self::$_->array_get( $field, 'css', array() );
$default_selector = self::$_->array_get( $width_options_css, 'main', '%%order_class%%' );
$selector = self::$_->array_get( $width_options_css, $key, $default_selector );
$desktop_default = self::$_->array_get( $option, 'default' );
$default = $desktop_default;
$width = $this->prop( $slug, $default );
$default_tablet = self::$_->array_get( $option, 'default_tablet', $width );
$width_tablet = $this->prop( "{$slug}_tablet", $default_tablet );
$default_phone = self::$_->array_get( $option, 'default_phone', $width_tablet );
$width_phone = $this->prop( "{$slug}_phone", $default_phone );
$width_hover = $hover->get_value( $slug, $this->props, '' );
$width_sticky = $sticky->get_value( $slug, $this->props, '' );
$width_last_edited = $this->prop( "{$slug}_last_edited", '' );
$width_responsive_active = et_pb_get_responsive_status( $width_last_edited );
$width = $width === $default ? '' : $width;
$width_tablet = $width_tablet === $default_tablet ? '' : $width_tablet;
$width_phone = $width_phone === $default_phone ? '' : $width_phone;
if ( '' !== $width_tablet || '' !== $width_phone || '' !== $width ) {
$additional_css = $this->get_max_width_additional_css();
$width_attrs = array( $slug );
// Append !important tag.
if ( isset( $width_options_css['important'] ) ) {
$additional_css = ' !important;';
}
if ( $width_responsive_active ) {
$width_values = array(
'desktop_only' => $width,
'tablet' => $width_tablet,
'phone' => $width_phone,
);
$selector_values = array(
'desktop_only' => $selector,
'tablet' => $selector,
'phone' => $selector,
);
$width_attrs = array_merge( $width_attrs, array( "{$slug}_tablet", "{$slug}_phone" ) );
} else {
$width_values = array(
'desktop' => $width,
);
$selector_values = array(
'desktop' => $selector,
);
}
// Update $is_max_width_customized if one of max_width* value is modified.
foreach ( $width_attrs as $width_attr ) {
if ( $is_customized ) {
break;
}
if ( ! in_array( self::$_->array_get( $this->props, $width_attr ), array( '', $default ), true ) ) {
$is_customized = true;
}
}
et_pb_responsive_options()->generate_responsive_css( $width_values, $selector_values, $css_prop, $function_name, $additional_css );
// Set module width and max-width into moduleSettings. These properties are
// rendered as inline style for constructing sticky behaviour thus it needs
// special adjustment to work correctly.
if ( ! $et_fb_processing_shortcode_object && $this->is_sticky_module ) {
et_()->array_set(
self::$sticky_elements,
self::get_module_order_class( $this->slug ) . '.styles.' . $css_prop,
$width_values
);
}
} elseif ( '' !== $default && '100%' !== $default && ! in_array( $default, array( 'auto', 'none' ), true ) ) {
$is_customized = true;
}
// Hover and/or Sticky styles.
if ( '' !== $width_hover || '' !== $width_sticky ) {
// Apply 100% max-width if there is only hover max-width set so that transition works.
$selector = isset( $width_options_css['main'] ) ? $width_options_css['main'] : '%%order_class%%';
$is_customized = true;
if ( '' === $width ) {
$hover_width = $desktop_default ? $desktop_default : '100%';
$hover_base = array(
'selector' => $selector,
'declaration' => esc_html( "$css_prop: $hover_width;" ),
);
self::set_style( $function_name, $hover_base );
}
// Hover style.
$additional_css = $this->get_max_width_additional_css();
if ( '' !== $width_hover ) {
$selector_hover = $hover->add_hover_to_order_class( $selector );
$hover_style = array(
'selector' => $selector_hover,
'declaration' => esc_html( "$css_prop: {$width_hover}{$additional_css};" ),
);
self::set_style( $function_name, $hover_style );
}
// Sticky style should be printed if module is INSIDE sticky module.
if ( $sticky->is_inside_sticky_module() && '' !== $width_sticky ) {
$sticky_child_selector = $sticky->add_sticky_to_selectors( $selector, false );
$sticky_child_style = array(
'selector' => $sticky_child_selector,
'declaration' => esc_html( "$css_prop: {$width_sticky}{$additional_css};" ),
);
self::set_style( $function_name, $sticky_child_style );
}
// Sticky style on sticky module: pass it to frontend as variables. Sticky style
// should not be rendered on page because it will be dynamically calculated
// and inserted as inline style.
if ( ! $et_fb_processing_shortcode_object && $this->is_sticky_module && '' !== $width_sticky ) {
et_()->array_set(
self::$sticky_elements,
$order_class . '.stickyStyles.' . $css_prop,
$width_sticky
);
// Adjustment for max-width.
if ( 'max-width' === $css_prop ) {
// Get sticky style width; fallback to desktop width if empty.
$sticky_style_width = et_()->array_get(
self::$sticky_elements,
$order_class . '.stickyStyles.width',
et_()->array_get(
self::$sticky_elements,
$order_class . '.styles.width',
''
)
);
// Force define width style using default value if max-width sticky
// style is used to handle various possible scenarios.
if ( '' !== $width_sticky && ! $sticky_style_width ) {
et_()->array_set(
self::$sticky_elements,
$order_class . '.styles.width',
et_()->array_get( $this->get_default_props(), 'width', '' )
);
}
}
}
}
}
// Module Alignment.
if ( self::$_->array_get( $field, 'use_module_alignment', true ) ) {
$module_alignment_styles = array(
'left' => 'margin-left: 0px !important; margin-right: auto !important;',
'center' => 'margin-left: auto !important; margin-right: auto !important;',
'right' => 'margin-left: auto !important; margin-right: 0px !important;',
);
$slug = et_builder_add_prefix( $prefix, 'module_alignment' );
$module_alignment = $this->prop( $slug, '' );
if ( $is_customized && isset( $module_alignment_styles[ $module_alignment ] ) ) {
if ( 'et_pb_contact_field' === $function_name ) {
$default_selector = self::$_->array_get( $field, 'css.main', 'p%%order_class%%' );
} else {
$default_selector = self::$_->array_get( $field, 'css.main', '%%order_class%%.et_pb_module' );
}
$selector = self::$_->array_get( $field, 'css.module_alignment', $default_selector );
$el_style = array(
'selector' => $selector,
'declaration' => $module_alignment_styles[ $module_alignment ],
'priority' => 20,
);
self::set_style( $function_name, $el_style );
}
$is_module_alignment_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, $slug );
$module_alignment_tablet = $this->prop( "{$slug}_tablet", '' );
if ( $is_customized && isset( $module_alignment_styles[ $module_alignment_tablet ] ) && $is_module_alignment_responsive ) {
$default_selector = self::$_->array_get( $field, 'css.main', '%%order_class%%.et_pb_module' );
$selector = self::$_->array_get( $field, 'css.module_alignment', $default_selector );
$el_style = array(
'selector' => $selector,
'declaration' => $module_alignment_styles[ $module_alignment_tablet ],
'priority' => 20,
'media_query' => self::get_media_query( 'max_width_980' ),
);
self::set_style( $function_name, $el_style );
}
$module_alignment_phone = $this->prop( "{$slug}_phone", '' );
if ( $is_customized && isset( $module_alignment_styles[ $module_alignment_phone ] ) && $is_module_alignment_responsive ) {
$default_selector = self::$_->array_get( $field, 'css.main', '%%order_class%%.et_pb_module' );
$selector = self::$_->array_get( $field, 'css.module_alignment', $default_selector );
$el_style = array(
'selector' => $selector,
'declaration' => $module_alignment_styles[ $module_alignment_phone ],
'priority' => 20,
'media_query' => self::get_media_query( 'max_width_767' ),
);
self::set_style( $function_name, $el_style );
}
// Set module alignment setting for sticky element.
if ( ! $et_fb_processing_shortcode_object && $this->is_sticky_module ) {
// Get default value. Check for default_sticky attribute before field's default
// because some module (row, row inner) have severe backward compatibility that
// updating its default to match visual appearance could cause issues.
$module_alignment_default = et_()->array_get(
$this->fields_unprocessed,
'module_alignment.default_sticky',
et_()->array_get(
$this->fields_unprocessed,
'module_alignment.default',
''
)
);
et_()->array_set(
self::$sticky_elements,
self::get_module_order_class( $this->slug ) . '.styles.module_alignment',
array(
'desktop' => '' !== $module_alignment ? $module_alignment : $module_alignment_default,
'tablet' => $module_alignment_tablet,
'phone' => $module_alignment_phone,
)
);
}
}
}
}
/**
* Return unique identifier for sticky element. For frontend, order class is considered unique
* and sufficient as identifier
*
* @since 4.6.0
*
* @param string $render_slug Render slug.
*
* @return string
*/
public function get_sticky_id( $render_slug = '' ) {
return self::get_module_order_class( $render_slug );
}
/**
* Process sticky element
*
* Append current module's sticky setting into static variable which will be exposed for js files
* Sticky element UX is fully handled via javascript; Module simply exposes the configuration
* for JS to initialized
*
* @since 4.6.0
*
* @param string $render_slug Render slug.
*/
public function process_sticky( $render_slug ) {
global $et_fb_processing_shortcode_object;
// Skip if current request is visual builder page.
if ( $et_fb_processing_shortcode_object ) {
return;
}
// Check if sticky is intentionally disabled or not.
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'sticky', array() ) ) ) {
return;
}
// Get sticky prefix.
$prefix = ET_Builder_Module_Fields_Factory::get( 'Sticky' )->get_default( 'prefix' );
// Bail if sticky option is not used OR there are incompatible attrs being used.
if ( ! et_pb_sticky_options()->is_sticky_module( $this->props ) ) {
return;
}
$responsive = et_pb_responsive_options();
$position = $responsive->get_checked_property_value(
$this->props,
$prefix . '_position',
'',
true
);
// Module's order class.
$selector = '.' . self::get_module_order_class( $render_slug );
// Some modules (eg. button module) have their order class wrapper wrapped by additional
// wrapper for alignment purpose. The selector needs to be adjusted to the most outer wrapper.
if ( et_()->array_get( $this->wrapper_settings, 'order_class_wrapper', false ) ) {
$selector .= '_wrapper';
}
// Generate sticky element settings that will be usedby stickyElement class.
// Can't directly pass attribute value because technically $prefix can be different.
// Settings' array element need to be fixed then.
$settings = array(
'id' => $this->get_sticky_id( $render_slug ),
'selector' => $selector,
'position' => et_core_intentionally_unescaped( $position, 'fixed_string' ),
'topOffset' => et_core_intentionally_unescaped( $responsive->get_checked_property_value( $this->props, $prefix . '_offset_top', '', true ), 'fixed_string' ),
'bottomOffset' => et_core_intentionally_unescaped( $responsive->get_checked_property_value( $this->props, $prefix . '_offset_bottom', '', true ), 'fixed_string' ),
'topLimit' => et_core_intentionally_unescaped( $responsive->get_checked_property_value( $this->props, $prefix . '_limit_top', '', true ), 'fixed_string' ),
'bottomLimit' => et_core_intentionally_unescaped( $responsive->get_checked_property_value( $this->props, $prefix . '_limit_bottom', '', true ), 'fixed_string' ),
'offsetSurrounding' => et_core_intentionally_unescaped( $responsive->get_checked_property_value( $this->props, $prefix . '_offset_surrounding', '', true ), 'fixed_string' ),
'transition' => et_core_intentionally_unescaped( $responsive->get_checked_property_value( $this->props, $prefix . '_transition', '', true ), 'fixed_string' ),
);
// Populate sticky element settings.
self::$sticky_elements[ self::get_module_order_class( $render_slug ) ] = $settings;
}
/**
* Process scroll effects options.
*
* @param string $function_name Module slug.
*/
public function process_scroll_effects( $function_name ) {
$advanced_fields = self::$_->array_get( $this->advanced_fields, 'scroll_effects', array( 'default' => array() ) );
if ( ! $advanced_fields ) {
return;
}
// Accordion Module reuses the Toggle Module and its child are not marked as child on FE, so check this specific case.
$is_child_element = 'child' === $this->type || 'et_pb_accordion_item' === $function_name;
$options = $this->get_scroll_effects_options();
$motion = ET_Builder_Module_Helper_Motion::instance();
$responsive = et_pb_responsive_options();
$devices = array(
$responsive::DESKTOP,
$responsive::TABLET,
$responsive::PHONE,
);
// Reset saved parent effects to not apply them on subsequent modules.
if ( ! $is_child_element ) {
self::$parent_motion_effects = array();
}
foreach ( $options as $id => $option ) {
$is_effect_enabled = 'on' === $this->prop( $id . '_enable' );
$is_inherit_parent = $is_child_element && ! empty( self::$parent_motion_effects ) && isset( self::$parent_motion_effects[ $id ] );
if ( ! $is_effect_enabled && ! $is_inherit_parent ) {
continue;
}
$default = $option['default'];
foreach ( $devices as $device ) {
if ( ! $is_effect_enabled ) {
$item = self::$parent_motion_effects[ $id ];
$item['id'] = '.' . self::get_module_order_class( $function_name );
$item['module_type'] = esc_html( $function_name );
} else {
$field = $responsive->get_field( $id, $device );
$default_value = $responsive->get_default_value( $this->props, $field, $default );
$saved_value = $this->prop( $field, $default_value );
$value = $motion->getValue( $saved_value, $default_value );
$grid_motion = $this->prop( 'enable_grid_motion', 'off' );
$trigger_start = $this->prop( 'motion_trigger_start', 'middle' );
$trigger_end = $this->prop( 'motion_trigger_end', 'middle' );
$grid_modules = array( 'et_pb_gallery', 'et_pb_portfolio', 'et_pb_fullwidth_portfolio', 'et_pb_filterable_portfolio', 'et_pb_shop', 'et_pb_blog' );
$item = array(
'id' => '.' . self::get_module_order_class( $function_name ),
'start' => $motion->getStartLimit( $value ),
'midStart' => $motion->getStartMiddle( $value ),
'midEnd' => $motion->getEndMiddle( $value ),
'end' => $motion->getEndLimit( $value ),
'startValue' => (float) $motion->getStartValue( $value ),
'midValue' => (float) $motion->getMiddleValue( $value ),
'endValue' => (float) $motion->getEndValue( $value ),
'resolver' => $option['resolver'],
'module_type' => esc_html( $function_name ),
'trigger_start' => $trigger_start,
'trigger_end' => $trigger_end,
);
$transform_class = ET_Builder_Module_Fields_Factory::get( 'Transform' );
$transform_class->set_props( $this->props + array( 'transforms_important' => true ) );
$elements = $transform_class->get_elements( $device );
// Process transforms if defined.
if ( ! empty( $elements ) && ! empty( $elements['transform'] ) ) {
$item['transforms'] = $elements['transform'];
}
if ( 'on' === $grid_motion ) {
$item['grid_motion'] = $grid_motion;
$item['children_count'] = in_array( $function_name, $grid_modules, true ) ? $this->prop( 'posts_number', 10 ) : 0;
$item['module_index'] = self::_get_index( array( self::INDEX_MODULE_ORDER, $function_name ) );
}
if ( $this->child_slug && 'on' === $grid_motion ) {
self::$parent_motion_effects[ $id ] = $item;
unset( self::$parent_motion_effects[ $id ]['id'], self::$parent_motion_effects[ $id ]['grid_motion'], self::$parent_motion_effects[ $id ]['children_count'], self::$parent_motion_effects[ $id ]['module_index'] );
$item['child_slug'] = $this->child_slug;
}
if ( $is_child_element ) {
if ( ! empty( self::$parent_motion_effects[ $id ] ) ) {
$additional_item = self::$parent_motion_effects[ $id ];
$additional_item['id'] = $item['id'];
self::$_scroll_effects_fields[ $device ][] = $additional_item;
}
} elseif ( 'on' !== $grid_motion ) {
self::$parent_motion_effects = array();
}
}
self::$_scroll_effects_fields[ $device ][] = $item;
}
}
}
/**
* Process height options
*
* @param string $function_name Function name.
*
* @since 4.6.0 Add sticky style support.
*/
public function process_height_options( $function_name ) {
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'height' ) ) ) {
return;
}
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
$responsive = et_pb_responsive_options();
$settings = self::$_->array_get( $this->advanced_fields, 'height', array() );
$fields = array_merge( array( '' => $settings ), self::$_->array_get( $settings, 'extra', array() ) );
foreach ( $fields as $prefix => $settings ) {
$prefix = et_builder_add_prefix( $prefix, '' );
$default_selector = self::$_->array_get( $settings, 'css.main', $this->main_css_element );
$helpers = array(
'height' => et_pb_height_options( $prefix ),
'min_height' => et_pb_min_height_options( $prefix ),
'max_height' => et_pb_max_height_options( $prefix ),
);
foreach ( $helpers as $key => $helper ) {
if ( ! self::$_->array_get( $settings, "use_{$key}", true ) ) {
continue;
}
$slug = $helper->get_field( $prefix );
$field = self::$_->array_get( $this->fields_unprocessed, $slug, array() );
$css_props = $this->field_to_css_prop( $key );
$selector = self::$_->array_get( $settings, "css.{$key}", $default_selector );
if ( $responsive->is_enabled( $slug, $this->props ) ) {
$values = array();
foreach ( $responsive->get_modes() as $mode ) {
$default_field = ET_Builder_Module_Helper_ResponsiveOptions::DESKTOP === $mode ? 'default' : "default_$mode";
$default = self::$_->array_get( $field, $default_field );
$values[ $mode ] = $responsive->get_value( $slug, $this->props, $mode, $default );
}
et_pb_responsive_options()->generate_responsive_css( $values, $selector, $css_props, $function_name );
} else {
$default = self::$_->array_get( $field, 'default' );
$value = $helper->get_value( $this->props, $default );
if ( '' !== $value && $value !== $default ) {
$el_style = array(
'selector' => $selector,
'declaration' => sprintf( '%1$s: %2$s;', $css_props, esc_attr( $value ) ),
);
self::set_style( $function_name, $el_style );
}
}
if ( $hover->is_enabled( $slug, $this->props ) ) {
$default = self::$_->array_get( $field, 'default' );
$value = $helper->get_value( $this->props, $default );
$hover_value = $hover->get_value( $slug, $this->props, $value );
$selector = $hover->add_hover_to_selectors( $selector );
if ( '' !== $hover_value && $hover_value !== $value ) {
$el_style = array(
'selector' => $selector,
'declaration' => sprintf( '%1$s: %2$s;', $css_props, esc_attr( $hover_value ) ),
);
self::set_style( $function_name, $el_style );
}
}
if ( $sticky->is_enabled( $slug, $this->props ) ) {
$default = self::$_->array_get( $field, 'default' );
$value = $helper->get_value( $this->props, $default );
$sticky_value = $sticky->get_value( $slug, $this->props, $value );
$selector = $sticky->add_sticky_to_selectors(
$selector,
$this->is_sticky_module
);
if ( '' !== $sticky_value && $value !== $sticky_value ) {
$el_style = array(
'selector' => $selector,
'declaration' => sprintf(
'%1$s: %2$s;',
$css_props,
esc_attr( $sticky_value )
),
);
self::set_style( $function_name, $el_style );
}
}
}
}
}
/**
* Process overflow options
*
* @param string $function_name Function name.
*
* @since 4.6.0 Add sticky style support.
*/
public function process_overflow_options( $function_name ) {
if ( ! is_array( self::$_->array_get( $this->advanced_fields, 'overflow', array() ) ) ) {
return;
}
$overflow = et_pb_overflow();
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
$responsive = et_pb_responsive_options();
$selector = self::$_->array_get(
$this->advanced_fields,
'overflow.css.main',
$this->main_css_element
);
$fields = array(
'overflow-x' => $overflow->get_field_x(),
'overflow-y' => $overflow->get_field_y(),
);
$controls = ET_Builder_Module_Fields_Factory::get( 'Overflow' )->get_fields( array(), true );
// Rebuilt template if template id is returned by get_fields().
if ( self::$option_template->is_enabled() && is_string( $controls ) ) {
$controls = self::$option_template->rebuild_field_template( $controls );
}
foreach ( $fields as $prop => $field ) {
$default_value = self::$_->array_get( $controls[ $field ], 'default', '' );
$overflow_values = et_pb_responsive_options()->get_property_values( $this->props, $field, $default_value );
et_pb_responsive_options()->generate_responsive_css( $overflow_values, $selector, $field, $function_name, '', 'overflow' );
if ( $hover->is_enabled( $field, $this->props ) ) {
$value = $hover->get_value( $field, $this->props, '' );
if ( '' !== $value ) {
$el_style = array(
'selector' => $hover->add_hover_to_selectors( $selector ),
'declaration' => sprintf( '%1$s: %2$s;', $field, esc_attr( $value ) ),
);
self::set_style( $function_name, $el_style );
}
}
if ( $sticky->is_enabled( $field, $this->props ) ) {
$value = $sticky->get_value( $field, $this->props, '' );
if ( '' !== $value ) {
$el_style = array(
'selector' => $sticky->add_sticky_to_selectors( $selector, $this->is_sticky_module ),
'declaration' => sprintf( '%1$s: %2$s;', $field, esc_attr( $value ) ),
);
self::set_style( $function_name, $el_style );
}
}
}
}
/**
* Process margin options
*
* @param string $function_name Function name.
*
* @since 4.6.0 Add sticky style support
*/
public function process_advanced_custom_margin_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_vb_support() && ! $this->has_advanced_fields ) {
return;
}
if ( ! self::$_->array_get( $this->advanced_fields, 'margin_padding', false ) ) {
return;
}
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
$style = '';
$style_padding = '';
$style_margin = '';
$style_mobile = array();
$style_mobile_padding = array();
$style_mobile_margin = array();
$important_options = array();
$is_important_set = isset( $this->advanced_fields['margin_padding']['css']['important'] );
$use_global_important = $is_important_set && 'all' === $this->advanced_fields['margin_padding']['css']['important'];
$css = isset( $this->advanced_fields['margin_padding']['css'] ) ? $this->advanced_fields['margin_padding']['css'] : array();
$item_mappings = array(
'top' => 0,
'right' => 1,
'bottom' => 2,
'left' => 3,
);
if ( $is_important_set && is_array( $this->advanced_fields['margin_padding']['css']['important'] ) ) {
$important_options = $this->advanced_fields['margin_padding']['css']['important'];
}
$custom_margin = $this->advanced_fields['margin_padding']['use_margin'] ? $this->props['custom_margin'] : '';
$custom_padding = $this->advanced_fields['margin_padding']['use_padding'] ? $this->props['custom_padding'] : '';
$custom_margin_responsive_active = isset( $this->props['custom_margin_last_edited'] ) ? et_pb_get_responsive_status( $this->props['custom_margin_last_edited'] ) : false;
$custom_margin_mobile = $custom_margin_responsive_active && $this->advanced_fields['margin_padding']['use_margin'] && ( isset( $this->props['custom_margin_tablet'] ) || isset( $this->props['custom_margin_phone'] ) )
? array(
'tablet' => isset( $this->props['custom_margin_tablet'] ) ? $this->props['custom_margin_tablet'] : '',
'phone' => isset( $this->props['custom_margin_phone'] ) ? $this->props['custom_margin_phone'] : '',
)
: '';
$custom_padding_responsive_active = isset( $this->props['custom_padding_last_edited'] ) ? et_pb_get_responsive_status( $this->props['custom_padding_last_edited'] ) : false;
$custom_padding_mobile = $custom_padding_responsive_active && $this->advanced_fields['margin_padding']['use_padding'] && ( isset( $this->props['custom_padding_tablet'] ) || isset( $this->props['custom_padding_phone'] ) )
? array(
'tablet' => isset( $this->props['custom_padding_tablet'] ) ? $this->props['custom_padding_tablet'] : '',
'phone' => isset( $this->props['custom_padding_phone'] ) ? $this->props['custom_padding_phone'] : '',
)
: '';
if ( '' !== $custom_padding || ! empty( $custom_padding_mobile ) ) {
$important = in_array( 'custom_padding', $important_options, true ) || $use_global_important ? true : false;
$has_padding_selector = isset( $this->advanced_fields['margin_padding']['css'] ) && isset( $this->advanced_fields['margin_padding']['css']['padding'] );
$padding_styling = '' !== $custom_padding ? et_builder_get_element_style_css( $custom_padding, 'padding', $important ) : '';
if ( $has_padding_selector ) {
$style_padding .= $padding_styling;
} else {
$style .= $padding_styling;
}
if ( ! empty( $custom_padding_mobile ) ) {
foreach ( $custom_padding_mobile as $device => $settings ) {
$padding_mobile_styling = '' !== $settings ? et_builder_get_element_style_css( $settings, 'padding', $important ) : '';
if ( $has_padding_selector ) {
$style_mobile_padding[ $device ][] = $padding_mobile_styling;
} else {
$style_mobile[ $device ][] = $padding_mobile_styling;
}
}
}
// Selective Paddings.
$selective_paddings = array_filter(
array(
'top' => isset( $css['padding-top'] ) ? $css['padding-top'] : false,
'right' => isset( $css['padding-right'] ) ? $css['padding-right'] : false,
'bottom' => isset( $css['padding-bottom'] ) ? $css['padding-bottom'] : false,
'left' => isset( $css['padding-left'] ) ? $css['padding-left'] : false,
)
);
// Only run the following if selective-padding selector is defined.
if ( ! empty( $selective_paddings ) ) {
// Loop each padding sides. Selective padding works by creating filtered custom_margin value on the fly, then pass it to existin declaration builder
// Ie custom_padding = 10px|10px|10px|10px. Selective padding for padding-top works by creating 10px||| value on the fly then pass it to declaration builder.
foreach ( $selective_paddings as $corner => $selective_padding_selectors ) {
// Default selective padding value: empty on all sides.
$selective_padding = array( '', '', '', '' );
// Get padding order key. Expected order: top|right|bottom|left.
$selective_padding_key = $item_mappings[ $corner ];
// Explode custom padding value into array.
$selective_padding_array = explode( '|', $custom_padding );
// Pick current padding side's value.
$selective_padding_value = isset( $selective_padding_array[ $selective_padding_key ] ) ? $selective_padding_array[ $selective_padding_key ] : '';
// Set selective padding value to $selective_padding.
$selective_padding[ $selective_padding_key ] = $selective_padding_value;
// If selective padding for current side is found, set style for it.
$selective_padding_filtered = array_filter( $selective_padding );
if ( ! empty( $selective_padding_filtered ) ) {
$el_style = array(
'selector' => $selective_padding_selectors,
'declaration' => rtrim( et_builder_get_element_style_css( implode( '|', $selective_padding ), 'padding' ) ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
// Check wheter responsive padding is activated and padding has mobile value.
if ( $custom_padding_responsive_active && is_array( $custom_padding_mobile ) ) {
// Assume no mobile padding value first.
$has_selective_padding_mobile = false;
// Set default selective padding mobile.
$selective_padding_mobile = array(
'tablet' => array( '', '', '', '' ),
'phone' => array( '', '', '', '' ),
);
// Loop padding mobile. This results per-breakpoint padding value.
foreach ( $custom_padding_mobile as $breakpoint => $custom_padding_device ) {
// Explode per-breakpoint padding value into array.
$custom_padding_device_array = explode( '|', $custom_padding_device );
// Get current padding side value on current breakpoint.
$selective_padding_mobile_value = isset( $custom_padding_device_array[ $selective_padding_key ] ) ? $custom_padding_device_array[ $selective_padding_key ] : '';
// Set picked value into current padding side on current breakpoint.
$selective_padding_mobile[ $breakpoint ][ $selective_padding_key ] = $selective_padding_mobile_value;
// If the side of padding on current breakpoint has value, build CSS declaration for it mark selective padding mobile as exist.
$selective_padding_mobile[ $breakpoint ] = array_filter( $selective_padding_mobile[ $breakpoint ] );
if ( ! empty( $selective_padding_mobile[ $breakpoint ] ) ) {
$selective_padding_mobile[ $breakpoint ] = array( et_builder_get_element_style_css( implode( '|', $selective_padding_mobile[ $breakpoint ] ), 'padding' ) );
$has_selective_padding_mobile = true;
}
}
// Set style for selective padding on mobile.
if ( $has_selective_padding_mobile ) {
$this->process_advanced_mobile_margin_options(
$function_name,
$selective_padding_mobile,
$selective_padding_selectors
);
}
}
}
}
}
if ( '' !== $custom_margin || ! empty( $custom_margin_mobile ) ) {
$important = in_array( 'custom_margin', $important_options, true ) || $use_global_important ? true : false;
$has_margin_selector = isset( $this->advanced_fields['margin_padding']['css'] ) && isset( $this->advanced_fields['margin_padding']['css']['margin'] );
$margin_styling = '' !== $custom_margin ? et_builder_get_element_style_css( $custom_margin, 'margin', $important ) : '';
if ( $has_margin_selector || $this->is_sticky_module ) {
$style_margin .= $margin_styling;
} else {
$style .= $margin_styling;
}
if ( ! empty( $custom_margin_mobile ) ) {
foreach ( $custom_margin_mobile as $device => $settings ) {
$margin_mobile_styling = '' !== $settings ? et_builder_get_element_style_css( $settings, 'margin', $important ) : '';
if ( $has_margin_selector || $this->is_sticky_module ) {
$style_mobile_margin[ $device ][] = $margin_mobile_styling;
} else {
$style_mobile[ $device ][] = $margin_mobile_styling;
}
}
}
}
if ( '' !== $style_padding ) {
$css_element_padding = $this->advanced_fields['margin_padding']['css']['padding'];
$el_style = array(
'selector' => $css_element_padding,
'declaration' => rtrim( $style_padding ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
if ( '' !== $style_margin ) {
$css_element_margin = et_()->array_get(
$this->advanced_fields,
'margin_padding.css.margin',
$this->main_css_element
);
$el_style = array(
'selector' => $css_element_margin,
'declaration' => rtrim( $style_margin ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
if ( '' !== $style ) {
$css_element = ! empty( $this->advanced_fields['margin_padding']['css']['main'] ) ? $this->advanced_fields['margin_padding']['css']['main'] : $this->main_css_element;
$el_style = array(
'selector' => $css_element,
'declaration' => rtrim( $style ),
'priority' => $this->_style_priority,
);
self::set_style( $function_name, $el_style );
}
if ( ! empty( $style_mobile_padding ) ) {
$this->process_advanced_mobile_margin_options(
$function_name,
$style_mobile_padding,
$this->advanced_fields['margin_padding']['css']['padding']
);
}
if ( ! empty( $style_mobile_margin ) ) {
$css_element_margin_mobile = et_()->array_get(
$this->advanced_fields,
'margin_padding.css.margin',
et_()->array_get(
$this->advanced_fields,
'margin_padding.css.main',
$this->main_css_element
)
);
$this->process_advanced_mobile_margin_options(
$function_name,
$style_mobile_margin,
$css_element_margin_mobile
);
}
if ( ! empty( $style_mobile ) ) {
$css_element = ! empty( $this->advanced_fields['margin_padding']['css']['main'] ) ? $this->advanced_fields['margin_padding']['css']['main'] : $this->main_css_element;
$this->process_advanced_mobile_margin_options(
$function_name,
$style_mobile,
$css_element
);
}
// Hover styles.
$custom_margin_hover = $hover->get_value( 'custom_margin', $this->props );
if ( '' !== $custom_margin_hover && et_builder_is_hover_enabled( 'custom_margin', $this->props ) ) {
$css_element_margin = self::$_->array_get( $this->advanced_fields, 'margin_padding.css.margin', $this->main_css_element );
$el_style = array(
'selector' => $this->add_hover_to_order_class( $css_element_margin ),
'declaration' => rtrim( et_builder_get_element_style_css( $custom_margin_hover, 'margin', true ) ),
'priority' => 20,
);
self::set_style( $function_name, $el_style );
}
$custom_padding_hover = $hover->get_value( 'custom_padding', $this->props, '' );
if ( '' !== $custom_padding_hover && et_builder_is_hover_enabled( 'custom_padding', $this->props ) ) {
$css_element_padding = self::$_->array_get( $this->advanced_fields, 'margin_padding.css.padding', $this->main_css_element );
$el_style = array(
'selector' => $this->add_hover_to_order_class( $css_element_padding ),
'declaration' => rtrim( et_builder_get_element_style_css( $custom_padding_hover, 'padding', true ) ),
'priority' => 20,
);
self::set_style( $function_name, $el_style );
}
// Sticky styles.
$custom_margin_sticky = $sticky->get_value( 'custom_margin', $this->props );
if ( '' !== $custom_margin_sticky && $sticky->is_enabled( 'custom_margin', $this->props ) ) {
$css_element_margin = et_()->array_get( $this->advanced_fields, 'margin_padding.css.margin', $this->main_css_element );
$el_style = array(
'selector' => $sticky->add_sticky_to_order_class( $css_element_margin, $this->is_sticky_module ),
'declaration' => rtrim( et_builder_get_element_style_css( $custom_margin_sticky, 'margin', true ) ),
'priority' => 20,
);
self::set_style( $function_name, $el_style );
}
$custom_padding_sticky = $sticky->get_value( 'custom_padding', $this->props, '' );
if ( '' !== $custom_padding_sticky && $sticky->is_enabled( 'custom_padding', $this->props ) ) {
$css_element_padding = et_()->array_get( $this->advanced_fields, 'margin_padding.css.padding', $this->main_css_element );
$el_style = array(
'selector' => $sticky->add_sticky_to_order_class( $css_element_padding, $this->is_sticky_module ),
'declaration' => rtrim( et_builder_get_element_style_css( $custom_padding_sticky, 'padding', true ) ),
'priority' => 20,
);
self::set_style( $function_name, $el_style );
}
}
/**
* Process mobile margin options into CSS style.
*
* @param string $function_name Module slug.
* @param string $style_mobile Style array.
* @param string $css_element CSS element selector.
*/
public function process_advanced_mobile_margin_options( $function_name, $style_mobile, $css_element ) {
foreach ( $style_mobile as $device => $style ) {
if ( ! empty( $style ) ) {
$current_media_query = 'tablet' === $device ? 'max_width_980' : 'max_width_767';
$current_media_css = '';
foreach ( $style as $css_code ) {
$current_media_css .= $css_code;
}
if ( '' === $current_media_css ) {
continue;
}
$el_style = array(
'selector' => $css_element,
'declaration' => rtrim( $current_media_css ),
'priority' => $this->_style_priority,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
}
}
/**
* Returns setting hover value if hover is enabled.
*
* @param string $option Option name.
*
* @return mixed|null
*/
protected function get_hover_value( $option ) {
$enabled_option = 'background_color' === $option ? 'background' : $option;
$original_value = self::$_->array_get( $this->props, $option );
$hover_enabled = et_pb_hover_options()->is_enabled( $enabled_option, $this->props );
$value = et_pb_hover_options()->get_value( $option, $this->props );
return ( ! $hover_enabled || $original_value === $value ) ? null : $value;
}
/**
* Process advanced button options.
*
* @since 3.23 Add support to generate responsive styles of padding and button alignment.
* @since 4.6.0 Add sticky style support.
* @since 4.6.0 Background rendering is refactored; it now uses et_pb_background_options().
*
* @param string $function_name Module slug.
*/
public function process_advanced_button_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_advanced_fields ) {
return;
}
if ( ! self::$_->array_get( $this->advanced_fields, 'button', false ) ) {
return;
}
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
$has_wrapper = et_()->array_get( $this->wrapper_settings, 'order_class_wrapper', false );
foreach ( $this->advanced_fields['button'] as $option_name => $option_settings ) {
$button_custom = $this->props[ "custom_{$option_name}" ];
$button_use_icon = isset( $this->props[ "{$option_name}_use_icon" ] ) ? $this->props[ "{$option_name}_use_icon" ] : 'on';
// Button Icon.
$button_icon_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_icon" );
$button_icon = isset( $button_icon_values['desktop'] ) ? $button_icon_values['desktop'] : '';
$button_icon_tablet = isset( $button_icon_values['tablet'] ) ? $button_icon_values['tablet'] : '';
$button_icon_phone = isset( $button_icon_values['phone'] ) ? $button_icon_values['phone'] : '';
$important = et_()->array_get( $option_settings, 'css.important', false ) ?
' !important' : '';
// Button Icon Placement.
$button_icon_placement_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_icon_placement" );
$button_icon_placement = isset( $button_icon_placement_values['desktop'] ) ? $button_icon_placement_values['desktop'] : 'right';
$button_icon_placement_tablet = isset( $button_icon_placement_values['tablet'] ) ? $button_icon_placement_values['tablet'] : '';
$button_icon_placement_phone = isset( $button_icon_placement_values['phone'] ) ? $button_icon_placement_values['phone'] : '';
// Button Icon On Hover.
$button_on_hover_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_on_hover" );
$button_on_hover = isset( $button_on_hover_values['desktop'] ) ? $button_on_hover_values['desktop'] : '';
$button_on_hover_tablet = isset( $button_on_hover_values['tablet'] ) ? $button_on_hover_values['tablet'] : '';
$button_on_hover_phone = isset( $button_on_hover_values['phone'] ) ? $button_on_hover_values['phone'] : '';
// Button Text Size.
$button_text_size_hover = $this->get_hover_value( "{$option_name}_text_size" );
$button_text_size_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_text_size" );
$button_text_size = isset( $button_text_size_values['desktop'] ) ? $button_text_size_values['desktop'] : '';
$button_text_size_tablet = isset( $button_text_size_values['tablet'] ) ? $button_text_size_values['tablet'] : '';
$button_text_size_phone = isset( $button_text_size_values['phone'] ) ? $button_text_size_values['phone'] : '';
// Button Text Color.
$button_text_color_hover = $this->get_hover_value( "{$option_name}_text_color" );
$button_text_color_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_text_color" );
$button_text_color = isset( $button_text_color_values['desktop'] ) ? $button_text_color_values['desktop'] : '';
$button_text_color_tablet = isset( $button_text_color_values['tablet'] ) ? $button_text_color_values['tablet'] : '';
$button_text_color_phone = isset( $button_text_color_values['phone'] ) ? $button_text_color_values['phone'] : '';
// Button Border Width.
$button_border_width_hover = $this->get_hover_value( "{$option_name}_border_width" );
$button_border_width_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_border_width" );
$button_border_width = isset( $button_border_width_values['desktop'] ) ? $button_border_width_values['desktop'] : '';
$button_border_width_tablet = isset( $button_border_width_values['tablet'] ) ? $button_border_width_values['tablet'] : '';
$button_border_width_phone = isset( $button_border_width_values['phone'] ) ? $button_border_width_values['phone'] : '';
// Button Border Color.
$button_border_color_hover = $this->get_hover_value( "{$option_name}_border_color" );
$button_border_color_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_border_color" );
$button_border_color = isset( $button_border_color_values['desktop'] ) ? $button_border_color_values['desktop'] : '';
$button_border_color_tablet = isset( $button_border_color_values['tablet'] ) ? $button_border_color_values['tablet'] : '';
$button_border_color_phone = isset( $button_border_color_values['phone'] ) ? $button_border_color_values['phone'] : '';
// Button Border Radius.
$button_border_radius_hover = $this->get_hover_value( "{$option_name}_border_radius" );
$button_border_radius_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_border_radius" );
$button_border_radius = isset( $button_border_radius_values['desktop'] ) ? $button_border_radius_values['desktop'] : '';
$button_border_radius_tablet = isset( $button_border_radius_values['tablet'] ) ? $button_border_radius_values['tablet'] : '';
$button_border_radius_phone = isset( $button_border_radius_values['phone'] ) ? $button_border_radius_values['phone'] : '';
// Button Font.
$button_font_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_font" );
$button_font = isset( $button_font_values['desktop'] ) ? $button_font_values['desktop'] : '';
$button_font_tablet = isset( $button_font_values['tablet'] ) ? $button_font_values['tablet'] : '';
$button_font_phone = isset( $button_font_values['phone'] ) ? $button_font_values['phone'] : '';
// Button Letter Spacing.
$button_letter_spacing_hover = $this->get_hover_value( "{$option_name}_letter_spacing" );
$button_letter_spacing_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_letter_spacing" );
$button_letter_spacing = isset( $button_letter_spacing_values['desktop'] ) ? $button_letter_spacing_values['desktop'] : '';
$button_letter_spacing_tablet = isset( $button_letter_spacing_values['tablet'] ) ? $button_letter_spacing_values['tablet'] : '';
$button_letter_spacing_phone = isset( $button_letter_spacing_values['phone'] ) ? $button_letter_spacing_values['phone'] : '';
// Button Icon Color.
$button_icon_color_hover = et_pb_hover_options()->get_value( "{$option_name}_icon_color", $this->props );
$button_icon_color_sticky = $sticky->get_value( "{$option_name}_icon_color", $this->props );
$button_icon_color_values = et_pb_responsive_options()->get_property_values( $this->props, "{$option_name}_icon_color" );
$button_icon_color = isset( $button_icon_color_values['desktop'] ) ? $button_icon_color_values['desktop'] : '';
$button_icon_color_tablet = isset( $button_icon_color_values['tablet'] ) ? $button_icon_color_values['tablet'] : '';
$button_icon_color_phone = isset( $button_icon_color_values['phone'] ) ? $button_icon_color_values['phone'] : '';
$button_icon_pseudo_selector = 'left' === $button_icon_placement ? ':before' : ':after';
// Hide button settings.
$hide_icon_setting = isset( $option_settings['hide_icon'] ) ? $option_settings['hide_icon'] : false;
$hide_custom_padding_setting = isset( $option_settings['hide_custom_padding'] ) ? $option_settings['hide_custom_padding'] : false;
// If module hides the button icon settings, no need to render button icon. So, we need
// to the button_use_icon value as 'off'.
if ( $hide_icon_setting ) {
$button_use_icon = 'off';
}
// Specific selector needs to be explicitly defined to make button alignment works.
if ( isset( $option_settings['use_alignment'] ) && $option_settings['use_alignment'] && isset( $option_settings['css'] ) && isset( $option_settings['css']['alignment'] ) ) {
$button_alignment_selector = $option_settings['css']['alignment'];
// Button alignment.
if ( '' !== $button_alignment_selector ) {
// Get button alignment responsive status.
$button_alignment_responsive_active = isset( $this->props[ "{$option_name}_alignment_last_edited" ] ) ? et_pb_get_responsive_status( $this->props[ "{$option_name}_alignment_last_edited" ] ) : false;
// Print styles for each devices.
foreach ( array( 'desktop', 'tablet', 'phone' ) as $device ) {
$is_desktop = 'desktop' === $device;
$button_key = ! $is_desktop ? "{$option_name}_alignment_{$device}" : "{$option_name}_alignment";
$button_alignment = $this->props[ "{$button_key}" ];
// Ensure button alignment value is not empty.
if ( empty( $button_alignment ) ) {
continue;
}
$button_alignment_data = array(
'selector' => $button_alignment_selector,
'declaration' => esc_html( "text-align: {$button_alignment};" ),
);
if ( ! $is_desktop ) {
// Skip tablet/phone if responsive setting is disabled.
if ( ! $button_alignment_responsive_active ) {
continue;
}
// Set media query for tablet/phone.
$current_media_query = 'tablet' === $device ? 'max_width_980' : 'max_width_767';
$button_alignment_data['media_query'] = self::get_media_query( $current_media_query );
}
self::set_style( $function_name, $button_alignment_data );
}
}
}
if ( 'on' === $button_custom ) {
// Default.
$is_default_button_text_size = $this->_is_field_default( 'button_text_size', $button_text_size );
$is_default_button_icon_placement = $this->_is_field_default( 'button_icon_placement', $button_icon_placement );
$is_default_button_on_hover = $this->_is_field_default( 'button_on_hover', $button_on_hover );
$is_default_button_icon = $this->_is_field_default( 'button_icon', $button_icon );
$is_default_hover_placement = $is_default_button_on_hover && $is_default_button_icon_placement;
// Processed values.
$button_text_size_processed = $is_default_button_text_size ? '20px' : et_builder_process_range_value( $button_text_size );
$button_text_size_hover_processed = strlen( $button_text_size_hover ) && $button_text_size !== $button_text_size_hover ? et_builder_process_range_value( $button_text_size_hover ) : '';
$button_border_radius_processed = '' !== $button_border_radius && 'px' !== $button_border_radius ? et_builder_process_range_value( $button_border_radius ) : '';
$button_border_radius_hover_processed = null !== $button_border_radius_hover && 'px' !== $button_border_radius_hover && $button_border_radius_hover !== $button_border_radius ? et_builder_process_range_value( $button_border_radius_hover ) : '';
$button_use_icon = '' === $button_use_icon ? 'on' : $button_use_icon;
$is_sticky_module_without_wrapper = $has_wrapper ? false : $this->is_sticky_module;
$css_element = ! empty( $option_settings['css']['main'] ) ? $option_settings['css']['main'] : $this->main_css_element . ' .et_pb_button';
$css_element_processed = $css_element;
$is_dbp = et_builder_has_limitation( 'use_limited_main' );
if ( $is_dbp && ! empty( $option_settings['css']['limited_main'] ) ) {
$css_element_processed = $option_settings['css']['limited_main'];
} elseif ( ! $is_dbp ) {
// Explicitly add '.et_pb_section' to the selector so selector splitting during prefixing
// does not incorrectly add third party classes before #et-boc.
$css_element_processed = "body #page-container .et_pb_section {$css_element}";
}
if ( et_builder_has_limitation( 'force_use_global_important' ) ) {
$button_border_radius_processed .= '' !== $button_border_radius_processed ? ' !important' : '';
$button_border_radius_hover_processed .= '' !== $button_border_radius_hover_processed ? ' !important' : '';
}
$global_use_icon_value = et_builder_option( 'all_buttons_icon' );
$main_element_styles_padding_important = 'no' === $global_use_icon_value && 'off' !== $button_use_icon;
// Check existing button custom padding on desktop before generating padding.
// If current button has custom padding, we should not set default padding,
// just leave it empty.
$button_padding_name = 'et_pb_button' !== $function_name ? "{$option_name}_custom_padding" : 'custom_padding';
$button_padding_value = et_pb_responsive_options()->get_any_value( $this->props, $button_padding_name );
$button_padding_value = ! empty( $button_padding_value ) ? explode( '|', $button_padding_value ) : array();
$button_padding_right = self::$_->array_get( $button_padding_value, 1, '' );
$button_padding_left = self::$_->array_get( $button_padding_value, 3, '' );
$main_element_styles = sprintf(
'%1$s
%2$s
%3$s
%4$s
%5$s
%6$s
%7$s
%8$s
%9$s',
'' !== $button_text_color ? sprintf( 'color:%1$s !important;', $button_text_color ) : '',
'' !== $button_border_width && 'px' !== $button_border_width ? sprintf( 'border-width:%1$s !important;', et_builder_process_range_value( $button_border_width ) ) : '',
'' !== $button_border_color ? sprintf( 'border-color:%1$s;', $button_border_color ) : '',
'' !== $button_border_radius_processed ? sprintf( 'border-radius:%1$s;', $button_border_radius_processed ) : '',
'' !== $button_letter_spacing && 'px' !== $button_letter_spacing ? sprintf( 'letter-spacing:%1$s;', et_builder_process_range_value( $button_letter_spacing ) ) : '', // #5
! $is_default_button_text_size ? sprintf( 'font-size:%1$s;', $button_text_size_processed ) : '',
'' !== $button_font ? et_builder_set_element_font( $button_font, true ) : '',
'off' === $button_on_hover && empty( $button_padding_right ) ?
sprintf(
'padding-right: %1$s%2$s;',
'left' === $button_icon_placement ? '0.7em' : '2em',
$main_element_styles_padding_important ? ' !important' : ''
)
: '',
'off' === $button_on_hover && empty( $button_padding_left ) ?
sprintf(
'padding-left:%1$s%2$s;',
'left' === $button_icon_placement ? '2em' : '0.7em',
$main_element_styles_padding_important ? ' !important' : ''
)
: ''
);
$el_style = array(
'selector' => $css_element_processed,
'declaration' => rtrim( $main_element_styles ),
);
self::set_style( $function_name, $el_style );
// Check existing button custom padding on hover before generating padding on
// hover. If current button has custom padding on hover, we should not set
// default padding on hover, just leave it empty.
$button_padding_hover_value = et_pb_hover_options()->get_value( $button_padding_name, $this->props, '' );
$button_padding_hover_value = ! empty( $button_padding_hover_value ) ? explode( '|', $button_padding_hover_value ) : array();
$button_padding_hover_right = self::$_->array_get( $button_padding_hover_value, 1, '' );
$button_padding_hover_left = self::$_->array_get( $button_padding_hover_value, 3, '' );
$on_hover_padding_right = ! empty( $button_padding_hover_right ) ? '' : sprintf(
'padding-right: %1$s%2$s;',
'left' === $button_icon_placement ? '0.7em' : '2em',
$main_element_styles_padding_important ? ' !important' : ''
);
$on_hover_padding_left = ! empty( $button_padding_hover_left ) ? '' : sprintf(
'padding-left: %1$s%2$s;',
'left' === $button_icon_placement ? '2em' : '0.7em',
$main_element_styles_padding_important ? ' !important' : ''
);
// if button has default icon position or disabled globally and not enabled in module then no padding css should be generated.
$on_hover_padding = $is_default_button_icon_placement || ( 'default' === $button_use_icon && 'no' === $global_use_icon_value )
? ''
: sprintf(
'%1$s%2$s',
$on_hover_padding_right,
$on_hover_padding_left
);
// Avoid adding useless style when value equals its default.
$button_letter_spacing_hover = $this->_is_field_default( $hover->get_hover_field( 'button_letter_spacing' ), $button_letter_spacing_hover ) ? '' : $button_letter_spacing_hover;
// Render hover and sticky style.
$modes = array( 'hover', 'sticky' );
$modes_properties = array(
'color' => 'text_color',
'border-color' => 'border_color',
'border-radius' => 'border_radius',
'letter-spacing' => 'letter_spacing',
'on-hover' => 'on_hover', // hover only.
'font-size' => 'text_size',
'border-width' => 'border_width',
);
foreach ( $modes as $mode ) {
$helper = et_builder_get_helper( $mode );
$mode_styles_declaration = '';
foreach ( $modes_properties as $mode_attr => $mode_property ) {
$mode_property_value = $helper->get_value(
$option_name . '_' . $mode_property,
$this->props,
''
);
// Further evaluation and process; some property needs it.
switch ( $mode_property ) {
case 'letter_spacing':
if ( 'px' === $mode_property_value ) {
$mode_property_value = '';
} elseif ( '' !== $mode_property_value ) {
$mode_property_value = et_builder_process_range_value( $mode_property_value );
}
break;
case 'on_hover':
if ( 'hover' === $mode ) {
$mode_property_value = 'off' === $button_on_hover || $hide_custom_padding_setting ? '' : $on_hover_padding;
} else {
$mode_property_value = '';
}
break;
}
// Concatenate the style.
if ( '' !== $mode_property_value ) {
if ( 'on_hover' === $mode_property ) {
$mode_styles_declaration .= $mode_property_value;
} else {
$mode_styles_declaration .= sprintf(
'%1$s:%2$s !important;',
esc_attr( $mode_attr ),
esc_attr( $mode_property_value )
);
}
}
}
// Trim unwanted whitespace from the output.
$mode_styles_declaration = rtrim( $mode_styles_declaration );
if ( '' !== $mode_styles_declaration ) {
switch ( $mode ) {
case 'sticky':
$mode_selector = $helper->add_sticky_to_order_class( $css_element_processed, $is_sticky_module_without_wrapper );
break;
case 'hover':
$mode_selector = $helper->add_hover_to_selectors( $css_element_processed );
break;
default:
$mode_selector = false;
break;
}
if ( ! $mode_selector ) {
continue;
}
$el_style = array(
'selector' => $mode_selector,
'declaration' => $mode_styles_declaration,
);
self::set_style( $function_name, $el_style );
}
}
$main_element_styles_after_hover = '';
$main_element_styles_after_sticky = '';
if ( 'off' === $button_use_icon ) {
$main_element_styles_after = 'display:none !important;';
$selector = sprintf( '%1$s:before, %1$s:after', $css_element_processed );
$no_icon_styles = '';
// Check button custom padding. Prepend option name to get the correct padding.
$custom_padding = self::$_->array_get( $this->props, 'custom_padding', '' );
if ( 'et_pb_button' !== $function_name ) {
$custom_padding = self::$_->array_get( $this->props, "{$option_name}_custom_padding", '' );
}
if ( empty( $custom_padding ) ) {
$no_icon_styles .= 'padding: 0.3em 1em !important;';
} else {
$padding_array = explode( '|', $custom_padding );
if ( empty( $padding_array[1] ) ) {
$no_icon_styles .= 'padding-right: 1em !important;';
}
if ( empty( $padding_array[3] ) ) {
$no_icon_styles .= 'padding-left: 1em !important;';
}
}
// No need to print custom padding if custom padding setting is disabled.
if ( ! empty( $no_icon_styles ) && ! $hide_custom_padding_setting ) {
$el_style = array(
'selector' => $css_element_processed . ',' . $css_element_processed . ':hover',
'declaration' => rtrim( $no_icon_styles ),
);
self::set_style( $function_name, $el_style );
}
} else {
$button_icon_code = '' !== $button_icon ? str_replace( ';', '', str_replace( '&#x', '', html_entity_decode( et_pb_process_font_icon( $button_icon ) ) ) ) : '';
$main_element_styles_after = sprintf(
'%1$s
%2$s
%3$s
%4$s
%5$s
%6$s
%7$s',
'' !== $button_icon_color ? sprintf( 'color:%1$s;', $button_icon_color ) : '',
'' !== $button_icon_code ? 'line-height: inherit;' : '',
'' !== $button_icon_code ? 'font-size: inherit !important;' : '',
$is_default_hover_placement ? '' : sprintf( 'opacity:%1$s;', 'off' !== $button_on_hover ? '0' : '1' ),
'off' !== $button_on_hover && '' !== $button_icon_code ?
sprintf(
'margin-left: %1$s; %2$s: auto;',
'left' === $button_icon_placement ? '-1.3em' : '-1em',
'left' === $button_icon_placement ? 'right' : 'left'
)
: '',
'off' === $button_on_hover ?
sprintf(
'margin-left: %1$s; %2$s:auto;',
'left' === $button_icon_placement ? '-1.3em' : '.3em',
'left' === $button_icon_placement ? 'right' : 'left'
)
: '',
( ! $is_default_button_icon_placement && in_array( $button_use_icon, array( 'default', 'on' ), true ) ? 'display: inline-block;' : '' )
);
if ( ! empty( $button_icon_color_hover ) && $button_icon_color_hover !== $button_icon_color ) {
$main_element_styles_after_hover = sprintf( 'color: %1$s', esc_html( $button_icon_color_hover ) );
}
if ( ! empty( $button_icon_color_sticky ) && $button_icon_color_sticky !== $button_icon_color ) {
$main_element_styles_after_sticky = sprintf( 'color: %1$s', esc_html( $button_icon_color_sticky ) );
}
// Reverse icon position.
if ( 'left' === $button_icon_placement ) {
$button_icon_left_content = '' !== $button_icon_code ? 'content: attr(data-icon);' : '';
$el_style = array(
'selector' => $css_element_processed . ':after',
'declaration' => 'display: none;',
);
self::set_style( $function_name, $el_style );
if ( et_builder_has_limitation( 'use_additional_limiting_styles' ) ) {
$el_style = array(
'selector' => '.et_pb_row ' . $css_element_processed . ':hover',
'declaration' => 'padding-right: 1em; padding-left: 2em;',
);
self::set_style( $function_name, $el_style );
}
$el_style = array(
'selector' => $css_element_processed . ':before',
'declaration' => $button_icon_left_content . ' ; font-family: "ETmodules" !important;',
);
self::set_style( $function_name, $el_style );
}
// if button has default icon/hover/placement and disabled globally or not enabled in module then no :after:hover css should be generated.
if ( ! ( $is_default_button_icon && $is_default_hover_placement ) &&
( 'default' !== $button_use_icon || 'no' !== $global_use_icon_value ) ) {
$hover_after_styles = sprintf(
'%1$s
%2$s
%3$s',
'' !== $button_icon_code ?
sprintf( 'margin-left:%1$s;', '35' !== $button_icon_code ? '.3em' : '0' )
: '',
'' !== $button_icon_code ?
sprintf(
'%1$s: auto; margin-left: %2$s;',
'left' === $button_icon_placement ? 'right' : 'left',
'left' === $button_icon_placement ? '-1.3em' : '.3em'
)
: '',
'off' !== $button_on_hover ? 'opacity: 1;' : ''
);
$el_style = array(
'selector' => $css_element_processed . ':hover' . $button_icon_pseudo_selector,
'declaration' => rtrim( $hover_after_styles ),
);
self::set_style( $function_name, $el_style );
}
if ( '' === $button_icon && ! $is_default_button_text_size ) {
$default_icons_size = '1.6em';
$custom_icon_size = $button_text_size_processed;
$el_style = array(
'selector' => $css_element_processed . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $default_icons_size ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => 'body.et_button_custom_icon #page-container ' . $css_element . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $custom_icon_size ),
);
self::set_style( $function_name, $el_style );
}
if ( '' === $button_icon && '' !== $button_text_size_hover_processed ) {
$default_icons_size = '1.6em';
$custom_icon_size = $button_text_size_hover_processed;
$el_style = array(
'selector' => $css_element_processed . ':hover' . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $default_icons_size ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => 'body.et_button_custom_icon #page-container ' . $css_element . ':hover' . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $custom_icon_size ),
);
self::set_style( $function_name, $el_style );
}
$selector = $css_element_processed . $button_icon_pseudo_selector;
}
$el_style = array(
'selector' => $selector,
'declaration' => rtrim( $main_element_styles_after ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => et_pb_hover_options()->add_hover_to_selectors( $selector ),
'declaration' => rtrim( $main_element_styles_after_hover ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => $sticky->add_sticky_to_order_class( $selector, $is_sticky_module_without_wrapper ),
'declaration' => rtrim( $main_element_styles_after_sticky ),
);
self::set_style( $function_name, $el_style );
// Responsive Button Styles.
$prev_icon = $button_icon;
foreach ( array( 'tablet', 'phone' ) as $device ) {
$current_media_query = 'tablet' === $device ? 'max_width_980' : 'max_width_767';
$current_text_size = 'tablet' === $device ? $button_text_size_tablet : $button_text_size_phone;
$current_text_size = '' !== $current_text_size ? et_builder_process_range_value( $current_text_size ) : '';
$current_text_color = 'tablet' === $device ? $button_text_color_tablet : $button_text_color_phone;
$current_border_width = 'tablet' === $device ? $button_border_width_tablet : $button_border_width_phone;
$current_border_width = '' !== $current_border_width ? et_builder_process_range_value( $current_border_width ) : '';
$current_border_color = 'tablet' === $device ? $button_border_color_tablet : $button_border_color_phone;
$current_border_radius = 'tablet' === $device ? $button_border_radius_tablet : $button_border_radius_phone;
$current_border_radius = '' !== $current_border_radius ? et_builder_process_range_value( $current_border_radius ) : '';
$current_letter_spacing = 'tablet' === $device ? $button_letter_spacing_tablet : $button_letter_spacing_phone;
$current_letter_spacing = '' !== $current_letter_spacing ? et_builder_process_range_value( $current_letter_spacing ) : '';
$current_font = 'tablet' === $device ? $button_font_tablet : $button_font_phone;
$current_icon_color = 'tablet' === $device ? $button_icon_color_tablet : $button_icon_color_phone;
// The attributes below should inherit larger device.
$current_icon = et_pb_responsive_options()->get_property_value( $this->props, "{$option_name}_icon", $button_icon, $device, true );
$current_icon_placement = et_pb_responsive_options()->get_property_value( $this->props, "{$option_name}_icon_placement", $button_icon_placement, $device, true );
$current_on_hover = et_pb_responsive_options()->get_property_value( $this->props, "{$option_name}_on_hover", $button_on_hover, $device, true );
$is_default_hover_placement = '' === $current_on_hover && '' === $current_icon_placement;
$button_icon_pseudo_selector = 'left' === $current_icon_placement ? ':before' : ':after';
// Force to have important tag.
if ( et_builder_has_limitation( 'force_use_global_important' ) ) {
$current_border_radius .= '' !== $current_border_radius ? ' !important' : '';
}
// Get right and left custom padding value. The reset padding should not
// be applied if current button has custom padding defined.
$current_padding_name = et_pb_responsive_options()->get_field_name( $button_padding_name, $device );
$current_padding_value = et_pb_responsive_options()->get_any_value( $this->props, $current_padding_name, '', true );
$current_padding_value = ! empty( $current_padding_value ) ? explode( '|', $current_padding_value ) : array();
$current_padding_default = et_pb_responsive_options()->get_default_value( $this->props, $current_padding_name );
$current_padding_default = ! empty( $current_padding_default ) ? explode( '|', $current_padding_default ) : array();
$current_padding_right = self::$_->array_get( $current_padding_value, 1, '' );
$current_padding_left = self::$_->array_get( $current_padding_value, 3, '' );
$current_padding_default_right = self::$_->array_get( $current_padding_default, 1, '' );
$current_padding_default_left = self::$_->array_get( $current_padding_default, 3, '' );
// Reset responsive padding right. Only reset padding if current device
// doesn't have value and the previous device has value to be reset.
$responsive_padding_right = '';
$responsive_hover_padding_right = '';
if ( empty( $current_padding_right ) && ! empty( $current_padding_default_right ) ) {
// Default padding for normal and hover.
$responsive_padding_right = '1em';
// If padding hover right deosn't exist, add default padding for hover.
if ( empty( $button_padding_hover_right ) ) {
$responsive_hover_padding_right = 'left' === $current_icon_placement ? '2em' : '0.7em';
}
// If icon on hover is disabled, set padding value like hover state
// and remove padding for hover because it's same.
if ( 'off' === $current_on_hover ) {
$responsive_padding_right = 'left' === $current_icon_placement ? '2em' : '0.7em';
$responsive_hover_padding_right = '';
}
}
// Reset responsive padding left. Only reset padding if current device
// doesn't have value and the previous device has value to be reset.
$responsive_padding_left = '';
$responsive_hover_padding_left = '';
if ( empty( $current_padding_left ) && ! empty( $current_padding_default_left ) ) {
// Default padding for normal and hover.
$responsive_padding_left = '1em';
// If padding hover left deosn't exist, add default padding for hover.
if ( empty( $button_padding_hover_left ) ) {
$responsive_hover_padding_left = 'left' === $current_icon_placement ? '2em' : '0.7em';
}
// If icon on hover is disabled, set padding value like hover state
// and remove padding for hover because it's same.
if ( 'off' === $current_on_hover ) {
$responsive_padding_left = 'left' === $current_icon_placement ? '0.7em' : '2em';
$responsive_hover_padding_left = '';
}
}
// Remove responsive on hover padding left & right.
if ( '' === $current_icon_placement || ( 'default' === $button_use_icon && 'no' === $global_use_icon_value ) || $hide_custom_padding_setting ) {
$responsive_hover_padding_left = '';
$responsive_hover_padding_right = '';
}
// Responsive button declaration.
$responsive_button_declaration = trim(
sprintf(
'%1$s
%2$s
%3$s
%4$s
%5$s
%6$s
%7$s
%8$s
%9$s',
'' !== $current_text_size ? sprintf( 'font-size:%1$s !important;', $current_text_size ) : '',
'' !== $current_letter_spacing ? sprintf( 'letter-spacing:%1$s;', $current_letter_spacing ) : '',
'' !== $current_text_color ? sprintf( 'color:%1$s !important;', $current_text_color ) : '',
'' !== $current_border_width ? sprintf( 'border-width:%1$s !important;', $current_border_width ) : '',
'' !== $current_border_color ? sprintf( 'border-color:%1$s;', $current_border_color ) : '', // #5
'' !== $current_border_radius ? sprintf( 'border-radius:%1$s;', $current_border_radius ) : '',
'' !== $current_font ? et_builder_set_element_font( $current_font, true ) : '',
'' !== $responsive_padding_right ?
sprintf(
'padding-right: %1$s%2$s;',
$responsive_padding_right,
$main_element_styles_padding_important ? ' !important' : ''
)
: '',
'' !== $responsive_padding_left ?
sprintf(
'padding-left: %1$s%2$s;',
$responsive_padding_left,
$main_element_styles_padding_important ? ' !important' : ''
)
: ''
)
);
if ( ! empty( $responsive_button_declaration ) ) {
$el_style = array(
'selector' => $css_element_processed,
'declaration' => $responsive_button_declaration,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
// Responsive button hover declaration.
$responsive_button_hover_declaration = trim(
sprintf(
'%1$s
%2$s',
'' !== $responsive_hover_padding_right ?
sprintf(
'padding-right: %1$s%2$s;',
$responsive_hover_padding_right,
$main_element_styles_padding_important ? ' !important' : ''
)
: '',
'' !== $responsive_hover_padding_left ?
sprintf(
'padding-left: %1$s%2$s;',
$responsive_hover_padding_left,
$main_element_styles_padding_important ? ' !important' : ''
)
: ''
)
);
// Responsive button hover styles.
if ( ! empty( $responsive_button_hover_declaration ) ) {
$el_style = array(
'selector' => $css_element_processed . ':hover',
'declaration' => $responsive_button_hover_declaration,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
// Responsive button after styles.
if ( 'off' !== $button_use_icon ) {
// Button Icon Code.
$current_icon_code = '' !== $current_icon ? str_replace( ';', '', str_replace( '&#x', '', html_entity_decode( et_pb_process_font_icon( $current_icon ) ) ) ) : '';
// 1. Set button color, line-height, font-size, and icon placement.
$responsive_button_after_declaration = trim(
sprintf(
'%1$s
%2$s
%3$s
%4$s
%5$s
%6$s
%7$s',
'' !== $current_icon_color ? sprintf( 'color:%1$s;', $current_icon_color ) : '',
'' !== $current_icon_code ? 'line-height: inherit;' : '',
'' !== $current_icon_code ? 'font-size: inherit !important;' : '',
'off' !== $current_on_hover && '' !== $current_icon_code ?
sprintf(
'margin-left: %1$s; %2$s: auto;',
'left' === $current_icon_placement ? '-1.3em' : '-1em',
'left' === $current_icon_placement ? 'right' : 'left'
)
: '',
'off' === $current_on_hover ?
sprintf(
'margin-left: %1$s; %2$s: auto;',
'left' === $current_icon_placement ? '-1.3em' : '.3em',
'left' === $current_icon_placement ? 'right' : 'left'
)
: '', // #5
'' !== $current_icon_placement && in_array( $button_use_icon, array( 'default', 'on' ), true ) ? 'display: inline-block;' : '',
'off' !== $current_on_hover ? 'opacity: 0;' : 'opacity: 1;'
)
);
if ( ! empty( $responsive_button_after_declaration ) ) {
$el_style = array(
'selector' => $css_element_processed . $button_icon_pseudo_selector,
'declaration' => $responsive_button_after_declaration,
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
// 2. DONE - Set custom icon and icon placement.
if ( '' !== $current_icon_code ) {
$button_icon_suffix = $prev_icon !== $current_icon ? "-{$device}" : '';
$button_icon_content = "content: attr(data-icon{$button_icon_suffix});";
$button_side_hide = ':before';
$button_side_display = ':after';
// Reverse icon position.
if ( 'left' === $current_icon_placement ) {
$button_side_hide = ':after';
$button_side_display = ':before';
}
$el_style = array(
'selector' => $css_element_processed . $button_side_hide,
'declaration' => 'display: none;',
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => $css_element_processed . $button_side_display,
'declaration' => $button_icon_content . ' font-family: "ETmodules" !important;',
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
// 3. If button has default icon/hover/placement and disabled globally or not enabled in module then
// no :after:hover css should be generated.
if ( ! ( '' === $current_icon && $is_default_hover_placement ) && ( 'default' !== $button_use_icon || 'no' !== $global_use_icon_value ) ) {
$hover_after_styles = sprintf(
'%1$s
%2$s
%3$s',
'' !== $current_icon_code ?
sprintf( 'margin-left:%1$s;', '35' !== $current_icon_code ? '.3em' : '0' )
: '',
'' !== $current_icon_code ?
sprintf(
'%1$s: auto; margin-left: %2$s;',
'left' === $current_icon_placement ? 'right' : 'left',
'left' === $current_icon_placement ? '-1.3em' : '.3em'
)
: '',
'off' !== $current_on_hover ? 'opacity: 1;' : ''
);
$el_style = array(
'selector' => $css_element_processed . ':hover' . $button_icon_pseudo_selector,
'declaration' => rtrim( $hover_after_styles ),
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
// Set button icon font size for default.
if ( '' === $current_icon && '' !== $current_text_size ) {
$default_icons_size = '1.6em';
$custom_icon_size = $current_text_size;
$el_style = array(
'selector' => $css_element_processed . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $default_icons_size ),
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => 'body.et_button_custom_icon #page-container ' . $css_element . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $custom_icon_size ),
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
// Set button icon font size on hover for default.
if ( '' === $current_icon && '' !== $button_icon && '' !== $button_text_size_hover_processed ) {
$default_icons_size = '1.6em';
$custom_icon_size = $button_text_size_hover_processed;
$el_style = array(
'selector' => $css_element_processed . ':hover' . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $default_icons_size ),
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
$el_style = array(
'selector' => 'body.et_button_custom_icon #page-container ' . $css_element . ':hover' . $button_icon_pseudo_selector,
'declaration' => sprintf( 'font-size:%1$s;', $custom_icon_size ),
'media_query' => self::get_media_query( $current_media_query ),
);
self::set_style( $function_name, $el_style );
}
}
// Set flag.
$prev_icon = $current_icon;
}
// Button background base prop name.
$base_prop_name = "{$option_name}_bg";
// Render button background style. Button background uses different prop name for
// activating gradient and activating hover + sticky mode thuse some aliases needs
// to be defined.
et_pb_background_options()->get_background_style(
array(
'base_prop_name' => $base_prop_name,
'props' => $this->props,
'selector' => $css_element_processed,
'selector_sticky' => $sticky->add_sticky_to_order_class( $css_element_processed, $is_sticky_module_without_wrapper ),
'function_name' => $function_name,
'important' => et_()->array_get( $option_settings, 'css.important', false ) ? ' !important' : '',
'use_background_video' => false,
'prop_name_aliases' => array(
"use_{$base_prop_name}_color_gradient" => "{$base_prop_name}_use_color_gradient",
"{$base_prop_name}" => "{$base_prop_name}_color",
),
)
);
}
}
}
/**
* Process form field options into correct CSS styles.
*
* Fields will be processed here (name, mode, custom selector):
*
* - Background Color -> Hover -> Form field selector
* - Background Focus Color -> Hover -> Form field focus selector
* - Text Color -> Hover -> Form field & placeholder selector
* - Text Focus Color -> Hover -> Form field & placeholder focus selector
*
* @since 3.23
* @since 4.6.0 Add sticky style support
*
* @param string $function_name Module slug.
*/
public function process_advanced_form_field_options( $function_name ) {
// Disable if module doesn't set advanced_fields property and has no VB support.
if ( ! $this->has_advanced_fields ) {
return;
}
// Ensure form field exist on advanced fields.
if ( ! self::$_->array_get( $this->advanced_fields, 'form_field', false ) ) {
return;
}
// Helpers.
$sticky = et_pb_sticky_options();
// Fetch every single form field instances.
foreach ( $this->advanced_fields['form_field'] as $option_name => $option_settings ) {
// 1.a. Build main element selector.
$element_selector = ! empty( $option_settings['css']['main'] ) ? $option_settings['css']['main'] : "{$this->main_css_element} .input";
if ( et_builder_has_limitation( 'use_limited_main' ) && ! empty( $option_settings['css']['limited_main'] ) ) {
$element_selector = $option_settings['css']['limited_main'];
}
// 1.b. Build pseudo element selector.
$element_hover_selector = ! empty( $option_settings['css']['hover'] ) ? $option_settings['css']['hover'] : "{$element_selector}:hover";
$element_focus_selector = ! empty( $option_settings['css']['focus'] ) ? $option_settings['css']['focus'] : "{$element_selector}:focus";
$element_focus_hover_selector = ! empty( $option_settings['css']['focus_hover'] ) ? $option_settings['css']['focus_hover'] : "{$element_selector}:focus:hover";
$element_sticky_selector = $sticky->add_sticky_to_order_class( $element_selector, $this->is_sticky_module );
$element_focus_sticky_selector = $sticky->add_sticky_to_order_class( $element_focus_selector, $this->is_sticky_module );
// 1.c. Build custom form field selector.
$bg_color_selector = ! empty( $option_settings['css']['background_color'] ) ? $option_settings['css']['background_color'] : $element_selector;
$bg_color_hover_selector = ! empty( $option_settings['css']['background_color_hover'] ) ? $option_settings['css']['background_color_hover'] : $element_hover_selector;
$bg_color_focus_selector = ! empty( $option_settings['css']['focus_background_color'] ) ? $option_settings['css']['focus_background_color'] : $element_focus_selector;
$bg_color_focus_hover_selector = ! empty( $option_settings['css']['focus_background_color_hover'] ) ? $option_settings['css']['focus_background_color_hover'] : $element_focus_hover_selector;
$text_color_selector = ! empty( $option_settings['css']['form_text_color'] ) ? $option_settings['css']['form_text_color'] : $element_selector;
$text_color_hover_selector = ! empty( $option_settings['css']['form_text_color_hover'] ) ? $option_settings['css']['form_text_color_hover'] : $element_hover_selector;
$text_color_focus_selector = ! empty( $option_settings['css']['focus_text_color'] ) ? $option_settings['css']['focus_text_color'] : $element_focus_selector;
$text_color_focus_hover_selector = ! empty( $option_settings['css']['focus_text_color_hover'] ) ? $option_settings['css']['focus_text_color_hover'] : $element_focus_hover_selector;
$placeholder_option = self::$_->array_get( $option_settings, 'placeholder', true );
$base_selector = false !== strpos( $element_selector, ',' ) ? "{$this->main_css_element} .input" : $element_selector;
$placeholder_selector = ! empty( $option_settings['css']['placeholder'] ) ? $option_settings['css']['placeholder'] : "{$base_selector}::placeholder, {$base_selector}::-webkit-input-placeholder, {$base_selector}::-moz-placeholder, {$base_selector}::-ms-input-placeholder";
$placeholder_hover_selector = ! empty( $option_settings['css']['placeholder_hover'] ) ? $option_settings['css']['placeholder_hover'] : "{$base_selector}:hover::placeholder, {$base_selector}:hover::-webkit-input-placeholder, {$base_selector}:hover::-moz-placeholder, {$base_selector}:hover::-ms-input-placeholder";
$placeholder_focus_selector = ! empty( $option_settings['css']['placeholder_focus'] ) ? $option_settings['css']['placeholder_focus'] : "{$base_selector}:focus::placeholder, {$base_selector}:focus::-webkit-input-placeholder, {$base_selector}:focus::-moz-placeholder, {$base_selector}:focus::-ms-input-placeholder";
$placeholder_focus_hover_selector = ! empty( $option_settings['css']['placeholder_focus_hover'] ) ? $option_settings['css']['placeholder_focus_hover'] : "{$base_selector}:focus:hover::placeholder, {$base_selector}:focus:hover::-webkit-input-placeholder, {$base_selector}:focus:hover::-moz-placeholder, {$base_selector}:focus:hover::-ms-input-placeholder";
$placeholder_sticky_selector = $sticky->add_sticky_to_order_class( $placeholder_selector, $this->is_sticky_module );
$placeholder_focus_sticky_selector = $sticky->add_sticky_to_order_class( $placeholder_focus_selector, $this->is_sticky_module );
// 2. Default important status.
$force_global_important = et_builder_has_limitation( 'force_use_global_important' );
$important_list = isset( $option_settings['css']['important'] ) ? $option_settings['css']['important'] : array();
// 3.a.1. Field Background Color.
$is_field_bg_color_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, "{$option_name}_background_color" );
$field_bg_color_values = array(
'desktop' => esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_background_color" ) ),
'tablet' => $is_field_bg_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_background_color_tablet" ) ) : '',
'phone' => $is_field_bg_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_background_color_phone" ) ) : '',
);
$field_bg_color_important = $force_global_important || in_array( 'background_color', $important_list, true ) ? ' !important;' : '';
et_pb_responsive_options()->generate_responsive_css( $field_bg_color_values, $bg_color_selector, 'background-color', $function_name, $field_bg_color_important, 'color' );
// 3.a.2. Field Background Hover Color.
$field_bg_color_hover = $this->get_hover_value( "{$option_name}_background_color" );
if ( ! empty( $field_bg_color_hover ) ) {
$el_style = array(
'selector' => $bg_color_hover_selector,
'declaration' => sprintf( 'background-color:%1$s%2$s;', $field_bg_color_hover, $field_bg_color_important ),
);
self::set_style( $function_name, $el_style );
}
// 3.a.3. Field Background Sticky Color
$field_bg_color_sticky = $sticky->get_value(
"{$option_name}_background_color",
$this->props
);
if ( ! empty( $field_bg_color_sticky ) ) {
$el_style = array(
'selector' => $element_sticky_selector,
'declaration' => sprintf(
'background-color:%1$s%2$s;',
$field_bg_color_sticky,
$field_bg_color_important
),
);
self::set_style( $function_name, $el_style );
}
// 3.b.1. Field Focus Background Color.
$is_field_focus_bg_color_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, "{$option_name}_focus_background_color" );
$field_focus_bg_color_values = array(
'desktop' => esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_focus_background_color" ) ),
'tablet' => $is_field_focus_bg_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_focus_background_color_tablet" ) ) : '',
'phone' => $is_field_focus_bg_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_focus_background_color_phone" ) ) : '',
);
$field_focus_bg_color_important = $force_global_important || in_array( 'focus_background_color', $important_list, true ) ? ' !important' : '';
et_pb_responsive_options()->generate_responsive_css( $field_focus_bg_color_values, $bg_color_focus_selector, 'background-color', $function_name, $field_focus_bg_color_important, 'color' );
// 3.b.2. Field Focus Background Hover Color.
$field_focus_bg_color_hover = $this->get_hover_value( "{$option_name}_focus_background_color" );
if ( ! empty( $field_focus_bg_color_hover ) ) {
$el_style = array(
'selector' => $bg_color_focus_hover_selector,
'declaration' => sprintf( 'background-color:%1$s%2$s;', $field_focus_bg_color_hover, $field_focus_bg_color_important ),
);
self::set_style( $function_name, $el_style );
}
// 3.b.3. Field Focus Background Sticky Color
$field_focus_bg_color_sticky = $sticky->get_value(
"{$option_name}_focus_background_color",
$this->props
);
if ( ! empty( $field_focus_bg_color_sticky ) ) {
$el_style = array(
'selector' => $element_focus_sticky_selector,
'declaration' => sprintf(
'background-color:%1$s%2$s;',
$field_focus_bg_color_sticky,
$field_focus_bg_color_important
),
);
self::set_style( $function_name, $el_style );
}
// 3.c.1. Field Text Color.
$is_field_text_color_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, "{$option_name}_text_color" );
$field_text_color_values = array(
'desktop' => esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_text_color" ) ),
'tablet' => $is_field_text_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_text_color_tablet" ) ) : '',
'phone' => $is_field_text_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_text_color_phone" ) ) : '',
);
$field_text_color_important = in_array( 'form_text_color', $important_list, true ) ? ' !important' : '';
$text_color_selector = $placeholder_option ? "{$text_color_selector}, {$placeholder_selector}" : $text_color_selector;
et_pb_responsive_options()->generate_responsive_css( $field_text_color_values, $text_color_selector, 'color', $function_name, $field_text_color_important, 'color' );
// 3.c.2. Field Text Hover Color.
$field_text_color_hover = $this->get_hover_value( "{$option_name}_text_color" );
if ( ! empty( $field_text_color_hover ) ) {
$text_color_hover_selector = $placeholder_option ? "{$text_color_hover_selector}, {$placeholder_hover_selector}" : $text_color_hover_selector;
$el_style = array(
'selector' => $text_color_hover_selector,
'declaration' => sprintf( 'color:%1$s%2$s;', $field_text_color_hover, $field_text_color_important ),
);
self::set_style( $function_name, $el_style );
}
// 3.c.3. Field Text Sticky Color
$field_text_color_sticky = $sticky->get_value( "{$option_name}_text_color", $this->props );
if ( ! empty( $field_text_color_sticky ) ) {
$text_color_sticky_selector = $placeholder_option ?
"{$element_sticky_selector}, {$placeholder_sticky_selector}" :
$element_sticky_selector;
$el_style = array(
'selector' => $text_color_sticky_selector,
'declaration' => sprintf(
'color:%1$s%2$s;',
$field_text_color_sticky,
$field_text_color_important
),
);
self::set_style( $function_name, $el_style );
}
// 3.d.1. Field Focus Text Color.
$is_field_focus_text_color_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, "{$option_name}_focus_text_color" );
$field_focus_text_color_values = array(
'desktop' => esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_focus_text_color" ) ),
'tablet' => $is_field_focus_text_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_focus_text_color_tablet" ) ) : '',
'phone' => $is_field_focus_text_color_responsive ? esc_attr( et_pb_responsive_options()->get_any_value( $this->props, "{$option_name}_focus_text_color_phone" ) ) : '',
);
$text_color_focus_selector = $placeholder_option ? "{$text_color_focus_selector}, {$placeholder_focus_selector}" : $text_color_focus_selector;
$field_focus_text_color_important = in_array( 'form_text_color', $important_list, true ) ? ' !important' : '';
et_pb_responsive_options()->generate_responsive_css( $field_focus_text_color_values, $text_color_focus_selector, 'color', $function_name, $field_focus_text_color_important, 'color' );
// 3.d.2. Field Focus Text Hover Color.
$field_focus_text_color_hover = $this->get_hover_value( "{$option_name}_focus_text_color" );
if ( ! empty( $field_focus_text_color_hover ) ) {
$text_color_focus_hover_selector = $placeholder_option ? "{$text_color_focus_hover_selector}, {$placeholder_focus_hover_selector}" : $text_color_focus_hover_selector;
$el_style = array(
'selector' => $text_color_focus_hover_selector,
'declaration' => sprintf( 'color:%1$s%2$s;', $field_focus_text_color_hover, $field_focus_text_color_important ),
);
self::set_style( $function_name, $el_style );
}
// 3.d.3. Field Focus Text Sticky Color
$field_focus_text_color_sticky = $sticky->get_value( "{$option_name}_focus_text_color", $this->props );
if ( ! empty( $field_focus_text_color_sticky ) ) {
$text_color_focus_sticky_selector = $placeholder_option ?
"{$element_focus_sticky_selector}, {$placeholder_focus_sticky_selector}" :
$element_focus_sticky_selector;
$el_style = array(
'selector' => $text_color_focus_sticky_selector,
'declaration' => sprintf(
'color:%1$s%2$s;',
$field_focus_text_color_sticky,
$field_focus_text_color_important
),
);
self::set_style( $function_name, $el_style );
}
}
}
/**
* Process custom css fields into CSS style.
*
* @param string $function_name Module slug.
*
* @return bool
*/
public function process_custom_css_fields( $function_name ) {
if ( empty( $this->custom_css_fields ) ) {
return false;
}
// Helpers.
$responsive = et_pb_responsive_options();
$hover = et_pb_hover_options();
$sticky = et_pb_sticky_options();
foreach ( $this->custom_css_fields as $slug => $option ) {
$css = $this->props[ "custom_css_{$slug}" ];
$order_class = isset( $this->main_css_element ) && count( explode( ' ', $this->main_css_element ) ) === 1 ? $selector = $this->main_css_element : '%%order_class%%';
$selector = ! empty( $option['selector'] ) ? $option['selector'] : '';
if ( false === strpos( $selector, '%%order_class%%' ) ) {
if ( ! ( isset( $option['no_space_before_selector'] ) && $option['no_space_before_selector'] ) && '' !== $selector ) {
$selector = " {$selector}";
}
$selector = "{$order_class}{$selector}";
}
if ( $responsive->is_responsive_enabled( $this->props, "custom_css_{$slug}" ) ) {
$responsive_values = $responsive->get_property_values( $this->props, "custom_css_{$slug}" );
// Desktop mode custom CSS.
if ( '' !== $css ) {
$el_style = array(
'selector' => $selector,
'declaration' => trim( $css ),
'media_query' => empty( $responsive_values['tablet'] ) ? null : self::get_media_query( 'min_width_981' ),
);
self::set_style( $function_name, $el_style );
}
// Tablet mode custom CSS.
$tablet_css = $responsive->get_tablet_value( "custom_css_{$slug}", $this->props );
if ( ! empty( $tablet_css ) ) {
$el_style = array(
'selector' => $selector,
'declaration' => trim( $tablet_css ),
'media_query' => empty( $responsive_values['phone'] ) ? self::get_media_query( 'max_width_980' ) : self::get_media_query( '768_980' ),
);
self::set_style( $function_name, $el_style );
}
// Phone mode custom CSS.
$phone_css = $responsive->get_phone_value( "custom_css_{$slug}", $this->props );
if ( ! empty( $phone_css ) ) {
$el_style = array(
'selector' => $selector,
'declaration' => trim( $phone_css ),
'media_query' => self::get_media_query( 'max_width_767' ),
);
self::set_style( $function_name, $el_style );
}
} else {
// Non responsive mode custom CSS.
if ( '' !== $css ) {
$el_style = array(
'selector' => $selector,
'declaration' => trim( $css ),
);
self::set_style( $function_name, $el_style );
}
}
// Hover mode custom CSS.
if ( $hover->is_enabled( "custom_css_{$slug}", $this->props ) ) {
$hover_css = $hover->get_value( "custom_css_{$slug}", $this->props );
if ( ! empty( $hover_css ) ) {
$el_style = array(
'selector' => $hover->add_hover_to_selectors( $selector ),
'declaration' => trim( $hover_css ),
);
self::set_style( $function_name, $el_style );
}
}
// Sticky mode custom CSS.
if ( $sticky->is_enabled( "custom_css_{$slug}", $this->props ) ) {
$sticky_css = $sticky->get_value( "custom_css_{$slug}", $this->props );
if ( ! empty( $sticky_css ) ) {
$el_style = array(
'selector' => $sticky->add_sticky_to_order_class( $selector, $this->is_sticky_module ),
'declaration' => trim( $sticky_css ),
);
self::set_style( $function_name, $el_style );
}
}
}
}
/**
* Process box shadow CSS styles.
*
* @since 3.23 Add responsive support. Pass device attributes and make sure no duplicate styles
* are rendered.
* @since 4.6.0 Add sticky style support.
*
* @param string $function_name Module slug.
*/
public function process_box_shadow( $function_name ) {
/**
* Get box shadow configuration.
*
* @var ET_Builder_Module_Field_BoxShadow $box_shadow
*/
$box_shadow = ET_Builder_Module_Fields_Factory::get( 'BoxShadow' );
$advanced_fields = self::$_->array_get( $this->advanced_fields, 'box_shadow', array( 'default' => array() ) );
$has_wrapper = et_()->array_get( $this->wrapper_settings, 'order_class_wrapper', false );
$is_sticky_module_without_wrapper = $has_wrapper ? false : $this->is_sticky_module;
if ( ! $advanced_fields ) {
return '';
}
// A module can have multiple advanced box shadow fields (i.e. default + button's box shadow) which are
// generated by advanced button fields.
foreach ( $advanced_fields as $option_name => $option_settings ) {
// Enable module to explicitly disable box shadow fields (box shadow is automatically)
// added to all module by default.
if ( false === $option_settings ) {
continue;
}
// Prepare attribute for getting box shadow's css declaration.
$declaration_args = array(
'suffix' => 'default' === $option_name ? '' : "_{$option_name}",
'important' => self::$_->array_get( $option_settings, 'css.important', false ),
);
// Enable module to conditionally print box shadow styling if particular attribute(s) have specific value.
// This works in 'OR' logic. Once an attribute doesn't match the value, this box shadow styling is skipped.
$show_if = self::$_->array_get( $option_settings, 'css.show_if', array() );
if ( ! empty( $show_if ) ) {
$show_if_skip = false;
foreach ( $show_if as $show_if_attr_name => $show_if_attr_value ) {
$attr_value = self::$_->array_get( $this->props, $show_if_attr_name, '' );
// Skip printing this box shadow value once one of the attribute value doesn't
// match with given value.
if ( $attr_value !== $show_if_attr_value ) {
$show_if_skip = true;
break;
}
}
if ( $show_if_skip ) {
continue;
}
}
// Enable module to conditionally print box shadow styling if particular attribute(s) doesn't have
// specific value. This works on 'OR' logic. Once an attribute matches the supplied value, this
// box shadow styling is skipped.
$show_if_not = self::$_->array_get( $option_settings, 'css.show_if_not', array() );
if ( ! empty( $show_if_not ) ) {
$show_if_not_skip = false;
foreach ( $show_if_not as $show_if_not_attr_name => $show_if_not_attr_value ) {
$attr_value = self::$_->array_get( $this->props, $show_if_not_attr_name, '' );
// Skip printing this box value once this attribute value matches the given value.
if ( $attr_value === $show_if_not_attr_value ) {
$show_if_not_skip = true;
break;
}
}
if ( $show_if_not_skip ) {
continue;
}
}
$overlay = self::$_->array_get( $option_settings, 'css.overlay', false );
$has_video_bg = ! empty( $atts['background_video_mp4'] ) || ! empty( $atts['background_video_webm'] );
$inset = $box_shadow->is_inset( $box_shadow->get_value( $this->props, $declaration_args ) );
$inset_hover = $box_shadow->is_inset(
$box_shadow->get_value(
$this->props,
array_merge( $declaration_args, array( 'hover' => true ) )
)
);
$selector = self::$_->array_get( $option_settings, 'css.main', '%%order_class%%' );
// Default box shadow affects module while other affects group element it belongs to (ie image, button, etc).
$hover_selector = 'default' === $option_name ? $this->add_hover_to_order_class( $selector ) : $this->add_hover_to_selectors( $selector );
// Custom box shadow hover selector.
$custom_hover = self::$_->array_get( $option_settings, 'css.hover', '' );
if ( '' !== $custom_hover ) {
$hover_selector = $custom_hover;
}
// Render box shadow styles for esponsive settings.
$prev_declaration = '';
foreach ( et_pb_responsive_options()->get_modes() as $device ) {
// Add device argument.
$device_declaration_args = array_merge( $declaration_args, array( 'device' => $device ) );
// Get box-shadow styles.
if ( ( $inset && 'inset' === $overlay ) || 'always' === $overlay || $has_video_bg ) {
$box_shadow_style = $box_shadow->get_overlay_style(
$function_name,
$selector,
$this->props,
$device_declaration_args
);
} else {
$box_shadow_style = $box_shadow->get_style(
$selector,
$this->props,
$device_declaration_args
);
}
// Compare current device declaration and previous declaration to avoid
// duplicate rendered styles. Or don't render if current declaration is
// empty string.
$declaration = isset( $box_shadow_style['declaration'] ) ? $box_shadow_style['declaration'] : '';
if ( $prev_declaration === $declaration || empty( $declaration ) ) {
continue;
}
$prev_declaration = $declaration;
// Set media query for tablet and phone.
if ( 'desktop' !== $device ) {
$breakpoint = 'tablet' === $device ? 'max_width_980' : 'max_width_767';
$media_query = self::get_media_query( $breakpoint );
$box_shadow_style['media_query'] = $media_query;
}
self::set_style(
$function_name,
$box_shadow_style
);
}
if ( ( $inset_hover && 'inset' === $overlay ) || 'always' === $overlay || $has_video_bg ) {
self::set_style(
$function_name,
$box_shadow->get_overlay_style(
$function_name,
$hover_selector,
$this->props,
array_merge( $declaration_args, array( 'hover' => true ) )
)
);
} else {
self::set_style(
$function_name,
$box_shadow->get_style(
$hover_selector,
$this->props,
array_merge( $declaration_args, array( 'hover' => true ) )
)
);
}
// Sticky style.
$sticky = et_pb_sticky_options();
if ( $this->is_sticky_module || $sticky->is_inside_sticky_module() ) {
$inset_sticky = $box_shadow->is_inset(
$box_shadow->get_value(
$this->props,
array_merge( $declaration_args, array( 'sticky' => true ) )
)
);
$sticky_selector = 'default' === $option_name ?
$sticky->add_sticky_to_order_class( $selector, $is_sticky_module_without_wrapper ) :
$sticky->add_sticky_to_selectors( $selector, $is_sticky_module_without_wrapper );
// Custom box shadow sticky selector.
$custom_sticky = self::$_->array_get( $option_settings, 'css.sticky', '' );
if ( '' !== $custom_sticky ) {
$sticky_selector = $custom_sticky;
}
if ( ( $inset_sticky && 'inset' === $overlay ) || 'always' === $overlay || $has_video_bg ) {
self::set_style(
$function_name,
$box_shadow->get_overlay_style(
$function_name,
$sticky_selector,
$this->props,
array_merge( $declaration_args, array( 'sticky' => true ) )
)
);
} else {
self::set_style(
$function_name,
$box_shadow->get_style(
$sticky_selector,
$this->props,
array_merge( $declaration_args, array( 'sticky' => true ) )
)
);
}
}
}
}
/**
* Make Advanced Fields and Custom CSS Fields filterable.
*/
public function make_options_filterable() {
if ( isset( $this->advanced_fields ) ) {
$this->advanced_fields = apply_filters(
"{$this->slug}_advanced_fields",
$this->advanced_fields,
$this->slug,
$this->main_css_element
);
}
if ( isset( $this->custom_css_fields ) ) {
$this->custom_css_fields = apply_filters(
"{$this->slug}_custom_css_fields",
$this->custom_css_fields,
$this->slug,
$this->main_css_element
);
}
}
/**
* Disables wptexturize on the passed shortcode..
*
* @param array $shortcodes An array of shortcode names.
*
* @return array
*/
public function disable_wptexturize( $shortcodes ) {
$shortcodes[] = $this->slug;
return $shortcodes;
}
/**
* Callback :: fix_wptexturized_scripts.
*
* @param array $matches Found matches.
*
* @return string|string[]
*/
public function fix_wptexturized_script( $matches ) {
return str_replace( '&', '&', $matches[0] );
}
/**
* Fix wptexturize ampersand bug.
*
* @param string $content Content.
*
* @return string|string[]|null
*/
public function fix_wptexturized_scripts( $content ) {
return preg_replace_callback(
'/<script.*?>(.*?)<\/script>/mis',
array( $this, 'fix_wptexturized_script' ),
$content
);
}
/**
* Callback :: Sort fields within tabs by priority.
*
* @param string $a Comparision field member.
* @param string $b Comparision field string.
*
* @return int|lt
*/
public static function compare_by_priority( $a, $b ) {
$a_priority = ! empty( $a['priority'] ) ? (int) $a['priority'] : self::DEFAULT_PRIORITY;
$b_priority = ! empty( $b['priority'] ) ? (int) $b['priority'] : self::DEFAULT_PRIORITY;
if ( isset( $a['_order_number'], $b['_order_number'] ) && ( $a_priority === $b_priority ) ) {
return $a['_order_number'] - $b['_order_number'];
}
return $a_priority - $b_priority;
}
/**
* Reorder toggles based on the priority with respect to manually ordered items with no priority
*
* @param array $toggles_array Toggles to reorder.
*
* @return array
*/
public static function et_pb_order_toggles_by_priority( $toggles_array ) {
if ( empty( $toggles_array ) ) {
return array();
}
$high_priority_toggles = array();
$low_priority_toggles = array();
$manually_ordered_toggles = array();
// fill 3 arrays based on priority.
foreach ( $toggles_array as $toggle_id => $toggle_data ) {
if ( isset( $toggle_data['priority'] ) ) {
if ( $toggle_data['priority'] < 10 ) {
$high_priority_toggles[ $toggle_id ] = $toggle_data;
} else {
$low_priority_toggles[ $toggle_id ] = $toggle_data;
}
} else {
// keep the original order of options without priority defined.
$manually_ordered_toggles[ $toggle_id ] = $toggle_data;
}
}
// order high and low priority toggles.
uasort( $high_priority_toggles, array( 'self', 'compare_by_priority' ) );
uasort( $low_priority_toggles, array( 'self', 'compare_by_priority' ) );
// merge 3 arrays to get the correct order of toggles.
return array_merge( $high_priority_toggles, $manually_ordered_toggles, $low_priority_toggles );
}
/**
* Callback :: Sort modules alphabetically by name.
*
* @param string $a Comparision member string.
* @param string $b Comparision member string.
*
* @return int|lt
*/
public static function compare_by_name( $a, $b ) {
return strcasecmp( $a->name, $b->name );
}
/**
* Get total modules count.
*
* @param string $post_type Post type.
*
* @return int
*/
public static function get_modules_count( $post_type ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
$overall_count = count( $parent_modules ) + count( $child_modules );
return $overall_count;
}
/**
* Get modules js array to use in backbone template.
*
* @param string $post_type Current post type.
*
* @return string
*/
public static function get_modules_js_array( $post_type ) {
$modules = array();
$parent_modules = self::get_parent_modules( $post_type );
if ( ! empty( $parent_modules ) ) {
/**
* Sort modules alphabetically by name.
*/
$sorted_modules = $parent_modules;
uasort( $sorted_modules, array( 'self', 'compare_by_name' ) );
foreach ( $sorted_modules as $module ) {
/**
* Replace single and double quotes with %% and || respectively
* to avoid js conflicts
*/
$module_name = str_replace( array( '"', '"', '"', '"' ), '%%', $module->name );
$module_name = str_replace( array( "'", ''', ''' ), '||', $module_name );
$modules[] = sprintf(
'{ "title" : "%1$s", "label" : "%2$s"%3$s}',
esc_js( $module_name ),
esc_js( $module->slug ),
( isset( $module->fullwidth ) && $module->fullwidth ? ', "fullwidth_only" : "on"' : '' )
);
}
}
return '[' . implode( ',', $modules ) . ']';
}
/**
* Get all modules array.
*
* @param string $post_type Post type.
* @param bool $include_child Whether to include childs.
*
* @return array
*/
public static function get_modules_array( $post_type = '', $include_child = false ) {
$modules = array();
$module_icons = self::get_module_icons();
if ( ! empty( $post_type ) ) {
$parent_modules = self::get_parent_modules( $post_type );
if ( $include_child ) {
$parent_modules = array_merge( $parent_modules, self::get_child_modules( $post_type ) );
}
if ( ! empty( $parent_modules ) ) {
$sorted_modules = $parent_modules;
}
} else {
$parent_modules = self::get_parent_modules();
if ( $include_child ) {
$parent_modules = array_merge( $parent_modules, self::get_child_modules() );
}
if ( ! empty( $parent_modules ) ) {
$all_modules = array();
foreach ( $parent_modules as $post_type => $post_type_modules ) {
foreach ( $post_type_modules as $module_slug => $module ) {
$all_modules[ $module_slug ] = $module;
}
}
$sorted_modules = $all_modules;
}
}
if ( ! empty( $sorted_modules ) ) {
/**
* Sort modules alphabetically by name.
*/
uasort( $sorted_modules, array( 'self', 'compare_by_name' ) );
foreach ( $sorted_modules as $module ) {
/**
* Replace single and double quotes with %% and || respectively
* to avoid js conflicts
*/
$module_name = str_replace( '"', '%%', $module->name );
$module_name = str_replace( "'", '||', $module_name );
$module_name_plural = str_replace( '"', '%%', empty( $module->plural ) ? $module->name : $module->plural );
$module_name_plural = str_replace( "'", '||', $module_name_plural );
$_module = array(
'title' => esc_attr( $module_name ),
'plural' => esc_attr( $module_name_plural ),
'label' => esc_attr( $module->slug ),
'is_parent' => 'child' === $module->type ? 'off' : 'on',
'is_official_module' => $module->_is_official_module,
'vb_support' => isset( $module->vb_support ) ? $module->vb_support : 'off',
);
if ( isset( $module->fullwidth ) && $module->fullwidth ) {
$_module['fullwidth_only'] = 'on';
}
// Get module icon character (font-icon).
$icon = self::$_->array_get( $module_icons, "{$module->slug}.icon" );
if ( $icon ) {
$_module['icon'] = $icon;
}
// Get module icon svg from fetched svg content.
$icon_svg = self::$_->array_get( $module_icons, "{$module->slug}.icon_svg" );
if ( $icon_svg ) {
$_module['icon_svg'] = $icon_svg;
}
$modules[] = $_module;
}
}
return $modules;
}
/**
* Get modules that does not support VB.
*
* @return array
*/
public static function get_fb_unsupported_modules() {
$parent_modules = self::get_parent_modules();
$unsupported_modules_array = array();
foreach ( $parent_modules as $post_type => $post_type_modules ) {
foreach ( $post_type_modules as $module_slug => $module ) {
if ( ! isset( $module->vb_support ) || 'off' === $module->vb_support ) {
$unsupported_modules_array[] = $module_slug;
}
}
}
return array_unique( $unsupported_modules_array );
}
/**
* Get list of modules that has rich content option
*
* @since 3.18
*
* @return array
*/
public static function get_has_content_modules() {
return self::$has_content_modules;
}
/**
* Returns a regex pattern that includes all parent module slugs.
*
* @since 3.1 Renamed from `get_parent_shortcodes()` to `get_parent_slugs_regex()`
* @since 1.0
*
* @param string $post_type Post type.
*
* @return string
*/
public static function get_parent_slugs_regex( $post_type = 'page' ) {
$slugs = array();
$parent_modules = self::get_parent_modules( $post_type );
if ( ! empty( $parent_modules ) ) {
foreach ( $parent_modules as $module ) {
$slugs[] = $module->slug;
}
}
return implode( '|', $slugs );
}
/**
* Returns a regex pattern that includes all child module slugs.
*
* @since 3.1 Renamed from `get_child_shortcodes()` to `get_child_slugs_regex()`
* @since 1.0
*
* @param string $post_type Post type.
*
* @return string
*/
public static function get_child_slugs_regex( $post_type = 'page' ) {
$slugs = array();
$child_modules = self::get_child_modules( $post_type );
if ( ! empty( $child_modules ) ) {
foreach ( $child_modules as $slug => $module ) {
if ( ! empty( $slug ) ) {
$slugs[] = $slug;
}
}
}
return implode( '|', $slugs );
}
/**
* Get child module slugs.
*
* @param string $post_type Post type.
*
* @return array
*/
public static function get_child_slugs( $post_type ) {
$child_slugs = array();
$child_modules = self::get_parent_modules( $post_type );
if ( ! empty( $child_modules ) ) {
foreach ( $child_modules as $module ) {
if ( ! empty( $module->child_slug ) ) {
$child_slugs[ $module->slug ] = $module->child_slug;
}
}
}
return $child_slugs;
}
/**
* Get row content module slugs. e.x et_pb_code
*
* @param string $post_type Post type.
*
* @return string
*/
public static function get_raw_content_slugs( $post_type ) {
$shortcodes = array();
$parent_modules = self::get_parent_modules( $post_type );
if ( ! empty( $parent_modules ) ) {
foreach ( $parent_modules as $module ) {
if ( isset( $module->use_raw_content ) && $module->use_raw_content ) {
$shortcodes[] = $module->slug;
}
}
}
$child_modules = self::get_child_modules( $post_type );
if ( ! empty( $child_modules ) ) {
foreach ( $child_modules as $module ) {
if ( isset( $module->use_raw_content ) && $module->use_raw_content ) {
$shortcodes[] = $module->slug;
}
}
}
return implode( '|', $shortcodes );
}
/**
* Get the portion of templates for specified slugs.
*
* @param string $post_type Post type.
* @param array $slugs_array Module slugs.
*
* @return array|string|void
*/
public static function get_modules_templates( $post_type, $slugs_array ) {
$all_modules = self::get_parent_and_child_modules( $post_type );
$templates_array = array();
if ( empty( $slugs_array ) ) {
return;
}
foreach ( $slugs_array as $slug ) {
if ( ! isset( $all_modules[ $slug ] ) ) {
return '';
}
$module = $all_modules[ $slug ];
$templates_array[] = array(
'slug' => $slug,
'template' => $module->build_microtemplate(),
);
}
if ( ET_BUILDER_OPTIMIZE_TEMPLATES ) {
$templates_array = array(
'templates' => $templates_array,
'unique' => self::$_unique_bb_keys_values,
);
}
return $templates_array;
}
/**
* Output modules backbone templates.
*
* @param string $post_type Post type.
* @param int $start_from Unused arg.
* @param int $amount Unused arg.
*
* @return array
*/
public static function output_templates( $post_type = '', $start_from = 0, $amount = 999 ) {
$all_modules = self::get_parent_and_child_modules( $post_type );
$modules_names = array_keys( $all_modules );
$output = array();
$output['templates'] = array();
if ( ! empty( $all_modules ) ) {
for ( $i = 0; $i < ET_BUILDER_AJAX_TEMPLATES_AMOUNT; $i++ ) {
if ( isset( $modules_names[ $i ] ) ) {
$module = $all_modules[ $modules_names[ $i ] ];
$output['templates'][ $module->slug ] = self::optimize_bb_chunk( $module->build_microtemplate() );
} else {
break;
}
}
}
if ( ET_BUILDER_OPTIMIZE_TEMPLATES ) {
$output['unique'] = self::$_unique_bb_keys_values;
}
return $output;
}
/**
* Get structure module slugs.
*
* @return array
*/
public static function get_structure_module_slugs() {
if ( ! empty( self::$structure_module_slugs ) ) {
return self::$structure_module_slugs;
}
$structure_modules = self::get_structure_modules();
self::$structure_module_slugs = array();
foreach ( $structure_modules as $structural_module ) {
self::$structure_module_slugs[] = $structural_module->slug;
}
return self::$structure_module_slugs;
}
/**
* Get structure modules.
*
* @return array
*/
public static function get_structure_modules() {
if ( ! empty( self::$structure_modules ) ) {
return self::$structure_modules;
}
$parent_modules = self::get_parent_modules( 'et_pb_layout' );
self::$structure_modules = array();
foreach ( $parent_modules as $parent_module ) {
if ( isset( $parent_module->is_structure_element ) && $parent_module->is_structure_element ) {
$parent_module->plural = empty( $parent_module->plural ) ? $parent_module->name : $parent_module->plural;
self::$structure_modules[] = $parent_module;
}
}
return self::$structure_modules;
}
/**
* Get a filtered list of modules.
*
* @since 3.10
*
* @param string $post_type Leave empty for any.
* @param string $type 'parent' or 'child'. Leave empty for any.
*
* @return ET_Builder_Element[]
*/
public static function get_modules( $post_type = '', $type = '' ) {
$modules = array();
foreach ( self::$modules as $slug => $module ) {
if ( '' !== $post_type && ! in_array( $post_type, $module->post_types, true ) ) {
continue;
}
if ( '' !== $type && ! $module->type !== $type ) {
continue;
}
$modules[ $slug ] = $module;
}
return $modules;
}
/**
* Get modules by fallback post type for disabled post type.
*
* @param string $type Module type.
*
* @return ET_Builder_Element[]|mixed
*/
public static function get_custom_post_type_fallback_modules( $type = 'parent' ) {
$modules = 'child' === $type ? self::$child_modules : self::$parent_modules;
// Most of the time, page module is expected to be used as disabled post type fallback.
if ( isset( $modules['page'] ) ) {
return $modules['page'];
}
// Post module is also expected to be used.
if ( isset( $modules['post'] ) ) {
return $modules['post'];
}
// If Divi Builder is disabled for all post types use layout modules as fallback.
if ( isset( $modules['et_pb_layout'] ) ) {
return $modules['et_pb_layout'];
}
// If all else fail, use all modules.
return self::get_modules();
}
/**
* Get all parent modules.
*
* @param string $post_type Current post type.
*
* @return mixed|void
*/
public static function get_parent_modules( $post_type = '' ) {
if ( ! empty( $post_type ) ) {
// We get all modules when post type is not enabled so that posts that have
// had their post type support disabled still load all necessary modules.
$parent_modules = ! empty( self::$parent_modules[ $post_type ] )
? self::$parent_modules[ $post_type ]
: self::get_custom_post_type_fallback_modules( 'parent' );
} else {
$parent_modules = self::$parent_modules;
}
return apply_filters( 'et_builder_get_parent_modules', $parent_modules, $post_type );
}
/**
* Get all child modules.
*
* @param string $post_type Current post type.
*
* @return mixed|void
*/
public static function get_child_modules( $post_type = '' ) {
if ( ! empty( $post_type ) ) {
// We get all modules when post type is not enabled so that posts that have
// had their post type support disabled still load all necessary modules.
$child_modules = ! empty( self::$child_modules[ $post_type ] )
? self::$child_modules[ $post_type ]
: self::get_custom_post_type_fallback_modules( 'child' );
} else {
$child_modules = self::$child_modules;
}
return apply_filters( 'et_builder_get_child_modules', $child_modules, $post_type );
}
/**
* Get woocommerce modules.
*
* @return mixed|void
*/
public static function get_woocommerce_modules() {
return apply_filters( 'et_builder_get_woocommerce_modules', self::$woocommerce_modules );
}
/**
* Get registered module icons
*
* @since 3.1
*
* @return array
*/
public static function get_module_icons() {
/**
* Filters Module Icons displayed in Add Module modals.
*
* @param array $module_icons Array of all registered module icons.
*/
$module_icons = apply_filters( 'et_builder_module_icons', self::$module_icons );
// Loop module icons.
foreach ( $module_icons as $key => $icons ) {
if ( isset( $icons['icon_path'] ) ) {
// Get svg content based on given svg's path.
$icon_svg = et_()->WPFS()->exists( $icons['icon_path'] ) ? et_()->WPFS()->get_contents( $icons['icon_path'] ) : false;
if ( $icon_svg ) {
$module_icons[ $key ]['icon_svg'] = $icon_svg;
// Remove icon path attribute since it's no longer used.
unset( $module_icons[ $key ]['icon_path'] );
}
}
}
return $module_icons;
}
/**
* Get combined array of child and parent modules for provided post_type
*
* @param string $post_type Post type.
*
* @since 3.1
*
* @return array
*/
public static function get_parent_and_child_modules( $post_type = '' ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
return array_merge( $parent_modules, $child_modules );
}
/**
* Get a module instance for provided post type by its slug.
*
* @since 3.10
*
* @param string $slug Module slug.
* @param string $post_type Current post type.
*
* @return ET_Builder_Element|null
*/
public static function get_module( $slug, $post_type = 'post' ) {
$modules = self::get_parent_and_child_modules( $post_type );
return self::$_->array_get( $modules, $slug );
}
/**
* Outputs list of all module help videos array
*
* @since 3.1
*
* @return array
*/
public static function get_help_videos() {
return self::$module_help_videos;
}
/**
* Get list of modules with support of featured image as background.
*
* @param string $post_type Current post type.
*
* @return mixed|void
*/
public static function get_featured_image_background_modules( $post_type = '' ) {
$parent_modules = self::get_parent_modules( $post_type );
$featured_image_background_modules = array();
foreach ( $parent_modules as $slug => $parent_module ) {
if ( ! empty( $parent_module->featured_image_background ) ) {
$featured_image_background_modules[] = $slug;
}
}
/**
* Filters list of modules with support of featured image as background.
*
* @since 3.1
*
* @param array[] $featured_image_background_modules List of modules with support of featured image as background.
*/
return apply_filters( 'et_pb_featured_image_background_modules', $featured_image_background_modules );
}
/**
* Get field group toggles.
*
* @param string $post_type Post type.
*
* @return array
*/
public static function get_toggles( $post_type ) {
static $toggles_array = array();
if ( $toggles_array ) {
return $toggles_array;
}
$modules = self::get_parent_and_child_modules( $post_type );
$custom_modules = array();
foreach ( $modules as $module_slug => $module ) {
if ( ! $module->_is_official_module ) {
$custom_modules[ $module_slug ] = $module;
}
foreach ( $module->settings_modal_toggles as $tab_slug => &$tab_data ) {
if ( ! isset( $tab_data['toggles'] ) ) {
continue;
}
$tab_data['toggles'] = self::et_pb_order_toggles_by_priority( $tab_data['toggles'] );
}
$toggles_array[ $module_slug ] = $module->settings_modal_toggles;
}
if ( $custom_modules ) {
// Add missing toggle definitions for any existing toggles used in custom modules.
foreach ( $custom_modules as $module_slug => $module ) {
foreach ( $module->get_complete_fields() as $field_name => $field_info ) {
$tab_slug = self::$_->array_get( $field_info, 'tab_slug' );
$tab_slug = empty( $tab_slug ) ? 'general' : $tab_slug;
$toggle_slug = self::$_->array_get( $field_info, 'toggle_slug' );
if ( ! $toggle_slug || isset( $toggles_array[ $module_slug ][ $tab_slug ]['toggles'][ $toggle_slug ] ) ) {
continue;
}
// Find existing definition.
foreach ( $toggles_array as $_module_slug => $tabs ) {
foreach ( $tabs as $tab => $toggles ) {
if ( isset( $toggles['toggles'][ $toggle_slug ] ) ) {
self::$_->array_set(
$toggles_array,
"{$module_slug}.{$tab_slug}.toggles.{$toggle_slug}",
$toggles['toggles'][ $toggle_slug ]
);
$toggles_array[ $module_slug ][ $tab_slug ]['toggles'] = self::et_pb_order_toggles_by_priority( $toggles_array[ $module_slug ][ $tab_slug ]['toggles'] );
break 2;
}
}
}
// Add missing unregistered toggles to the list.
if ( ! isset( $toggles_array[ $module_slug ][ $tab_slug ]['toggles'][ $toggle_slug ] ) ) {
if ( ! isset( $toggles_array[ $module_slug ][ $tab_slug ] ) ) {
$toggles_array[ $module_slug ][ $tab_slug ] = array( 'toggles' => array( $toggle_slug ) );
} else {
$toggles_array[ $module_slug ][ $tab_slug ]['toggles'][] = $toggle_slug;
}
}
}
}
}
return $toggles_array;
}
/**
* Get setting modal tabs.
*
* @param string $post_type Current post type.
*
* @return array
*/
public static function get_tabs( $post_type = '' ) {
$official_tabs = array(
'general' => '',
'advanced' => '',
'custom_css' => '',
);
$tabs_array = array();
$modules = self::get_parent_and_child_modules( $post_type );
foreach ( $modules as $module_slug => $module ) {
if ( '' === $post_type ) {
foreach ( $module as $_module_slug => $_module ) {
// Backward compatibility with custom tabs registered via `et_builder_main_tabs` filter.
$bb_custom_tabs = array_diff_key( $_module->get_main_tabs(), $official_tabs );
$bb_custom_tabs_formatted = array();
// Prepare properly formatted array of tabs data.
foreach ( $bb_custom_tabs as $tab_id => $tab_name ) {
$bb_custom_tabs_formatted[ $tab_id ] = array( 'name' => $tab_name );
}
// Add BB custom tabs to all modules.
$tabs_array[ $_module_slug ] = $bb_custom_tabs_formatted;
if ( ! isset( $_module->settings_modal_tabs ) ) {
continue;
}
$tabs_array[ $_module_slug ] = array_merge( $tabs_array[ $_module_slug ], $_module->settings_modal_tabs );
}
} else {
// Backward compatibility with custom tabs registered via `et_builder_main_tabs` filter.
$bb_custom_tabs = array_diff_key( $module->get_main_tabs(), $official_tabs );
$bb_custom_tabs_formatted = array();
// Prepare properly formatted array of tabs data.
foreach ( $bb_custom_tabs as $tab_id => $tab_name ) {
$bb_custom_tabs_formatted[ $tab_id ] = array( 'name' => $tab_name );
}
// Add BB custom tabs to all modules.
$tabs_array[ $module_slug ] = $bb_custom_tabs_formatted;
if ( ! isset( $module->settings_modal_tabs ) ) {
continue;
}
$tabs_array[ $module_slug ] = array_merge( $tabs_array[ $module_slug ], $module->settings_modal_tabs );
}
}
return $tabs_array;
}
/**
* Get permission options categories.
*
* @return array
*/
public static function get_options_categories() {
$options_categories = array(
'edit_colors' => array(
'name' => esc_html__( 'Edit Colors', 'et_builder' ),
),
'edit_content' => array(
'name' => esc_html__( 'Edit Content', 'et_builder' ),
),
'edit_fonts' => array(
'name' => esc_html__( 'Edit Fonts', 'et_builder' ),
),
'edit_buttons' => array(
'name' => esc_html__( 'Edit Buttons', 'et_builder' ),
),
'edit_layout' => array(
'name' => esc_html__( 'Edit Layout', 'et_builder' ),
),
'edit_borders' => array(
'name' => esc_html__( 'Edit Borders', 'et_builder' ),
),
'edit_configuration' => array(
'name' => esc_html__( 'Edit Configuration', 'et_builder' ),
),
);
$options_categories = array_merge( $options_categories, self::get_custom_options_categories() );
return $options_categories;
}
/**
* Get custom permission option categories.
*
* @param string $post_type Post type.
*
* @return array
*/
public static function get_custom_options_categories( $post_type = '' ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
$custom_options_categories = array();
$_modules = array_merge_recursive( $parent_modules, $child_modules );
foreach ( $_modules as $_module_slug => $_module ) {
if ( '' === $post_type ) {
foreach ( $_module as $__module_slug => $__module ) {
if ( ! isset( $__module->options_categories ) ) {
continue;
}
$custom_options_categories = array_merge( $custom_options_categories, $__module->options_categories );
}
} else {
if ( ! isset( $_module->options_categories ) ) {
continue;
}
$custom_options_categories = array_merge( $custom_options_categories, $_module->options_categories );
}
}
return $custom_options_categories;
}
/**
* Get all fields.
*
* @param string $post_type Post type.
*
* @return array
*/
public static function get_all_fields( $post_type = '' ) {
$_modules = self::get_parent_and_child_modules( $post_type );
$module_fields = array();
foreach ( $_modules as $_module_slug => $_module ) {
// skip modules without fb support.
if ( ! isset( $_module->vb_support ) || 'off' === $_module->vb_support ) {
continue;
}
$_module->set_fields();
$_module->_add_additional_fields();
$_module->_add_custom_css_fields();
$_module->_maybe_add_defaults();
$_module->_finalize_all_fields();
foreach ( $_module->fields_unprocessed as $field_key => $field ) {
// do not add the fields with 'skip' type. These fields used for rendering shortcode on Front End only.
if ( isset( $field['type'] ) && 'skip' === $field['type'] ) {
continue;
}
$field['name'] = $field_key;
$module_fields[ $_module_slug ][ $field_key ] = $field;
}
}
return $module_fields;
}
/**
* Get general fields of modules.
*
* @param string $post_type Post type.
* @param string $mode Modules Mode - Parent, Child and All.
* @param string $module_type Module Slug.
*
* @return array|mixed
*/
public static function get_general_fields( $post_type = '', $mode = 'all', $module_type = 'all' ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
switch ( $mode ) {
case 'parent':
$_modules = $parent_modules;
break;
case 'child':
$_modules = $child_modules;
break;
default:
$_modules = array_merge( $parent_modules, $child_modules );
break;
}
$module_fields = array();
foreach ( $_modules as $_module_slug => $_module ) {
// filter modules by slug if needed.
if ( 'all' !== $module_type && $module_type !== $_module_slug ) {
continue;
}
foreach ( $_module->fields_unprocessed as $field_key => $field ) {
$is_option_template = self::$option_template->is_option_template_field( $field_key );
// Do not process field template.
if ( ! $is_option_template && ( isset( $field['tab_slug'] ) && 'general' !== $field['tab_slug'] ) ) {
continue;
}
// Skip if current option template isn't eligible for `advanced` tab.
if ( $is_option_template && ! self::$option_template->is_template_inside_tab( 'general', $field ) ) {
continue;
}
$module_fields[ $_module_slug ][ $field_key ] = $field;
}
// Some module types must be separated for the Global Presets.
// For example we keep all section types as `et_pb_section` however they need different Global Presets.
$additional_slugs = self::$global_presets_manager->get_module_additional_slugs( $_module_slug );
foreach ( $additional_slugs as $alias ) {
$module_fields[ $alias ] = $module_fields[ $_module_slug ];
}
}
if ( 'all' !== $module_type ) {
return $module_fields[ $module_type ];
}
return $module_fields;
}
/**
* Get setting fields from custom tabs.
*
* @param string $post_type Post type.
* @param string $mode Modules Mode - Parent, Child and All.
* @param string $module_type Module Slug.
*
* @return array|mixed
*/
public static function get_settings_modal_tabs_fields( $post_type = '', $mode = 'all', $module_type = 'all' ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
switch ( $mode ) {
case 'parent':
$_modules = $parent_modules;
break;
case 'child':
$_modules = $child_modules;
break;
default:
$_modules = array_merge( $parent_modules, $child_modules );
break;
}
$module_fields = array();
foreach ( $_modules as $_module_slug => $_module ) {
// filter modules by slug if needed.
if ( 'all' !== $module_type && $module_type !== $_module_slug ) {
continue;
}
foreach ( $_module->fields_unprocessed as $field_key => $field ) {
$this_tab_slug = isset( $field['tab_slug'] ) ? $field['tab_slug'] : false;
if ( ! $this_tab_slug || in_array( $this_tab_slug, array( 'general', 'advanced', 'custom_css' ), true ) ) {
continue;
}
$field['name'] = $field_key;
$module_fields[ $_module_slug ][ $this_tab_slug ][ $field_key ] = $field;
}
}
if ( 'all' !== $module_type ) {
return $module_fields[ $module_type ];
}
return $module_fields;
}
/**
* Get child module titles.
*
* @param string $post_type Post type.
*
* @return array
*/
public static function get_child_module_titles( $post_type ) {
$child_modules = self::get_child_modules( $post_type );
$child_modules_titles = array();
$child_modules_titles_fields = array( 'advanced_setting_title_text', 'child_title_fallback_var', 'child_title_var' );
foreach ( $child_modules as $_module_slug => $_module ) {
foreach ( $child_modules_titles_fields as $single_field ) {
if ( isset( $_module->$single_field ) ) {
$child_modules_titles[ $_module_slug ][ $single_field ] = $_module->$single_field;
}
}
}
return $child_modules_titles;
}
/**
* Get advanced fields.
*
* @param string $post_type Post type.
* @param string $mode Whether modules are parent, child or all.
* @param string $module_type Module slug.
*
* @return array|mixed
*/
public static function get_advanced_fields( $post_type = '', $mode = 'all', $module_type = 'all' ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
switch ( $mode ) {
case 'parent':
$_modules = $parent_modules;
break;
case 'child':
$_modules = $child_modules;
break;
default:
$_modules = array_merge( $parent_modules, $child_modules );
break;
}
$module_fields = array();
foreach ( $_modules as $_module_slug => $_module ) {
// filter modules by slug if needed.
if ( 'all' !== $module_type && $module_type !== $_module_slug ) {
continue;
}
foreach ( $_module->fields_unprocessed as $field_key => $field ) {
$is_option_template = self::$option_template->is_option_template_field( $field_key );
// Do not process field template.
if ( ! $is_option_template && ( ! isset( $field['tab_slug'] ) || 'advanced' !== $field['tab_slug'] ) ) {
continue;
}
// Skip if current option template isn't eligible for `advanced` tab.
if ( $is_option_template && ! self::$option_template->is_template_inside_tab( 'advanced', $field ) ) {
continue;
}
if ( isset( $field['default'] ) ) {
$module_fields[ $_module_slug ]['advanced_defaults'][ $field_key ] = $field['default'];
}
$module_fields[ $_module_slug ][ $field_key ] = $field;
}
if ( ! empty( $_module->advanced_fields ) ) {
$module_fields[ $_module_slug ]['advanced_common'] = $_module->advanced_fields;
if ( isset( $_module->advanced_fields['border']['border_styles'] ) ) {
$module_fields[ $_module_slug ]['border_styles'] = array_merge( $module_fields[ $_module_slug ]['border_styles'], $_module->advanced_fields['border']['border_styles'] );
}
if ( isset( $_module->advanced_fields['border']['border_radii'] ) ) {
$module_fileds[ $_module_slug ]['border_radii'] = array_merge( $module_fields[ $_module_slug ]['border_radii'], $_module->advanced_fields['border']['border_radii'] );
}
}
// Some module types must be separated for the Global Presets.
// For example we keep all section types as `et_pb_section` however they need different Global Presets.
$additional_slugs = self::$global_presets_manager->get_module_additional_slugs( $_module_slug );
foreach ( $additional_slugs as $alias ) {
$module_fields[ $alias ] = $module_fields[ $_module_slug ];
}
}
if ( 'all' !== $module_type ) {
return $module_fields[ $module_type ];
}
return $module_fields;
}
/**
* Get custom css fields.
*
* @param string $post_type Post type.
* @param string $mode Whether modules are parent, child or all.
* @param string $module_type Module slug.
*
* @return array|mixed
*/
public static function get_custom_css_fields( $post_type = '', $mode = 'all', $module_type = 'all' ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
switch ( $mode ) {
case 'parent':
$_modules = $parent_modules;
break;
case 'child':
$_modules = $child_modules;
break;
default:
$_modules = array_merge( $parent_modules, $child_modules );
break;
}
$module_fields = array();
$custom_css_unwanted_types = array( 'custom_css', 'column_settings_css', 'column_settings_css_fields', 'column_settings_custom_css' );
foreach ( $_modules as $_module_slug => $_module ) {
// filter modules by slug if needed.
if ( 'all' !== $module_type && $module_type !== $_module_slug ) {
continue;
}
$module_fields[ $_module_slug ] = $_module->custom_css_fields;
foreach ( $module_fields[ $_module_slug ] as &$item ) {
$item['hover'] = self::$_->array_get( $item, 'hover', 'tabs' );
$item['mobile_options'] = self::$_->array_get( $item, 'mobile_options', true );
$item['sticky'] = self::$_->array_get( $item, 'sticky', true );
}
// Automatically added module ID and module class fields to setting modal's CSS tab.
if ( ! empty( $_module->fields_unprocessed ) ) {
foreach ( $_module->fields_unprocessed as $field_unprocessed_key => $field_unprocessed ) {
$has_tab_slug = isset( $field_unprocessed['tab_slug'] );
$is_css_field = $has_tab_slug && 'custom_css' === $field_unprocessed['tab_slug'];
$has_type = isset( $field_unprocessed['type'] );
$is_unwanted_css_field = $has_type && in_array( $field_unprocessed['type'], $custom_css_unwanted_types, true );
$is_template_inside_css_tab = is_string( $field_unprocessed ) && self::$option_template->is_template_inside_tab( 'custom_css', $field_unprocessed );
// Option template's template that might be rendered in custom_css tab.
if ( ( $is_css_field && ! $is_unwanted_css_field ) || $is_template_inside_css_tab ) {
$module_fields[ $_module_slug ][ $field_unprocessed_key ] = $field_unprocessed;
}
}
}
// Some module types must be separated for the Global Presets.
// For example we keep all section types as `et_pb_section` however they need different Global Presets.
$additional_slugs = self::$global_presets_manager->get_module_additional_slugs( $_module_slug );
foreach ( $additional_slugs as $alias ) {
$module_fields[ $alias ] = $module_fields[ $_module_slug ];
}
}
if ( 'all' !== $module_type ) {
return $module_fields[ $module_type ];
}
return $module_fields;
}
/**
* Get modules i10n.
*
* @param string $post_type Post type.
* @param string $mode Whether it is parent, child or all module.
* @param string $module_type Module slug.
*
* @return array|mixed
*/
public static function get_modules_i10n( $post_type = '', $mode = 'all', $module_type = 'all' ) {
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
switch ( $mode ) {
case 'parent':
$_modules = $parent_modules;
break;
case 'child':
$_modules = $child_modules;
break;
default:
$_modules = array_merge( $parent_modules, $child_modules );
break;
}
$fields = array();
foreach ( $_modules as $_module_slug => $_module ) {
// filter modules by slug if needed.
if ( 'all' !== $module_type && $module_type !== $_module_slug ) {
continue;
}
$fields[ $_module_slug ] = array(
'addNew' => $_module->add_new_child_text(),
);
}
if ( 'all' !== $module_type ) {
return $fields[ $module_type ];
}
return $fields;
}
/**
* Get CSS fields transition for module.
*
* @param string $post_type Post type.
* @param string $mode Whether it is parent, child or all module.
* @param string $module_type Module slug.
*
* @return array
*/
public static function get_modules_transitions( $post_type = '', $mode = 'all', $module_type = 'all' ) {
/**
* List of `ET_Builder_Element` instances.
*
* @var ET_Builder_Element[] $_modules
*/
$parent_modules = self::get_parent_modules( $post_type );
$child_modules = self::get_child_modules( $post_type );
$fields = array();
switch ( $mode ) {
case 'parent':
$_modules = $parent_modules;
break;
case 'child':
$_modules = $child_modules;
break;
default:
$_modules = array_merge( $parent_modules, $child_modules );
break;
}
foreach ( $_modules as $_module_slug => $_module ) {
// filter modules by slug if needed.
if ( 'all' !== $module_type && $module_type !== $_module_slug ) {
continue;
}
$fields[ $_module_slug ] = $_module->get_transition_fields_css_props();
}
return $fields;
}
/**
* Get module items configs.
*
* @param string $post_type Current post type.
*
* @return array
*/
public static function get_module_items_configs( $post_type ) {
$modules = self::get_parent_and_child_modules( $post_type );
$configs = array();
foreach ( $modules as $slug => $module ) {
if ( isset( $module->module_items_config ) ) {
$configs[ $slug ] = $module->module_items_config;
}
}
return $configs;
}
/**
* Get combined array of parent and child modules fields.
*
* @param string $post_type Post type.
* @param string $module Parent module slug.
*
* @return bool
*/
public static function get_module_fields( $post_type, $module ) {
$_modules = self::get_parent_and_child_modules( $post_type );
if ( ! empty( $_modules[ $module ] ) ) {
return $_modules[ $module ]->fields_unprocessed;
}
return false;
}
/**
* Get all fields of parent module.
*
* @param string $post_type Post type.
* @param string $module Module slug.
*
* @return bool
*/
public static function get_parent_module_fields( $post_type, $module ) {
if ( ! empty( self::$parent_modules[ $post_type ][ $module ] ) ) {
return self::$parent_modules[ $post_type ][ $module ]->get_complete_fields();
}
return false;
}
/**
* Get all child module fields.
*
* @param string $post_type Post type.
* @param string $module Module slug.
*
* @return bool
*/
public static function get_child_module_fields( $post_type, $module ) {
if ( ! empty( self::$child_modules[ $post_type ][ $module ] ) ) {
return self::$child_modules[ $post_type ][ $module ]->get_complete_fields();
}
return false;
}
/**
* Get parent module field.
*
* @param string $post_type Post type.
* @param string $module Module slug.
* @param string $field Field slug.
*
* @return bool|mixed
*/
public static function get_parent_module_field( $post_type, $module, $field ) {
$fields = self::get_parent_module_fields( $post_type, $module );
if ( ! empty( $fields[ $field ] ) ) {
return $fields[ $field ];
}
return false;
}
/**
* Return font icon fields of all modules.
*
* @param string $post_type Current post type.
*
* @return array
*/
public static function get_font_icon_fields( $post_type = '' ) {
$_modules = self::get_parent_and_child_modules( $post_type );
$module_fields = array();
foreach ( $_modules as $module_name => $module ) {
foreach ( $module->fields_unprocessed as $module_field_name => $module_field ) {
if ( isset( $module_field['type'] ) && 'select_icon' === $module_field['type'] ) {
$module_fields[ $module_name ][ $module_field_name ] = true;
}
}
}
return $module_fields;
}
/**
* Retrieves credits of custom modules for VB
*
* @param string $post_type Current post type.
*
* @return array of credits info by module slug
*/
public static function get_custom_modules_credits( $post_type = '' ) {
$result = array();
$modules = self::get_parent_and_child_modules( $post_type );
/**
* Loop over the all modules to gather module credits.
*
* @var $module_slug string
* @var $module ET_Builder_Module
*/
foreach ( $modules as $module_slug => $module ) {
// Include custom module credits for displaying them within VB.
if ( $module->_is_official_module ) {
continue;
} else {
if ( isset( $module->module_credits ) && is_array( $module->module_credits ) ) {
$result[ $module_slug ] = $module->module_credits;
}
}
}
return $result;
}
/**
* Return media query key value pairs.
*
* @param bool $for_js Whether media queries is for js ETBuilderBackend.et_builder_css_media_queries variable.
*
* @return array|mixed|void
*/
public static function get_media_quries( $for_js = false ) {
$media_queries = array(
'min_width_1405' => '@media only screen and ( min-width: 1405px )',
'1100_1405' => '@media only screen and ( min-width: 1100px ) and ( max-width: 1405px)',
'981_1405' => '@media only screen and ( min-width: 981px ) and ( max-width: 1405px)',
'981_1100' => '@media only screen and ( min-width: 981px ) and ( max-width: 1100px )',
'min_width_981' => '@media only screen and ( min-width: 981px )',
'max_width_980' => '@media only screen and ( max-width: 980px )',
'768_980' => '@media only screen and ( min-width: 768px ) and ( max-width: 980px )',
'min_width_768' => '@media only screen and ( min-width: 768px )',
'max_width_767' => '@media only screen and ( max-width: 767px )',
'max_width_479' => '@media only screen and ( max-width: 479px )',
);
$media_queries['mobile'] = $media_queries['max_width_767'];
$media_queries = apply_filters( 'et_builder_media_queries', $media_queries );
if ( 'for_js' === $for_js ) {
$processed_queries = array();
foreach ( $media_queries as $key => $value ) {
$processed_queries[] = array( $key, $value );
}
} else {
$processed_queries = $media_queries;
}
return $processed_queries;
}
/**
* Set media queries key value pairs.
*/
public static function set_media_queries() {
self::$media_queries = self::get_media_quries();
}
/**
* Return media query from the media query name.
* E.g For max_width_767 media query name, this function return "@media only screen and ( max-width: 767px )".
*
* @param string $name Media query name e.g max_width_767, max_width_980.
*
* @return bool|mixed
*/
public static function get_media_query( $name ) {
if ( ! isset( self::$media_queries[ $name ] ) ) {
return false;
}
return self::$media_queries[ $name ];
}
/**
* Get style key.
*
* @return int|string
*/
public static function get_style_key() {
if ( self::is_theme_builder_layout() ) {
return self::get_layout_id();
}
// Use a generic key in all other cases.
// For example, injector plugins that repeat a layout in a loop
// need to group that CSS under the same key.
return 'post';
}
/**
* Return style array from {@see self::$internal_modules_styles} or {@see self::$styles}.
*
* @param bool $internal Whether to return style from internal modules styles.
* @param int $key Style key.
*
* @return array|mixed
*/
public static function get_style_array( $internal = false, $key = 0 ) {
$styles = $internal ? self::$internal_modules_styles : self::$styles;
if ( 0 === $key ) {
$key = self::get_style_key();
}
return isset( $styles[ $key ] ) ? $styles[ $key ] : array();
}
/**
* Intended to be used for unit testing
*
* @intendedForTesting
*/
public static function reset_styles() {
self::$internal_modules_styles = array();
self::$styles = array();
self::$media_queries = array();
}
/**
* Get styles of the current page.
*
* @see set_advanced_styles()
*
* @param bool $internal Whether or not module's internal style.
* @param int $key Style key.
*
* @return string
*/
public static function get_style( $internal = false, $key = 0 ) {
// use appropriate array depending on which styles we need.
$styles_array = self::get_style_array( $internal, $key );
if ( empty( $styles_array ) ) {
return '';
}
global $et_user_fonts_queue;
$output = '';
if ( ! empty( $et_user_fonts_queue ) ) {
$output .= et_builder_enqueue_user_fonts( $et_user_fonts_queue );
}
$styles_by_media_queries = $styles_array;
$styles_count = (int) count( $styles_by_media_queries );
$media_queries_order = array_merge( array( 'general' ), array_values( self::$media_queries ) );
// make sure styles in the array ordered by media query correctly from bigger to smaller screensize.
$styles_by_media_queries_sorted = array_merge( array_flip( $media_queries_order ), $styles_by_media_queries );
foreach ( $styles_by_media_queries_sorted as $media_query => $styles ) {
// skip wrong values which were added during the array sorting.
if ( ! is_array( $styles ) ) {
continue;
}
$media_query_output = '';
$wrap_into_media_query = 'general' !== $media_query;
// sort styles by priority.
et_()->uasort( $styles, array( 'ET_Builder_Element', 'compare_by_priority' ) );
// get each rule in a media query.
foreach ( $styles as $selector => $settings ) {
$media_query_output .= sprintf(
'%3$s%4$s%1$s { %2$s }',
$selector,
$settings['declaration'],
"\n",
( $wrap_into_media_query ? "\t" : '' )
);
}
// All css rules that don't use media queries are assigned to the "general" key.
// Wrap all non-general settings into media query.
if ( $wrap_into_media_query ) {
$media_query_output = sprintf(
'%3$s%3$s%1$s {%2$s%3$s}',
$media_query,
$media_query_output,
"\n"
);
}
$output .= $media_query_output;
}
return $output;
}
/**
* Generate video background markup for columns.
*
* @param array $args Background values.
* @param array $conditional_tags Conditional tags.
* @param array $current_page Current page info.
*
* @return bool|mixed
*/
public static function get_column_video_background( $args = array(), $conditional_tags = array(), $current_page = array() ) {
if ( empty( $args ) ) {
return false;
}
$formatted_args = array();
foreach ( $args as $key => $value ) {
$key_length = strlen( $key );
$formatted_args[ substr( $key, 0, ( $key_length - 2 ) ) ] = $value;
}
return self::get_video_background( $formatted_args, $conditional_tags, $current_page );
}
/**
* Generate video background markup.
*
* @since 3.23 Add support for responsive settings.
*
* @param array $args Background values.
* @param array $conditional_tags Conditional tags.
* @param array $current_page Current page info.
* @return mixed Mixed background content generated as video markup.
*/
public static function get_video_background( $args = array(), $conditional_tags = array(), $current_page = array() ) {
$base_name = isset( $args['computed_variables'] ) && isset( $args['computed_variables']['base_name'] ) ? $args['computed_variables']['base_name'] : 'background';
$device = isset( $args['computed_variables'] ) && isset( $args['computed_variables']['device'] ) ? $args['computed_variables']['device'] : 'desktop';
$suffix = ! empty( $device ) && 'desktop' !== $device ? "_{$device}" : '';
$defaults = array(
"{$base_name}_video_mp4{$suffix}" => '',
"{$base_name}_video_webm{$suffix}" => '',
"{$base_name}_video_width{$suffix}" => '',
"{$base_name}_video_height{$suffix}" => '',
);
$args = wp_parse_args( $args, $defaults );
if ( '' === $args[ "{$base_name}_video_mp4{$suffix}" ] && '' === $args[ "{$base_name}_video_webm{$suffix}" ] ) {
return false;
}
return do_shortcode(
sprintf(
'
<video loop="loop" autoplay playsinline muted %3$s%4$s>
%1$s
%2$s
</video>',
( '' !== $args[ "{$base_name}_video_mp4{$suffix}" ] ? sprintf( '<source type="video/mp4" src="%s" />', esc_url( $args[ "{$base_name}_video_mp4{$suffix}" ] ) ) : '' ),
( '' !== $args[ "{$base_name}_video_webm{$suffix}" ] ? sprintf( '<source type="video/webm" src="%s" />', esc_url( $args[ "{$base_name}_video_webm{$suffix}" ] ) ) : '' ),
( '' !== $args[ "{$base_name}_video_width{$suffix}" ] ? sprintf( ' width="%s"', esc_attr( intval( $args[ "{$base_name}_video_width{$suffix}" ] ) ) ) : '' ),
( '' !== $args[ "{$base_name}_video_height{$suffix}" ] ? sprintf( ' height="%s"', esc_attr( intval( $args[ "{$base_name}_video_height{$suffix}" ] ) ) ) : '' )
)
);
}
/**
* Clean the styles array {@see self::$internal_modules_styles}.
*
* @param bool $need_internal_styles Set the flag to make sure new styles will be saved to the correct place.
*/
public static function clean_internal_modules_styles( $need_internal_styles = true ) {
// clean the styles array.
self::$internal_modules_styles[ self::get_style_key() ] = array();
// set the flag to make sure new styles will be saved to the correct place.
self::$prepare_internal_styles = $need_internal_styles;
// generate unique number to make sure module classes will be unique if shortcode is generated via ajax.
self::$internal_modules_counter = wp_rand( 10000, 99999 );
}
/**
* Set the field dependencies based on the `show_if` or `show_if_not` key from the
* field.
*
* @param string $slug The module's slug. ie `et_pb_section`.
* @param string $field_id The field id. id `background_color`.
* @param array $field_info Associative array of the field's data.
*/
protected static function set_field_dependencies( $slug, $field_id, $field_info ) {
// bail if the field_info is not an array.
if ( ! is_array( $field_info ) || ! self::$_->array_get( $field_info, 'bb_support', true ) ) {
return;
}
// otherwise we keep going.
foreach ( array( 'show_if', 'show_if_not' ) as $dependency_type ) {
if ( ! isset( $field_info[ $dependency_type ] ) ) {
continue;
}
if ( ! self::$data_utils->is_assoc_array( $field_info[ $dependency_type ] ) ) {
continue;
}
foreach ( $field_info[ $dependency_type ] as $dependency => $value ) {
// dependency -> dependent (eg. et_pb_signup.provider.affects.first_name_field.show_if: mailchimp).
$address = self::$_->esc_array( array( $slug, $dependency, 'affects', $field_id, $dependency_type ), 'esc_attr' );
self::$data_utils->array_set( self::$field_dependencies, $address, self::$_->esc_array( $value, 'esc_attr' ) );
// dependent -> dependency (eg. et_pb_signup.first_name_field.show_if.provider: mailchimp).
$address = self::$_->esc_array( array( $slug, $field_id, $dependency_type, $dependency ), 'esc_attr' );
self::$data_utils->array_set( self::$field_dependencies, $address, self::$_->esc_array( $value, 'esc_attr' ) );
}
}
}
/**
* Get all modules fields dependencies.
*
* @param string $post_type Post type.
*
* @return array
*/
public static function get_field_dependencies( $post_type ) {
if ( self::$field_dependencies ) {
return self::$field_dependencies;
}
$all_modules = self::get_parent_and_child_modules( $post_type );
foreach ( $all_modules as $module_slug => $module ) {
// Get all the fields.
$all_fields = $module->sort_fields( $module->_get_fields() );
foreach ( $all_fields as $field_id => $field_info ) {
if ( isset( $field_info['type'] ) && 'composite' === $field_info['type'] ) {
foreach ( $field_info['composite_structure'] as $field ) {
foreach ( $field['controls'] as $control => $data ) {
self::set_field_dependencies( $module_slug, $control, $data );
}
}
}
self::set_field_dependencies( $module_slug, $field_id, $field_info );
}
}
return self::$field_dependencies;
}
/**
* Set module style.
*
* @param string $function_name Module slug.
* @param array $style Style array.
*/
public static function set_style( $function_name, $style ) {
$selectors = is_array( $style['selector'] ) ? $style['selector'] : array( $style['selector'] );
foreach ( $selectors as $item ) {
foreach ( self::$_->sanitize_css_placeholders( $item ) as $selector ) {
$selector = apply_filters( "{$function_name}_css_selector", $selector );
self::_set_style( $function_name, array_merge( $style, array( 'selector' => $selector ) ) );
}
}
}
/**
* Check if the style processor allowed to be executed.
* Currently, we only use a custom processor from the method inside `ET_Builder_Module_Helper_Style_Processor`,
*
* NOTE: If there are more processors introduced, this needs to be updated
*
* @since 4.6.0
*
* @param array $processor Style processor.
*
* @return bool
*/
protected static function _is_style_processor_allowed( $processor ) {
$allow_list = array(
'ET_Builder_Module_Helper_Style_Processor',
);
return in_array( et_()->array_get( $processor, '0' ), $allow_list, true );
}
/**
* Generate responsive + hover + sticky style using the same configuration at once
* {
*
* @type string $mode
* @type string $render_slug
* @type string $base_attr_name
* @type array $attrs
* @type string $css_property
* @type string $selector
* @type bool $is_sticky_module
* @type bool|array $important Allowed value ​​is boolean or array of mode, e.g ['sticky', 'hover'].
* @type string $additional_css
* @type int $priority
* @type bool $responsive
* @type bool $hover
* @type string $hover_selector
* @type string $hover_pseudo_selector_location
* @type bool $sticky
* @type string $sticky_pseudo_selector_location
* }
*
* NOTE: If there are more mode besides sticky and hover introduced, this needs to be updated.
*
* @since 4.6.0
*
* @param array $args Function arguments.
*
* @return void
*/
public function generate_styles( $args = array() ) {
$defaults = array(
'mode' => 'sticky',
'render_slug' => '',
'base_attr_name' => '',
'attrs' => $this->props,
'css_property' => '',
'selector' => '%%order_class%%',
'is_sticky_module' => $this->is_sticky_module,
'important' => false,
'additional_css' => '',
'type' => '',
'priority' => '',
'responsive' => true,
'hover' => true,
'hover_selector' => '',
'hover_pseudo_selector_location' => 'order_class',
'sticky' => true,
'sticky_pseudo_selector_location' => 'order_class',
'processor' => false,
'responsive_processor' => false,
'hover_processor' => false,
'sticky_processor' => false,
'processor_declaration_format' => '',
);
$args = wp_parse_args( $args, $defaults );
$attrs = $args['attrs'];
$base_attr_name = $args['base_attr_name'];
$selector = $args['selector'];
// Responsive Options.
if ( $args['responsive'] ) {
$responsive = et_pb_responsive_options();
$responsive_values = $responsive->get_property_values( $attrs, $base_attr_name );
$responsive_processor = $args['responsive_processor'];
// Custom processor fallback, if there's any.
if ( ! $responsive_processor && $args['processor'] ) {
$responsive_processor = $args['processor'];
}
if ( $responsive_processor && self::_is_style_processor_allowed( $responsive_processor ) ) {
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found -- Need to be able to use a custom processor, the callback function is checked in the _is_style_processor_allowed
call_user_func(
$responsive_processor,
$selector,
$responsive_values,
$args,
'responsive'
);
} else {
// Append important tag to responsive's additional css.
$responsive_additional_css = '; ' . $args['additional_css'];
$responsive_important = is_array( $args['important'] ) ? in_array( 'responsive', $args['important'], true ) : $args['important'];
if ( $responsive_important ) {
$responsive_additional_css = ' !important;' . $args['additional_css'];
}
// Responsive Options.
$responsive->generate_responsive_css(
$responsive_values,
$selector,
$args['css_property'],
$args['render_slug'],
$responsive_additional_css,
$args['type'],
$args['priority']
);
}
}
// Hover Option.
if ( $args['hover'] ) {
$hover = et_pb_hover_options();
$hover_value = $hover->get_value( $base_attr_name, $attrs );
$hover_processor = $args['hover_processor'];
$hover_important = is_array( $args['important'] ) ? in_array( 'hover', $args['important'], true ) : $args['important'];
// Custom processor fallback, if there's any.
if ( ! $hover_processor && $args['processor'] ) {
$hover_processor = $args['processor'];
}
// Generate hover selector.
if ( '' !== $args['hover_selector'] ) {
$hover_selector = $args['hover_selector'];
} elseif ( 'order_class' === $args['hover_pseudo_selector_location'] ) {
$hover_selector = $hover->add_hover_to_order_class( $selector );
} else {
$hover_selector = $hover->add_hover_to_selectors( $selector );
}
if ( $hover_processor && self::_is_style_processor_allowed( $hover_processor ) ) {
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found -- Need to be able to use a custom processor, the callback function is checked in the _is_style_processor_allowed
call_user_func(
$hover_processor,
$hover_selector,
$hover_value,
$args,
'hover'
);
} elseif ( ! empty( $hover_value ) ) {
$declaration = $this->generate_declaration(
$args['css_property'],
$hover_value,
$hover_important,
$args['additional_css']
);
$el_style = array(
'selector' => $hover_selector,
'declaration' => $declaration,
);
self::set_style( $args['render_slug'], $el_style );
}
}
// Sticky Option.
if ( $args['sticky'] ) {
$sticky = et_pb_sticky_options();
$sticky_value = $sticky->get_value( $base_attr_name, $attrs );
$sticky_processor = $args['sticky_processor'];
$sticky_important = is_array( $args['important'] ) ? in_array( 'sticky', $args['important'], true ) : $args['important'];
// Custom processor fallback, if there's any.
if ( ! $sticky_processor && $args['processor'] ) {
$sticky_processor = $args['processor'];
}
// If generate_styles() is called multiple times, check for it once then pass
// it down as param to skip sticky module check on this method level.
$is_sticky_module = null === $args['is_sticky_module'] ?
$sticky->is_sticky_module( $attrs ) :
$args['is_sticky_module'];
// Generate sticky selector.
if ( 'order_class' === $args['sticky_pseudo_selector_location'] ) {
$sticky_selector = $sticky->add_sticky_to_order_class( $selector, $is_sticky_module );
} else {
$sticky_selector = $sticky->add_sticky_to_selectors( $selector, $is_sticky_module );
}
if ( $sticky_processor && self::_is_style_processor_allowed( $sticky_processor ) ) {
// @phpcs:ignore Generic.PHP.ForbiddenFunctions.Found -- Need to be able to use a custom processor, the callback function is checked in the _is_style_processor_allowed
call_user_func(
$sticky_processor,
$sticky_selector,
$sticky_value,
$args,
'sticky'
);
} elseif ( ! empty( $sticky_value ) ) {
$sticky_declaration = self::generate_declaration(
$args['css_property'],
$sticky_value,
$sticky_important,
$args['additional_css']
);
$el_style = array(
'selector' => $sticky_selector,
'declaration' => $sticky_declaration,
);
self::set_style( $args['render_slug'], $el_style );
}
}
}
/**
* Generate CSS declaration.
*
* @since 4.6.0
*
* @param array|string $css_property CSS Property.
* @param string $value Value.
* @param bool $important Use important tag.
* @param string $additional_css Additional CSS.
*
* @return string
*/
public function generate_declaration( $css_property, $value = '', $important = false, $additional_css = '' ) {
$important_tag = $important ? ' !important' : '';
$declaration = '';
// Assign value to one or more properties.
if ( is_string( $css_property ) ) {
$declaration = sprintf(
'%1$s: %2$s%3$s;%4$s',
esc_attr( $css_property ),
esc_attr( $value ),
esc_attr( $important_tag ),
esc_attr( $additional_css )
);
} elseif ( is_array( $css_property ) ) {
foreach ( $css_property as $property ) {
$declaration .= sprintf(
'%1$s: %2$s%3$s;%4$s',
esc_attr( $property ),
esc_attr( $value ),
esc_attr( $important_tag ),
esc_attr( $additional_css )
);
}
}
return $declaration;
}
/**
* Applies the responsive and hover style for a specified option
*
* @since 3.25.3
*
* @param string $option Setting option.
* @param string $selector CSS Selector.
* @param string $css_prop CSS property.
*/
public function generate_responsive_hover_style( $option, $selector, $css_prop ) {
$responsive = et_pb_responsive_options();
$hover = et_pb_hover_options();
$values = $responsive->get_property_values( $this->props, $option );
$hover_value = $hover->get_value( $option, $this->props );
$responsive->generate_responsive_css( $values, $selector, $css_prop, $this->slug, '', 'color' );
if ( $hover_value ) {
self::set_style(
$this->slug,
array(
'selector' => $hover->add_hover_to_selectors( $selector ),
'declaration' => "{$css_prop}: $hover_value;",
)
);
}
}
/**
* Set module style.
*
* @param string $function_name Module slug.
* @param array $style Style array.
*/
protected static function _set_style( $function_name, $style ) {
$declaration = rtrim( $style['declaration'] );
if ( empty( $declaration ) ) {
// Do not add empty declarations.
return;
}
$builder_post_types = et_builder_get_builder_post_types();
$allowed_post_types = apply_filters( 'et_builder_set_style_allowed_post_types', $builder_post_types );
if ( $builder_post_types !== $allowed_post_types ) {
$matches = array_intersect( $allowed_post_types, array_keys( self::$_module_slugs_by_post_type ) );
$allowed = false;
foreach ( $matches as $post_type ) {
if ( ! isset( self::$_module_slugs_by_post_type[ $post_type ] ) ) {
continue;
}
if ( in_array( $function_name, self::$_module_slugs_by_post_type[ $post_type ], true ) ) {
$allowed = true;
break;
}
}
if ( ! $allowed ) {
return;
}
}
global $et_pb_rendering_column_content;
// do not process all the styles if FB enabled. Only those for modules without fb support and styles for the internal modules from Blog/Slider.
$main_query_post = ET_Post_Stack::get_main_post();
$main_query_post_id = null !== $main_query_post ? $main_query_post->ID : 0;
$editing_current_post = et_fb_is_enabled() && self::get_layout_id() === $main_query_post_id;
if ( $editing_current_post && ! in_array( $function_name, self::get_fb_unsupported_modules(), true ) && ! $et_pb_rendering_column_content ) {
return;
}
$order_class_name = self::get_module_order_class( $function_name );
$selector = str_replace( '%%order_class%%', ".{$order_class_name}", $style['selector'] );
$selector = str_replace( '%order_class%', ".{$order_class_name}", $selector );
// %%parent_class%% only works if child module's slug is `parent_slug` + _item suffix. If child module slug
// use different slug structure, %%parent_class%% should not be used
if ( false !== strpos( $selector, '%%parent_class%%' ) ) {
$parent_class = str_replace( '_item', '', $function_name );
$selector = str_replace( '%%parent_class%%', ".{$parent_class}", $selector );
}
$selector = wp_strip_all_tags( apply_filters( 'et_pb_set_style_selector', $selector, $function_name ) );
$selector = et_builder_maybe_wrap_css_selectors( $selector, false, ".{$order_class_name}" );
// New lines are saved as || in CSS Custom settings, remove them.
$declaration = preg_replace( '/(\|\|)/i', '', $declaration );
$media_query = isset( $style['media_query'] ) ? $style['media_query'] : 'general';
$internal = $et_pb_rendering_column_content && self::$prepare_internal_styles;
$style_key = self::get_style_key();
$styles = self::get_style_array( $internal );
// prepare styles for internal content. Used in Blog/Slider modules if they contain Divi modules.
if ( isset( $styles[ $media_query ][ $selector ]['declaration'] ) ) {
$styles[ $media_query ][ $selector ]['declaration'] = sprintf(
'%1$s %2$s',
$styles[ $media_query ][ $selector ]['declaration'],
$declaration
);
} else {
$styles[ $media_query ][ $selector ]['declaration'] = $declaration;
}
if ( isset( $style['priority'] ) ) {
$styles[ $media_query ][ $selector ]['priority'] = (int) $style['priority'];
}
if ( $internal ) {
self::$internal_modules_styles[ $style_key ] = $styles;
} else {
self::$styles[ $style_key ] = $styles;
}
}
/**
* Return module order class.
*
* @param string $function_name Module slug.
*
* @return bool|string
*/
public static function get_module_order_class( $function_name ) {
global $et_pb_rendering_column_content, $et_pb_predefined_module_index;
// determine whether we need to get the internal module class or regular.
$get_inner_module_class = $et_pb_rendering_column_content;
if ( $get_inner_module_class ) {
if ( self::_get_index( array( self::INDEX_INNER_MODULE_ORDER, $function_name ) ) === -1 ) {
return false;
}
} else {
if ( self::_get_index( array( self::INDEX_MODULE_ORDER, $function_name ) ) === -1 ) {
return false;
}
}
if ( isset( $et_pb_predefined_module_index ) && $et_pb_predefined_module_index ) {
$shortcode_order_num = $et_pb_predefined_module_index;
} else {
$shortcode_order_num = $get_inner_module_class ? self::_get_index( array( self::INDEX_INNER_MODULE_ORDER, $function_name ) ) : self::_get_index( array( self::INDEX_MODULE_ORDER, $function_name ) );
}
$theme_builder_suffix = self::_get_theme_builder_order_class_suffix();
$order_class_name = sprintf( '%1$s_%2$s%3$s', $function_name, $shortcode_order_num, $theme_builder_suffix );
return $order_class_name;
}
/**
* Set module order class.
*
* @param string $function_name Module slug.
*/
public static function set_order_class( $function_name ) {
global $et_pb_rendering_column_content;
// determine whether we need to update the internal module class or regular.
$process_inner_module_class = $et_pb_rendering_column_content;
if ( $process_inner_module_class ) {
$current_inner_index = self::_get_index( array( self::INDEX_INNER_MODULE_ORDER, $function_name ) );
self::_set_index(
array( self::INDEX_INNER_MODULE_ORDER, $function_name ),
$current_inner_index > -1 ? $current_inner_index + 1 : self::$internal_modules_counter
);
} else {
self::_set_index(
array( self::INDEX_MODULE_ORDER, $function_name ),
self::_get_index( array( self::INDEX_MODULE_ORDER, $function_name ) ) + 1
);
}
}
/**
* Add a modal order class e.g et_pb_section_0, et_pb_section_1.
*
* @param string $module_class Module class e.g et_pb_section_.
* @param string $function_name Module slug.
*
* @return string
*/
public static function add_module_order_class( $module_class, $function_name ) {
$order_class_name = self::get_module_order_class( $function_name );
return "{$module_class} {$order_class_name}";
}
/**
* Generate video background markup.
*
* @since 3.23 Add support for responsive settings.
*
* @param array $args Background values.
* @param string $base_name Background base name.
* @return string Video background string value.
*/
public function video_background( $args = array(), $base_name = 'background' ) {
$attr_prefix = "{$base_name}_";
$custom_prefix = 'background' === $base_name ? '' : "{$base_name}_";
$module_attrs = $this->props;
// Default background class for each devices.
$background_video_class = '';
$background_video_class_tablet = 'et_pb_section_video_bg_tablet';
$background_video_class_phone = 'et_pb_section_video_bg_phone';
$background_video_class_hover = 'et_pb_section_video_bg_hover';
// Hover and Responsive Status.
$hover_enabled = self::$_->array_get( $this->props, "{$base_name}__hover_enabled", 'off' );
$is_background_hover = 'on' === $hover_enabled;
$is_background_mobile = et_pb_responsive_options()->is_responsive_enabled( $this->props, $base_name );
if ( ! empty( $args ) ) {
$background_video = self::get_video_background( $args );
$background_video_tablet = '';
$background_video_phone = '';
$background_video_hover = '';
$pause_outside_viewport = self::$_->array_get( $args, "{$attr_prefix}video_pause_outside_viewport", 'off' );
$allow_player_pause = self::$_->array_get( $args, "{$custom_prefix}allow_player_pause", 'off' );
} else {
$background_videos = array();
// Desktop.
$default_args = array(
"{$attr_prefix}video_mp4" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_mp4" ),
"{$attr_prefix}video_webm" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_webm" ),
"{$attr_prefix}video_width" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_width", '', true ),
"{$attr_prefix}video_height" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_height", '', true ),
'computed_variables' => array(
'base_name' => $base_name,
),
);
// Collecting background videos.
$background_videos['desktop'] = self::get_video_background( $default_args );
$module_attrs[ "video_{$base_name}_values" ] = $background_videos;
// Get video and display status.
$background_video_status = et_pb_responsive_options()->get_inheritance_background_value( $module_attrs, "video_{$base_name}_values", 'desktop', $base_name, $this->fields_unprocessed );
$background_video = self::$_->array_get( $background_video_status, 'video', '' );
$background_display = self::$_->array_get( $background_video_status, 'display', '' );
// Hover.
$background_video_hover = '';
$background_display_hover = '';
if ( $is_background_hover ) {
$hover_args = array(
"{$attr_prefix}video_mp4__hover" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_mp4__hover" ),
"{$attr_prefix}video_webm__hover" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_webm__hover" ),
"{$attr_prefix}video_width__hover" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_width__hover", '', true ),
"{$attr_prefix}video_height__hover" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_height__hover", '', true ),
'computed_variables' => array(
'base_name' => $base_name,
'device' => '_hover',
),
);
// Collecting background videos.
$background_videos['hover'] = self::get_video_background( $hover_args );
$module_attrs[ "video_{$base_name}_values" ] = $background_videos;
// Get video and display status.
$background_video_status_hover = et_pb_responsive_options()->get_inheritance_background_value( $module_attrs, "video_{$base_name}_values", 'hover', $base_name, $this->fields_unprocessed );
$background_video_hover = self::$_->array_get( $background_video_status_hover, 'video', '' );
$background_display_hover = self::$_->array_get( $background_video_status_hover, 'display', '' );
}
// Tablet and Phone.
$background_video_tablet = '';
$background_display_tablet = '';
$background_video_phone = '';
$background_display_phone = '';
if ( $is_background_mobile ) {
$tablet_args = array(
"{$attr_prefix}video_mp4_tablet" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_mp4_tablet" ),
"{$attr_prefix}video_webm_tablet" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_webm_tablet" ),
"{$attr_prefix}video_width_tablet" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_width_tablet", '', true ),
"{$attr_prefix}video_height_tablet" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_height_tablet", '', true ),
'computed_variables' => array(
'base_name' => $base_name,
'device' => 'tablet',
),
);
$phone_args = array(
"{$attr_prefix}video_mp4_phone" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_mp4_phone" ),
"{$attr_prefix}video_webm_phone" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_webm_phone" ),
"{$attr_prefix}video_width_phone" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_width_phone", '', true ),
"{$attr_prefix}video_height_phone" => et_pb_responsive_options()->get_any_value( $this->props, "{$attr_prefix}video_height_phone", '', true ),
'computed_variables' => array(
'base_name' => $base_name,
'device' => 'phone',
),
);
// Collecting background videos.
$background_videos['tablet'] = self::get_video_background( $tablet_args );
$background_videos['phone'] = self::get_video_background( $phone_args );
$module_attrs[ "video_{$base_name}_values" ] = $background_videos;
// Get video and display status.
$background_video_status_tablet = et_pb_responsive_options()->get_inheritance_background_value( $module_attrs, "video_{$base_name}_values", 'tablet', $base_name, $this->fields_unprocessed );
$background_video_tablet = self::$_->array_get( $background_video_status_tablet, 'video', '' );
$background_display_tablet = self::$_->array_get( $background_video_status_tablet, 'display', '' );
$background_video_status_phone = et_pb_responsive_options()->get_inheritance_background_value( $module_attrs, "video_{$base_name}_values", 'phone', $base_name, $this->fields_unprocessed );
$background_video_phone = self::$_->array_get( $background_video_status_phone, 'video', '' );
$background_display_phone = self::$_->array_get( $background_video_status_phone, 'display', '' );
}
// Set background video and class. Inherit is used to avoid rendering the same video.
if ( '' !== $background_display_phone ) {
if ( 'hide' === $background_display_phone ) {
$background_video_class = 'et_pb_section_video_bg_desktop_tablet';
$background_video_class_tablet = 'et_pb_section_video_bg_tablet_only';
} elseif ( 'inherit' === $background_display_phone ) {
$background_video_phone = '';
}
}
if ( '' !== $background_display_tablet ) {
if ( 'hide' === $background_display_tablet ) {
$background_video_class = 'et_pb_section_video_bg_desktop_only';
} elseif ( 'inherit' === $background_display_tablet ) {
$background_video_tablet = '';
}
}
if ( '' !== $background_display_hover ) {
if ( 'inherit' === $background_display_hover ) {
$background_video_class .= ' et_pb_section_video_bg_hover_inherit';
$background_video_hover = '';
}
}
}
$video_background = '';
// Desktop.
if ( $background_video ) {
// Video on desktop properties.
$pause_outside_viewport = self::$_->array_get( $this->props, "{$attr_prefix}video_pause_outside_viewport", '' );
$allow_player_pause = self::$_->array_get( $this->props, "{$custom_prefix}allow_player_pause", 'off' );
$video_background .= sprintf(
'<span class="et_pb_section_video_bg %2$s %3$s%4$s">
%1$s
</span>',
$background_video,
$background_video_class,
( 'on' === $allow_player_pause ? ' et_pb_allow_player_pause' : '' ),
( 'off' === $pause_outside_viewport ? ' et_pb_video_play_outside_viewport' : '' )
);
}
// Hover.
if ( $is_background_hover ) {
if ( $background_video_hover ) {
// Video on hover properties.
$pause_outside_viewport_hover = self::$_->array_get( $this->props, "{$attr_prefix}video_pause_outside_viewport__hover", '' );
$allow_player_pause_hover = self::$_->array_get( $this->props, "{$custom_prefix}allow_player_pause__hover", 'off' );
$video_background .= sprintf(
'<span class="et_pb_section_video_bg %2$s %3$s%4$s">
%1$s
</span>',
$background_video_hover,
$background_video_class_hover,
( 'on' === $allow_player_pause_hover ? ' et_pb_allow_player_pause' : '' ),
( 'off' === $pause_outside_viewport_hover ? ' et_pb_video_play_outside_viewport' : '' )
);
}
$this->add_classname( 'et_pb_section_video_on_hover' );
}
// Tablet.
if ( $background_video_tablet && $is_background_mobile ) {
// Video on tablet properties.
$pause_outside_viewport_tablet = self::$_->array_get( $this->props, "{$attr_prefix}video_pause_outside_viewport_tablet", '' );
$allow_player_pause_tablet = self::$_->array_get( $this->props, "{$custom_prefix}allow_player_pause_tablet", 'off' );
$video_background .= sprintf(
'<span class="et_pb_section_video_bg %2$s %3$s%4$s">
%1$s
</span>',
$background_video_tablet,
$background_video_class_tablet,
( 'on' === $allow_player_pause_tablet ? ' et_pb_allow_player_pause' : '' ),
( 'off' === $pause_outside_viewport_tablet ? ' et_pb_video_play_outside_viewport' : '' )
);
}
// Phone.
if ( $background_video_phone && $is_background_mobile ) {
// Video on phone properties.
$pause_outside_viewport_phone = self::$_->array_get( $this->props, "{$attr_prefix}video_pause_outside_viewport_phone", '' );
$allow_player_pause_phone = self::$_->array_get( $this->props, "{$custom_prefix}allow_player_pause_phone", 'off' );
$video_background .= sprintf(
'<span class="et_pb_section_video_bg %2$s %3$s%4$s">
%1$s
</span>',
$background_video_phone,
$background_video_class_phone,
( 'on' === $allow_player_pause_phone ? ' et_pb_allow_player_pause' : '' ),
( 'off' === $pause_outside_viewport_phone ? ' et_pb_video_play_outside_viewport' : '' )
);
}
// Added classname for module wrapper.
if ( '' !== $video_background ) {
wp_enqueue_style( 'wp-mediaelement' );
wp_enqueue_script( 'wp-mediaelement' );
$this->add_classname( array( 'et_pb_section_video', 'et_pb_preload' ) );
}
return $video_background;
}
/**
* Generate parallax image background markup.
*
* @param string $base_name Background base name.
*
* @return string
*/
public function get_parallax_image_background( $base_name = 'background' ) {
$attr_prefix = "{$base_name}_";
$custom_prefix = 'background' === $base_name ? '' : "{$base_name}_";
$parallax_processed = array();
$parallax_background = '';
$hover_suffix = et_pb_hover_options()->get_suffix();
$sticky_suffix = et_pb_sticky_options()->get_suffix();
$preview_modes = array( $hover_suffix, $sticky_suffix, '_phone', '_tablet', '' );
// Featured Image as Background.
$featured_image = '';
$featured_placement = '';
$featured_image_src = '';
if ( $this->featured_image_background ) {
$featured_image = self::$_->array_get( $this->props, 'featured_image', '' );
$featured_placement = self::$_->array_get( $this->props, 'featured_placement', '' );
$featured_image_src_obj = wp_get_attachment_image_src( get_post_thumbnail_id( self::_get_main_post_id() ), 'full' );
$featured_image_src = isset( $featured_image_src_obj[0] ) ? $featured_image_src_obj[0] : '';
}
foreach ( $preview_modes as $suffix ) {
$is_hover = $hover_suffix === $suffix;
$is_sticky = $sticky_suffix === $suffix;
// A. Bail early if hover or responsive settings disabled on mobile/hover.
if ( '' !== $suffix ) {
// Ensure responsive settings is enabled on mobile.
if ( ! $is_hover && ! $is_sticky && ! et_pb_responsive_options()->is_responsive_enabled( $this->props, $base_name ) ) {
continue;
}
// Ensure hover settings is enabled.
if ( $is_hover && ! et_pb_hover_options()->is_enabled( $base_name, $this->props ) ) {
continue;
}
// Ensure sticky setting is enabled.
if ( $is_sticky && ! et_pb_sticky_options()->is_enabled( $base_name, $this->props ) ) {
continue;
}
}
// Prepare preview mode.
$mode = '' !== $suffix ? str_replace( '_', '', $suffix ) : 'desktop';
$mode = $is_hover ? 'hover' : $mode;
$mode = $is_sticky ? 'sticky' : $mode;
// B.1. Get inherited background value.
$background_image = et_pb_responsive_options()->get_inheritance_background_value( $this->props, "{$attr_prefix}image", $mode, $base_name, $this->fields_unprocessed );
$parallax = et_pb_responsive_options()->get_any_value( $this->props, "{$custom_prefix}parallax{$suffix}", '', true );
$parallax_method = et_pb_responsive_options()->get_any_value( $this->props, "{$custom_prefix}parallax_method{$suffix}", '', true );
// B.2. Set default value for parallax and parallax method on hover and sticky when they are empty.
if ( $is_hover ) {
$parallax = et_pb_hover_options()->get_raw_value( "{$custom_prefix}parallax", $this->props );
$parallax_method = et_pb_hover_options()->get_raw_value( "{$custom_prefix}parallax_method", $this->props );
}
if ( $is_sticky ) {
$parallax = et_pb_sticky_options()->get_raw_value( "{$custom_prefix}parallax", $this->props );
$parallax_method = et_pb_sticky_options()->get_raw_value( "{$custom_prefix}parallax_method", $this->props );
}
if ( $is_hover || $is_sticky ) {
$parallax = empty( $parallax ) ? et_pb_responsive_options()->get_any_value( $this->props, "{$custom_prefix}parallax", '', true ) : $parallax;
$parallax_method = empty( $parallax_method ) ? et_pb_responsive_options()->get_any_value( $this->props, "{$custom_prefix}parallax_method", '', true ) : $parallax_method;
}
// B.3. Override background image with featured image if needed.
if ( 'on' === $featured_image && 'background' === $featured_placement && '' !== $featured_image_src ) {
$background_image = $featured_image_src;
}
// C.1. Parallax BG Class to inform if other modes exist.
$parallax_classname = array();
if ( ( '_tablet' === $suffix || '' === $suffix ) && in_array( '_phone', $parallax_processed, true ) ) {
$parallax_classname[] = 'et_parallax_bg_phone_exist';
}
if ( '' === $suffix && in_array( '_tablet', $parallax_processed, true ) ) {
$parallax_classname[] = 'et_parallax_bg_tablet_exist';
}
if ( in_array( $hover_suffix, $parallax_processed, true ) ) {
$parallax_classname[] = 'et_parallax_bg_hover_exist';
}
if ( in_array( $sticky_suffix, $parallax_processed, true ) ) {
$parallax_classname[] = 'et_parallax_bg_sticky_exist';
}
// C.2. Set up parallax class and wrapper.
if ( '' !== $background_image && 'on' === $parallax ) {
$parallax_classname[] = 'et_parallax_bg';
if ( 'off' === $parallax_method ) {
$parallax_classname[] = 'et_pb_parallax_css';
}
// Parallax BG Class with suffix.
if ( '' !== $suffix ) {
$parallax_classname[] = "et_parallax_bg{$suffix}";
}
$parallax_background .= sprintf(
'<span class="et_parallax_bg_wrap"><span
class="%1$s"
style="background-image: url(%2$s);"
></span></span>',
esc_attr( implode( ' ', $parallax_classname ) ),
esc_url( $background_image )
);
// set `.et_parallax_bg_wrap` border-radius.
et_set_parallax_bg_wrap_border_radius( $this->props, $this->slug, $this->main_css_element );
}
// C.3. Hover parallax class.
if ( '' !== $background_image && $is_hover ) {
$this->add_classname( 'et_pb_section_parallax_hover' );
}
// C.4. Sticky parallax class.
if ( '' !== $background_image && $is_sticky ) {
$this->add_classname( 'et_pb_section_parallax_sticky' );
}
array_push( $parallax_processed, $suffix );
}
// Added classname for module wrapper.
if ( '' !== $parallax_background ) {
$this->add_classname( 'et_pb_section_parallax' );
}
return $parallax_background;
}
/**
* Generate CSS Filters
* Check our shortcode arguments for CSS `filter` properties. If found, set the style rules for this block. (This
* function reads options set by the 'Filters' and 'Image Filters' builder menu fields.)
*
* @since 3.23 Add responsive setting styling processing here.
* @since 4.6.0 Add sticky style support.
*
* @param string $function_name Builder module's function name (keeps the CSS rules straight).
* @param string $prefix Optional string prepended to the field name (i.e., `filter_saturate` -> `child_filter_saturate`).
* @param mixed $selectors Array or string containing all target DOM element(s), ID(s), and/or class(es).
*
* @return string Any additional CSS classes (added if filters were applied).
*/
public function generate_css_filters( $function_name = '', $prefix = '', $selectors = array( '%%order_class%%' ) ) {
if ( '' === $function_name ) {
ET_Core_Logger::error( '$function_name is required.' );
return;
}
// If `$selectors` is a string, convert to an array before we continue.
$selectors_prepared = $selectors;
if ( ! is_array( $selectors ) ) {
$selectors_prepared = explode( ',', et_core_intentionally_unescaped( $selectors, 'fixed_string' ) );
}
$responsive_selectors = $selectors_prepared;
$additional_classes = '';
// If we don't have a target selector, get out now.
if ( ! $selectors_prepared ) {
return $additional_classes;
}
$hover_suffix = et_pb_hover_options()->get_suffix();
$sticky = et_pb_sticky_options();
$sticky_suffix = $sticky->get_suffix();
$field_suffixes = array( '', 'tablet', 'phone', $hover_suffix, $sticky_suffix );
$filters_default = array();
$filters_default_fb = array();
$filters_hover = array();
$hover_selectors = array();
foreach ( $field_suffixes as $suffix ) {
$sticky_mode = $sticky_suffix === $suffix;
if ( $hover_suffix === $suffix ) {
$selectors_prepared = array_map( array( $this, 'add_hover_to_selectors' ), $selectors_prepared );
}
if ( $sticky_mode ) {
$selectors_prepared = $sticky->add_sticky_to_selectors(
$selectors,
$this->is_sticky_module,
false
);
}
// Mobile parameters. Update suffix and add media query argument for styles declaration.
$device_suffix = '';
$media_query = array();
$is_mobile = in_array( $suffix, array( 'tablet', 'phone' ), true );
if ( $is_mobile ) {
$breakpoint = 'tablet' === $suffix ? 'max_width_980' : 'max_width_767';
$media_query = array( 'media_query' => self::get_media_query( $breakpoint ) );
// For mobile, we need to reset $suffix and use $devie_suffix instead. Later on with
// empty suffix, the filter will only return desktop value and will be used as default
// and will be merged with filter mobile values.
$device_suffix = "_{$suffix}";
$suffix = '';
}
// Some web browser glitches with filters and blend modes can be improved this way
// see https://bugs.chromium.org/p/chromium/issues/detail?id=157218 for more info.
$backface_visibility = 'backface-visibility:hidden;';
$backface_visibility_added = array();
$additional_classes = '';
// Blend Mode.
$mix_blend_mode = self::$data_utils->array_get( $this->props, "{$prefix}mix_blend_mode", '' );
// Filters.
$filter = array();
$filter_names = array();
$filter_keys = array(
'hue_rotate',
'saturate',
'brightness',
'contrast',
'invert',
'sepia',
'opacity',
'blur',
);
// Assign filter values and names.
foreach ( $filter_keys as $filter_key ) {
$filter_name = "{$prefix}filter_{$filter_key}";
$filter_names[] = $filter_name;
$filter[ $filter_key ] = self::$data_utils->array_get( $this->props, "{$filter_name}{$suffix}", '' );
}
$is_any_filter_responsive = et_pb_responsive_options()->is_any_responsive_enabled( $this->props, $filter_names );
$is_any_filter_hover_enabled = et_pb_hover_options()->is_any_hover_enabled( $this->props, $filter_names );
// For mobile, it should return any value exist if current device value is empty.
if ( $is_mobile ) {
// Blend Mode.
$is_blend_responsive = et_pb_responsive_options()->is_responsive_enabled( $this->props, "{$prefix}mix_blend_mode" );
$mix_blend_mode = $is_blend_responsive ? et_pb_responsive_options()->get_any_value( $this->props, "{$prefix}mix_blend_mode{$suffix}", '', true ) : '';
// Filters.
$filters_mobile = array();
foreach ( $filter as $filter_key => $filter_value ) {
if ( ! et_pb_responsive_options()->is_responsive_enabled( $this->props, "{$prefix}filter_{$filter_key}" ) ) {
continue;
}
$filters_mobile[ $filter_key ] = et_pb_responsive_options()->get_any_value( $this->props, "{$prefix}filter_{$filter_key}{$device_suffix}", '', true );
}
// If any responsive settings active on filter settings, set desktop value as default.
if ( $is_any_filter_responsive ) {
$filters_mobile = array_merge( $filter, $filters_mobile );
}
// Replace current filter values with mobile filter values.
$filter = $filters_mobile;
}
// Remove any filters with null or default values.
$filter = array_filter( $filter, 'strlen' );
// Optional: CSS `mix-blend-mode` rule.
$mix_blend_mode_default = ET_Global_Settings::get_value( 'all_mix_blend_mode', 'default' );
if ( $mix_blend_mode && $mix_blend_mode !== $mix_blend_mode_default ) {
if ( ! $sticky_mode ) {
foreach ( $selectors_prepared as $selector ) {
$el_style = array_merge(
array(
'selector' => $selector,
'declaration' => sprintf(
'mix-blend-mode: %1$s;',
esc_html( $mix_blend_mode )
) . $backface_visibility,
),
$media_query
);
self::set_style( $function_name, $el_style );
$backface_visibility_added[] = $selector;
}
}
$additional_classes .= ' et_pb_css_mix_blend_mode';
} elseif ( 'et_pb_column' === $function_name ) {
// Columns need to pass through.
$additional_classes .= ' et_pb_css_mix_blend_mode_passthrough';
}
// Optional: CSS `filter` rule.
if ( empty( $filter ) ) {
// Since we added responsive settings, the process should not be stopped here.
// It should continue until tablet and phone are checked completely. Replace
// return with continue.
continue;
}
$css_value = array();
$css_value_fb_hover = array();
foreach ( $filter as $label => $value ) {
// Check against our default settings, and only append the rule if it differs
// (only for default state since hover and mobile might be equal to default,
// ie. no filter on hover only).
if ( ET_Global_Settings::get_value( 'all_filter_' . $label, 'default' ) === $value && $hover_suffix !== $suffix && ! $sticky_mode && ! $is_mobile && ! ( $is_any_filter_responsive && $is_any_filter_hover_enabled ) ) {
continue;
}
// Don't apply hover filter if it is not enabled.
if ( $hover_suffix === $suffix && ! et_pb_hover_options()->is_enabled( "{$prefix}filter_{$label}{$suffix}", $this->props ) ) {
continue;
}
// Don't apply sticky filter if it is not enabled.
if ( $sticky_mode && ! $sticky->is_enabled( "{$prefix}filter_{$label}{$suffix}", $this->props ) ) {
continue;
}
$value = et_sanitize_input_unit( $value, false, 'deg' );
$label_css_format = str_replace( '_', '-', $label );
// Construct string of all CSS Filter values.
$css_value[ $label ] = esc_html( "${label_css_format}(${value})" );
// Construct Visual Builder hover rules.
if ( ! in_array( $label, array( 'opacity', 'blur' ), true ) ) {
// Skip those, because they mess with VB controls.
$css_value_fb_hover[ $label ] = esc_html( "${label_css_format}(${value})" );
}
}
// Append our new CSS rules.
if ( $css_value ) {
// Store the default (non-hover) filters.
if ( '' === $suffix ) {
$filters_default = $css_value;
}
// Merge the hover filters onto the default filters so that filters that
// have no hover option set are not removed from the CSS declaration.
if ( $hover_suffix === $suffix ) {
$css_value = array_merge( $filters_default, $css_value );
$filters_hover = $css_value;
}
foreach ( $selectors_prepared as $selector ) {
$backface_visibility_declaration = in_array( $selector, $backface_visibility_added, true ) ? '' : $backface_visibility;
// Allow custom child filter target hover selector.
if ( $hover_suffix === $suffix ) {
if ( 'child_' === $prefix ) {
$selector = self::$_->array_get( $this->advanced_fields, 'filters.child_filters_target.css.hover', $selector );
}
$hover_selectors[] = $selector;
}
$el_style = array_merge(
array(
'selector' => $selector,
'declaration' => sprintf(
'filter: %1$s;',
implode( ' ', $css_value )
) . $backface_visibility_declaration,
),
$media_query
);
self::set_style( $function_name, $el_style );
}
// Add css for hover styles in sticky state.
if ( $sticky_mode && ! empty( $filters_hover ) && ! empty( $hover_selectors ) ) {
$sticky_hover_css_value = implode( ' ', $filters_hover );
foreach ( $hover_selectors as $hover_selector ) {
$sticky_hover_selector = $sticky->add_sticky_to_order_class(
$hover_selector,
$this->is_sticky_module
);
$el_style = array_merge(
array(
'selector' => $sticky_hover_selector,
'declaration' => sprintf(
'filter: %1$s;',
$sticky_hover_css_value
) . $backface_visibility_declaration,
),
$media_query
);
self::set_style( $function_name, $el_style );
}
}
$additional_classes .= ' et_pb_css_filters';
}
// If we have VB hover-friendly CSS rules, we'll gather those and append them here.
if ( $css_value_fb_hover ) {
// Store the default (non-hover) filters.
if ( '' === $suffix ) {
$filters_default_fb = $css_value_fb_hover;
}
// Merge the hover filters onto the default filters so that filters that
// have no hover option set are not removed from the CSS declaration.
if ( $hover_suffix === $suffix ) {
$css_value_fb_hover = array_merge( $filters_default_fb, $css_value_fb_hover );
}
if ( ! $sticky_mode ) {
foreach ( $selectors_prepared as $selector ) {
$selector_hover = str_replace(
'%%order_class%%',
'html:not(.et_fb_edit_enabled) #et-fb-app %%order_class%%:hover',
$selector
);
$el_style = array(
'selector' => $selector_hover,
'declaration' => esc_html(
sprintf(
'filter: %1$s;',
implode( ' ', $css_value_fb_hover )
)
),
);
self::set_style( $function_name, $el_style );
}
}
$additional_classes .= ' et_pb_css_filters_hover';
}
}
return $additional_classes;
}
/**
* Convert classes array to a string. Also removes any duplicate classes
*
* @param array $classes A list of CSS classnames.
*
* @return array
*/
public function stringify_css_filter_classes( $classes ) {
// Remove repeating classes.
$classes = array_unique( $classes );
// Transform classes to a string.
$classes = ' ' . implode( ' ', $classes );
return $classes;
}
/**
* Adds a suffix at the end of the selector
* E.g: add_suffix_to_selectors(':hover', '%%order_class%%% .image') >>> '%%order_class%%% .image:hover'
*
* @param string $suffix e.g ':hover'.
* @param string $selector CSS selector.
*
* @return string
*/
public function add_suffix_to_selectors( $suffix, $selector ) {
$selectors = explode( ',', $selector );
$selectors = array_map( 'trim', $selectors );
foreach ( $selectors as &$selector ) {
$selector .= $suffix;
}
return implode( ', ', $selectors );
}
/**
* Adds `:hover` in selector at the end of the selector
* E.g: add_hover_to_selectors('%%order_class%%% .image') >>> '%%order_class%%% .image:hover'
*
* @param string $selector CSS selector.
*
* @return string
*
* @deprecated Use et_pb_hover_options()->add_hover_to_selectors( $selector );
*/
public function add_hover_to_selectors( $selector ) {
return et_pb_hover_options()->add_hover_to_selectors( $selector );
}
/**
* Adds `:hover` in selector at the end of the selector if $add_hover is true
* otherwise returns the original selector
*
* @param string $selector CSS selector.
* @param bool $add_hover Whether to add hover on selector.
*
* @return string
*/
protected function _maybe_add_hover_to_selectors( $selector, $add_hover = false ) {
return $add_hover ? et_pb_hover_options()->add_hover_to_selectors( $selector ) : $selector;
}
/**
* Adds `:hover` in selector after `%%order_class%%`
* E.g: add_hover_to_order_class('%%order_class%%% .image') >>> '%%order_class%%%:hover .image'
*
* @param string $selector CSS selector.
*
* @return string
*
* @deprecated Use et_pb_hover_options()->add_hover_to_order_class( $selector );
*/
public function add_hover_to_order_class( $selector ) {
return et_pb_hover_options()->add_hover_to_order_class( $selector );
}
/**
* Adds `:hover` to order class only if is specified, in other cse returns original selector
* otherwise returns the original selector
*
* @param string $selector CSS selector.
* @param bool $add_hover Whether to add hover on selector.
*
* @return string
*/
protected function _maybe_add_hover_to_order_class( $selector, $add_hover = false ) {
return $add_hover ? et_pb_hover_options()->add_hover_to_order_class( $selector ) : $selector;
}
/**
* Convert smart quotes and & entity to their applicable characters
*
* @param string $text Input text.
*
* @return string
*/
public static function convert_smart_quotes_and_amp( $text ) {
$smart_quotes = array(
'“',
'”',
'″',
'‘',
'’',
''',
'&',
);
$replacements = array(
'"',
'"',
'"',
''',
''',
''',
'&',
);
if ( 'fr_FR' === get_locale() ) {
$french_smart_quotes = array(
' »',
'″>',
);
$french_replacements = array(
'"',
'">',
);
$smart_quotes = array_merge( $smart_quotes, $french_smart_quotes );
$replacements = array_merge( $replacements, $french_replacements );
}
$text = str_replace( $smart_quotes, $replacements, $text );
return $text;
}
/**
* Process multiple checkbox field value.
*
* @param array $value_map Checkbox value map.
* @param string $value Checkbox value.
*
* @return string
*/
public function process_multiple_checkboxes_field_value( $value_map, $value ) {
$result = array();
$index = 0;
foreach ( explode( '|', $value ) as $checkbox_value ) {
if ( 'on' === $checkbox_value ) {
$result[] = $value_map[ $index ];
}
$index++;
}
return implode( '|', $result );
}
/**
* Adds one or more CSS classes to the module on the frontend.
*
* @since 3.1
*
* @param string|array $to_add classname(s) to be added.
* @param number|bool $position position of added classname (0-based). Some class need to be placed
* at exact position. i.e. .et_pb_column_{$type} on column inner.
*/
public function add_classname( $to_add, $position = false ) {
if ( empty( $to_add ) ) {
return;
}
$classname = is_array( $to_add ) ? $to_add : array( $to_add );
if ( is_numeric( $position ) ) {
array_splice( $this->classname, intval( $position ), 0, $classname );
} else {
$this->classname = array_merge( $this->classname, $classname );
}
}
/**
* Removes one ore more CSS classes to the module on the frontend
*
* @since 3.1
*
* @param string|array $to_remove classname(s) to be removed.
*/
public function remove_classname( $to_remove ) {
$this->classname = array_filter( $this->classname );
if ( is_string( $to_remove ) && '' !== $to_remove ) {
$this->classname = array_diff( $this->classname, array( $to_remove ) );
} elseif ( is_array( $to_remove ) ) {
$to_remove = array_filter( $to_remove );
$this->classname = array_diff( $this->classname, $to_remove );
}
}
/**
* Outputs module class
*
* @param string $function_name Module slug.
*
* @since 3.1
*
* @return string escaped class
*/
public function module_classname( $function_name = '' ) {
if ( ! in_array( $function_name, self::$uses_module_classname, true ) ) {
// Add module slug to array of modules where `module_classname()` used.
self::$uses_module_classname[] = $function_name;
}
$module_name = str_replace( 'et_pb_', '', $this->slug );
/**
* Filters module classes.
*
* @since 3.1
*
* @param array $classname Array of classnames.
* @param int $render_count Number of times render function has been executed
*/
$classname = (array) array_unique( apply_filters( "et_builder_{$module_name}_classes", $this->classname, $this->render_count() ) );
return implode( ' ', array_map( 'esc_attr', $classname ) );
}
/**
* Outputs module id
*
* @since 3.1
*
* @param bool $include_attribute wrap module id with id attribute name or not (to be used directly on module div).
*
* @return string module id / module id wrapped by id attribute
*/
public function module_id( $include_attribute = true ) {
$module_id = esc_attr( $this->props['module_id'] );
$output = $include_attribute ? sprintf( ' id="%1$s"', $module_id ) : $module_id;
return '' !== $module_id ? $output : '';
}
/**
* Helper method for rendering button markup which works compatible with advanced options' button
*
* @since 3.1
*
* @param array $args button settings.
*
* @return string rendered button HTML
*/
public function render_button( $args = array() ) {
// Prepare arguments.
$defaults = array(
'button_id' => '',
'button_classname' => array(),
'button_custom' => '',
'button_rel' => '',
'button_text' => '',
'button_text_escaped' => false,
'button_url' => '',
'custom_icon' => '',
'custom_icon_tablet' => '',
'custom_icon_phone' => '',
'display_button' => true,
'has_wrapper' => true,
'url_new_window' => '',
'multi_view_data' => '',
);
$args = wp_parse_args( $args, $defaults );
// Do not proceed if display_button argument is false.
if ( ! $args['display_button'] ) {
return '';
}
$button_text = $args['button_text_escaped'] ? $args['button_text'] : esc_html( $args['button_text'] );
// Do not proceed if button_text argument is empty and not having multi view value.
if ( '' === $button_text && ! $args['multi_view_data'] ) {
return '';
}
// Button classname.
$button_classname = array( 'et_pb_button' );
if ( ( '' !== $args['custom_icon'] || '' !== $args['custom_icon_tablet'] || '' !== $args['custom_icon_phone'] ) && 'on' === $args['button_custom'] ) {
$button_classname[] = 'et_pb_custom_button_icon';
}
// Add multi view CSS hidden helper class when button text is empty on desktop mode.
if ( '' === $button_text && $args['multi_view_data'] ) {
$button_classname[] = 'et_multi_view_hidden';
}
if ( ! empty( $args['button_classname'] ) ) {
$button_classname = array_merge( $button_classname, $args['button_classname'] );
}
// Custom icon data attribute.
$use_data_icon = '' !== $args['custom_icon'] && 'on' === $args['button_custom'];
$data_icon = $use_data_icon ? sprintf(
' data-icon="%1$s"',
esc_attr( et_pb_process_font_icon( $args['custom_icon'] ) )
) : '';
$use_data_icon_tablet = '' !== $args['custom_icon_tablet'] && 'on' === $args['button_custom'];
$data_icon_tablet = $use_data_icon_tablet ? sprintf(
' data-icon-tablet="%1$s"',
esc_attr( et_pb_process_font_icon( $args['custom_icon_tablet'] ) )
) : '';
$use_data_icon_phone = '' !== $args['custom_icon_phone'] && 'on' === $args['button_custom'];
$data_icon_phone = $use_data_icon_phone ? sprintf(
' data-icon-phone="%1$s"',
esc_attr( et_pb_process_font_icon( $args['custom_icon_phone'] ) )
) : '';
// Render button.
return sprintf(
'%7$s<a%9$s class="%5$s" href="%1$s"%3$s%4$s%6$s%10$s%11$s%12$s>%2$s</a>%8$s',
esc_url( $args['button_url'] ),
et_core_esc_previously( $button_text ),
( 'on' === $args['url_new_window'] ? ' target="_blank"' : '' ),
et_core_esc_previously( $data_icon ),
esc_attr( implode( ' ', array_unique( $button_classname ) ) ), // #5
et_core_esc_previously( $this->get_rel_attributes( $args['button_rel'] ) ),
$args['has_wrapper'] ? '<div class="et_pb_button_wrapper">' : '',
$args['has_wrapper'] ? '</div>' : '',
'' !== $args['button_id'] ? sprintf( ' id="%1$s"', esc_attr( $args['button_id'] ) ) : '',
et_core_esc_previously( $data_icon_tablet ), // #10
et_core_esc_previously( $data_icon_phone ),
et_core_esc_previously( $args['multi_view_data'] )
);
}
/**
* Determine builder module is saving cache.
*
* @return mixed|void
*/
public static function is_saving_cache() {
return apply_filters( 'et_builder_modules_is_saving_cache', false );
}
/**
* Get array of attributes which have dynamic content enabled.
*
* @since 3.17.2
*
* @param mixed[] $attrs Module attributes.
*
* @return string[]
*/
protected function _get_enabled_dynamic_attributes( $attrs ) {
$enabled_dynamic_attributes = isset( $attrs['_dynamic_attributes'] ) ? $attrs['_dynamic_attributes'] : '';
$enabled_dynamic_attributes = array_filter( explode( ',', $enabled_dynamic_attributes ) );
return $enabled_dynamic_attributes;
}
/**
* Check if an attribute value is dynamic or not.
*
* @since 3.17.2
*
* @param string $attribute Attribute name.
* @param string $value Attribute value.
* @param array $enabled_dynamic_attributes Attributes which have dynamic content enabled.
*
* @return bool
*/
protected function _is_dynamic_value( $attribute, $value, $enabled_dynamic_attributes ) {
if ( ! in_array( $attribute, $enabled_dynamic_attributes, true ) ) {
return false;
}
return et_builder_parse_dynamic_content( $value )->is_dynamic();
}
/**
* Re-encode legacy dynamic content values in an attrs array.
*
* @since 3.20.2
*
* @param string[] $attrs Module attributes.
* @param string[] $enabled_dynamic_attributes Attributes which have dynamic content enabled.
*
* @return string[]
*/
protected function _encode_legacy_dynamic_content( $attrs, $enabled_dynamic_attributes ) {
if ( is_array( $attrs ) ) {
foreach ( $attrs as $field => $value ) {
$attrs[ $field ] = $this->_encode_legacy_dynamic_content_value( $field, $value, $enabled_dynamic_attributes );
}
}
return $attrs;
}
/**
* Re-encode legacy dynamic content value.
*
* @since 3.20.2
*
* @param string $field Attribute name.
* @param string $value Attribute value.
* @param array $enabled_dynamic_attributes Attributes which have dynamic content enabled.
*
* @return string
*/
protected function _encode_legacy_dynamic_content_value( $field, $value, $enabled_dynamic_attributes ) {
if ( ! in_array( $field, $enabled_dynamic_attributes, true ) ) {
return $value;
}
$json = et_builder_clean_dynamic_content( $value );
if ( preg_match( '/^@ET-DC@(.*?)@$/', $json ) ) {
return $value;
}
return $this->_resolve_value_from_json( $field, $json, $enabled_dynamic_attributes );
}
/**
* Resolve a value, be it static or dynamic to a static one.
*
* @since 3.17.2
*
* @param integer $post_id Current post id.
* @param string $field Content key.
* @param string $value Content value.
* @param string[] $enabled_dynamic_attributes Attributes which have dynamic content enabled.
* @param boolean $serialize Whether value is serializable.
*
* @return string
*/
protected function _resolve_value( $post_id, $field, $value, $enabled_dynamic_attributes, $serialize ) {
global $wp_query;
if ( ! in_array( $field, $enabled_dynamic_attributes, true ) ) {
return $value;
}
$builder_value = et_builder_parse_dynamic_content( $value );
if ( $serialize ) {
return $builder_value->serialize();
}
$is_blog_query = isset( $wp_query->et_pb_blog_query ) && $wp_query->et_pb_blog_query;
if ( ! $is_blog_query && ! $wp_query->is_singular() ) {
return $builder_value->resolve( null );
}
return $builder_value->resolve( $post_id );
}
/**
* Resolve a value from the legacy JSON format of dynamic content.
* This is essentially a migration but is implemented separately
* as it needs to parse every field of every module and do it
* before actual migrations are ran.
*
* @since 3.20.2
*
* @param string $field Field content.
* @param string $value Json value.
* @param string[] $enabled_dynamic_attributes Attributes which have dynamic content enabled.
*
* @return string
*/
protected function _resolve_value_from_json( $field, $value, $enabled_dynamic_attributes ) {
if ( ! in_array( $field, $enabled_dynamic_attributes, true ) ) {
return $value;
}
$json = et_builder_clean_dynamic_content( $value );
// Replace encoded quotes.
$json = str_replace( array( '“', '”', '″', '%22' ), '"', $json );
// Strip <p></p> artifacts from wpautop in before/after settings. Example:
// {"dynamic":true,"content":"post_title","settings":{"before":"</p>
// <h1>","after":"</h1>
// <p>"}}
// This is a rough solution implemented due to time constraints.
$json = preg_replace(
'~
("(?:before|after)":") # $1 = Anchor to the before/after settings.
(?: # Match cases where the value starts with the offending tag.
<\/?p> # The root of all evil.
[\r\n]+ # Whitespace follows the tag.
)*
(?: # Match cases where the value ends with the offending tag.
([^"]*) # $2 = The preceeding value.
[\r\n]+ # Whitespace preceedes the tag.
<\/?p> # The root of all evil.
)*
~xi',
'$1$2',
$json
);
// Remove line-breaks which break the json strings.
$json = preg_replace( '/\r|\n/', '', $json );
$json_value = et_builder_parse_dynamic_content_json( $json );
if ( null === $json_value ) {
return $value;
}
return $json_value->serialize();
}
/**
* Escape an attribute's value.
*
* @since 3.17.2
*
* @param string $attribute Attribute name.
* @param string $html 'limited', 'full', 'none'.
* @param string $predefined_value Predifined value need to escape.
*
* @return string
*/
protected function _esc_attr( $attribute, $html = 'none', $predefined_value = null ) {
$html = in_array( $html, array( 'limited', 'full' ), true ) ? $html : 'none';
$raw = isset( $this->attrs_unprocessed[ $attribute ] ) ? $this->attrs_unprocessed[ $attribute ] : '';
$formatted = isset( $this->props[ $attribute ] ) ? $this->props[ $attribute ] : '';
$dynamic_attributes = $this->_get_enabled_dynamic_attributes( $this->props );
// More often than not content is not an attribute so we need to handle that special case.
if ( 'content' === $attribute && ! isset( $this->attrs_unprocessed[ $attribute ] ) ) {
$raw = $this->content_unprocessed;
$formatted = $this->content;
}
if ( ! is_null( $predefined_value ) ) {
$formatted = $predefined_value;
}
if ( ! $this->_is_dynamic_value( $attribute, $raw, $dynamic_attributes ) ) {
if ( 'full' === $html ) {
return $formatted;
}
return esc_html( $formatted );
}
if ( 'limited' === $html ) {
return wp_kses(
$formatted,
array(
'strong' => array(
'id' => array(),
'class' => array(),
'style' => array(),
),
'em' => array(
'id' => array(),
'class' => array(),
'style' => array(),
),
'i' => array(
'id' => array(),
'class' => array(),
'style' => array(),
),
)
);
}
// Dynamic content values are escaped when they are resolved so we do not want to
// double-escape them when using them in the frontend, for example.
return et_core_esc_previously( $formatted );
}
/**
* Get the current TB layout ID if we are rendering one or the current post ID instead.
*
* @since 4.0
*
* @return integer
*/
public static function get_layout_id() {
$layout_id = self::get_theme_builder_layout_id();
$post_id = self::get_current_post_id_reverse();
return $layout_id ? $layout_id : $post_id;
}
/**
* Get the current theme builder layout.
* Returns 'default' if no layout has been started.
*
* @since 4.0
*
* @return string
*/
public static function get_theme_builder_layout_type() {
$count = count( self::$theme_builder_layout );
if ( $count > 0 ) {
return self::$theme_builder_layout[ $count - 1 ]['type'];
}
return 'default';
}
/**
* Check if a module is rendered as normal post content or theme builder layout.
*
* @since 4.0
*
* @return bool
*/
public static function is_theme_builder_layout() {
return 'default' !== self::get_theme_builder_layout_type();
}
/**
* Get the current theme builder layout id.
* Returns 0 if no layout has been started.
*
* @since 4.0
*
* @return integer
*/
public static function get_theme_builder_layout_id() {
$count = count( self::$theme_builder_layout );
if ( $count > 0 ) {
return self::$theme_builder_layout[ $count - 1 ]['id'];
}
return 0;
}
/**
* Begin a theme builder layout.
*
* @since 4.0
*
* @param integer $layout_id Layout post id.
*
* @return void
*/
public static function begin_theme_builder_layout( $layout_id ) {
$type = get_post_type( $layout_id );
if ( ! et_theme_builder_is_layout_post_type( $type ) ) {
$type = 'default';
}
self::$theme_builder_layout[] = array(
'id' => (int) $layout_id,
'type' => $type,
);
}
/**
* End the current theme builder layout.
*
* @since 4.0
*
* @return void
*/
public static function end_theme_builder_layout() {
array_pop( self::$theme_builder_layout );
}
/**
* Get the order class suffix for the current theme builder layout, if any.
*
* @since 4.0
*
* @return string
*/
protected static function _get_theme_builder_order_class_suffix() {
$layout_type = self::get_theme_builder_layout_type();
$type_map = array(
ET_THEME_BUILDER_HEADER_LAYOUT_POST_TYPE => '_tb_header',
ET_THEME_BUILDER_BODY_LAYOUT_POST_TYPE => '_tb_body',
ET_THEME_BUILDER_FOOTER_LAYOUT_POST_TYPE => '_tb_footer',
);
if ( empty( $layout_type ) || ! isset( $type_map[ $layout_type ] ) ) {
return '';
}
return $type_map[ $layout_type ];
}
/**
* Convert field name into css property name.
*
* @param string $field Field name.
*
* @return string|string[]
*/
protected function field_to_css_prop( $field ) {
return str_replace( '_', '-', $field );
}
/**
* Initialize Modules Cache.
*
* @since 3.24
*/
public static function init_cache() {
$cache = self::get_cache_filename();
if ( $cache && et_()->WPFS()->is_readable( $cache ) ) {
// Load cache.
$result = @unserialize( et_()->WPFS()->get_contents( $cache ) );
if ( false !== $result ) {
if ( count( $result ) < 3 ) {
// Old cache format detected, delete everything.
et_fb_delete_builder_assets();
if ( ! file_exists( $cache ) ) {
// If cache has been successfully deleted, then init again.
self::init_cache();
}
return;
}
list ( self::$_cache, self::$_fields_unprocessed ) = $result;
// Define option template variable instead of using list to avoid error that might
// happen when option template file exists (theme is updated) and frontend is
// accessed while static module field data hasn't been updated.
$cached_option_template_data = et_()->array_get( $result, '2', array() );
$cached_option_template = et_()->array_get( $result, '3', array() );
$cached_option_template_tab_slug_maps = et_()->array_get( $result, '4', array() );
// init_cache() is called really early. $template property might not be available yet.
if ( null === self::$option_template ) {
self::$option_template = et_pb_option_template();
}
// Set option template data from static cache if exist.
if ( is_array( $cached_option_template_data ) && ! empty( $cached_option_template_data ) ) {
self::$option_template->set_data( $cached_option_template_data );
}
// Set option template from static cache if exist.
if ( is_array( $cached_option_template ) && ! empty( $cached_option_template ) ) {
self::$option_template->set_templates( $cached_option_template );
}
// Set option template tab slug maps from static cache if exist.
if ( is_array( $cached_option_template_tab_slug_maps ) && ! empty( $cached_option_template_tab_slug_maps ) ) {
self::$option_template->set_tab_slug_map( $cached_option_template_tab_slug_maps );
}
// Box Shadow sets WP hooks internally so we gotta load it anyway -> #blame_george.
ET_Builder_Module_Fields_Factory::get( 'BoxShadow' );
} else {
// Cache couldn't be unserialized, delete the file so it will be regenerated.
@unlink( $cache );
}
} elseif ( $cache ) {
// Only save cache when a builder page is being rendered, needed because some data
// (e.g. mail provider defaults) is only generated in this case, hence saving while rendering
// a FE page or during AJAX call would result in cache missing data.
self::$_cache = array();
add_filter( 'et_builder_modules_is_saving_cache', '__return_true' );
add_action( 'et_builder_modules_loaded', array( 'ET_Builder_Element', 'save_cache' ) );
}
}
/**
* Get Modules cache file name.
*
* @param mixed $post_type When set to `false`, autodetect.
*
* @since 3.24
*
* @return bool|mixed|string
*/
public static function get_cache_filename( $post_type = false ) {
global $post, $et_builder_post_type;
$ajax_use_cache = apply_filters( 'et_builder_ajax_use_cache', false );
if ( false === $post_type ) {
if ( is_a( $post, 'WP_POST' ) ) {
$post_type = $post->post_type;
} elseif ( $ajax_use_cache ) {
// phpcs:ignore WordPress.Security.NonceVerification -- Nonce verified in the ajax request.
$post_type = et_()->array_get( $_POST, 'et_post_type', 'page' );
} elseif ( is_admin() && ! wp_doing_ajax() ) {
$post_type = 'page';
$et_builder_post_type = $post_type;
}
if ( false === $post_type ) {
return false;
}
}
$post_type = apply_filters( 'et_builder_cache_post_type', $post_type, 'modules' );
$post_type = trim( sanitize_file_name( $post_type ), '.' );
// Per language Cache due to fields data being localized.
// Use user custom locale only if admin or VB/BFB.
$lang = is_admin() || et_fb_is_enabled() ? get_user_locale() : get_locale();
$lang = trim( sanitize_file_name( $lang ), '.' );
$prefix = 'modules';
$cache = sprintf( '%s/%s', ET_Core_PageResource::get_cache_directory(), $lang );
$files = glob( sprintf( '%s/%s-%s-*.data', $cache, $prefix, $post_type ) );
$exists = is_array( $files ) && $files;
if ( $exists ) {
return $files[0];
} elseif ( $ajax_use_cache ) {
// Allowlisted AJAX requests aren't allowed to generate cache, only to use it.
return false;
}
wp_mkdir_p( $cache );
// Create uniq filename.
$uniq = str_replace( '.', '', (string) microtime( true ) );
$file = sprintf( '%s/%s-%s-%s.data', $cache, $prefix, $post_type, $uniq );
return wp_is_writable( dirname( $file ) ) ? $file : false;
}
/**
* Get Module cache file name's id.
*
* @since 3.28
*
* @param mixed $post_type When set to `false`, autodetect.
*
* @return bool|string
*/
public static function get_cache_filename_id( $post_type = false ) {
$filename = self::get_cache_filename( $post_type );
if ( ! is_string( $filename ) ) {
return false;
}
preg_match( '/(?<=-)[0-9]*(?=.data)/', $filename, $matches );
return isset( $matches[0] ) ? $matches[0] : false;
}
/**
* Save the builder module caache.
*/
public static function save_cache() {
remove_filter( 'et_builder_modules_is_saving_cache', '__return_true' );
$cache = self::get_cache_filename();
if ( $cache ) {
et_()->WPFS()->put_contents(
$cache,
serialize(
array(
self::$_cache,
self::$_fields_unprocessed,
self::$option_template->all(),
self::$option_template->templates(),
self::$option_template->get_tab_slug_map(),
'3.0',
)
)
);
}
}
/**
* Render image element HTML
*
* @since 3.27.1
*
* @param string $image_props Image data props key or actual image URL.
* @param array $image_attrs_raw List of extra image attributes.
* @param bool $echo Whether to print the image output or return it.
* @param bool $disable_responsive Whether to enable the responsive image or not.
*
* @return string The images's HTML output. Empty string on failure.
*/
protected function render_image( $image_props, $image_attrs_raw = array(), $echo = true, $disable_responsive = false ) {
// Bail early when the $image_props arg passed is empty.
if ( ! $image_props ) {
return '';
}
$img_src = $image_props && is_string( $image_props ) ? self::$_->array_get( $this->props, $image_props, $image_props ) : $image_props;
if ( ! $img_src ) {
return '';
}
if ( ! count( $image_attrs_raw ) ) {
$html = sprintf(
'<img src="%1$s" />',
esc_url( $img_src )
);
return et_image_add_srcset_and_sizes( $html, $echo );
}
$image_attrs = array();
$is_disable_responsive = $disable_responsive || ! et_is_responsive_images_enabled();
foreach ( $image_attrs_raw as $name => $value ) {
// Skip src attributes key.
if ( 'src' === $name ) {
continue;
}
// Skip srcset & sizes attributes when setting is off.
if ( $is_disable_responsive && in_array( $name, array( 'srcset', 'sizes' ), true ) ) {
continue;
}
// Skip if attributes value is empty.
if ( ! strlen( $value ) ) {
continue;
}
// Format as JSON if the value is array or object.
if ( is_array( $value ) || is_object( $value ) ) {
$value = wp_json_encode( $value );
}
// Trim extra space from attributes value.
$value = trim( $value );
// Standalone attributes that act as Booleans (Numerical indexed array keys such as required, disabled, multiple).
if ( is_numeric( $name ) ) {
$value = et_core_esc_attr( $value, $value );
if ( ! is_wp_error( $value ) ) {
$image_attrs[ $value ] = et_core_esc_previously( $value );
}
} else {
$value = et_core_esc_attr( $name, $value );
if ( ! is_wp_error( $value ) ) {
$image_attrs[ $name ] = esc_attr( $name ) . '="' . et_core_esc_previously( $value ) . '"';
}
}
}
$html = sprintf(
'<img src="%1$s" %2$s />',
esc_url( $img_src ),
et_core_esc_previously( implode( ' ', $image_attrs ) )
);
if ( ! $is_disable_responsive && ! isset( $image_attrs['srcset'] ) && ! isset( $image_attrs['sizes'] ) ) {
$html = et_image_add_srcset_and_sizes( $html, false );
}
if ( ! $echo ) {
return $html;
}
echo et_core_intentionally_unescaped( $html, 'html' );
}
/**
* Get advanced field settings exposed for layout block preview
*
* @since 4.3.2
*
* @return array
*/
public static function get_layout_block_assistive_settings() {
return self::$layout_block_assistive_settings;
}
/**
* Enqueue scroll effects fields.
*/
public static function enqueue_scroll_effects_fields() {
// Motion Effects.
wp_localize_script(
apply_filters( 'et_builder_modules_script_handle', 'et-builder-modules-script' ),
'et_pb_motion_elements',
self::$_scroll_effects_fields
);
// Sticky Elements.
wp_localize_script(
apply_filters( 'et_builder_modules_script_handle', 'et-builder-modules-script' ),
'et_pb_sticky_elements',
self::$sticky_elements
);
}
/**
* Get whether the provided element content contains at least one of the
* specified modules based on their slugs.
*
* @since 4.3.3
*
* @param string $content Element content.
* @param string[] $module_slugs Module slug to search.
*
* @return bool
*/
protected static function contains( $content, $module_slugs ) {
foreach ( $module_slugs as $slug ) {
if ( false !== strpos( $content, '[' . $slug ) ) {
return true;
}
}
return false;
}
/**
* Generate background field setting properties by template
*
* @since 4.8.0
*
* @param string $field_template Field template slug.
* @param array $overrides Field properties to override.
* @param array $unsets Field properties to unset.
*
* @return array
*/
public static function background_field_template( $field_template, $overrides = array(), $unsets = array() ) {
static $cache = null;
if ( is_null( $cache ) ) {
$cache = array();
$tabs = array(
// Tab: color, priority start with 100.
'color' => array(
'priority' => 100,
'data' => array(
'enable_color' => array(
'type' => 'skip',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'color' => array(
'type' => 'color-alpha',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
'tab_filler' => true,
),
'use_color' => array(
'type' => 'yes_no_button',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
// List of template slug that affecteds by this field.
'affects_template' => array(
'color',
),
),
),
),
// Tab: gradient, priority start with 200.
'gradient' => array(
'priority' => 200,
'data' => array(
'use_color_gradient' => array(
'type' => 'yes_no_button',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
// List of template slug that affecteds by this field.
'affects_template' => array(
'color_gradient_start',
'color_gradient_end',
'color_gradient_start_position',
'color_gradient_end_position',
'color_gradient_type',
'color_gradient_overlays_image',
),
'tab_filler' => true,
),
'color_gradient_start' => array(
'type' => 'color-alpha',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'color_gradient_end' => array(
'type' => 'color-alpha',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'color_gradient_type' => array(
'type' => 'select',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
// List of template slug that affecteds by this field.
'affects_template' => array(
'color_gradient_direction',
'color_gradient_direction_radial',
),
),
'color_gradient_direction' => array(
'type' => 'range',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'color_gradient_direction_radial' => array(
'type' => 'select',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'color_gradient_start_position' => array(
'type' => 'range',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
'option_category' => 'configuration',
),
'color_gradient_end_position' => array(
'type' => 'range',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'color_gradient_overlays_image' => array(
'type' => 'yes_no_button',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
),
),
// Tab: image, priority start with 300.
'image' => array(
'priority' => 300,
'data' => array(
'enable_image' => array(
'type' => 'skip',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'image' => array(
'type' => 'upload',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
'tab_filler' => true,
),
'parallax' => array(
'type' => 'yes_no_button',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
// List of template slug that affecteds by this field.
'affects_template' => array(
'parallax_method',
'size',
'position',
'repeat',
'blend',
),
),
'parallax_method' => array(
'type' => 'select',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'size' => array(
'type' => 'select',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'position' => array(
'type' => 'select',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'repeat' => array(
'type' => 'select',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'blend' => array(
'type' => 'select',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
),
),
// Tab: video, priority start with 400.
'video' => array(
'priority' => 400,
'data' => array(
'enable_video_mp4' => array(
'type' => 'skip',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'video_mp4' => array(
'type' => 'upload',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
'tab_filler' => true,
),
'enable_video_webm' => array(
'type' => 'skip',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'video_webm' => array(
'type' => 'upload',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
'tab_filler' => true,
),
'video_width' => array(
'type' => 'text',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'video_height' => array(
'type' => 'text',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'allow_player_pause' => array(
'type' => 'yes_no_button',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'video_pause_outside_viewport' => array(
'type' => 'yes_no_button',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
'video_computed' => array(
'type' => 'computed',
'mobile_options' => false,
'hover' => false,
'sticky' => false,
),
),
),
);
foreach ( $tabs as $background_tab_slug => $tab ) {
$priority = $tab['priority'];
foreach ( $tab['data'] as $template_slug => $template_data ) {
$template_priority = isset( $template_data['priority'] ) && is_numeric( $template_data['priority'] ) ? $template_data['priority'] : $priority;
if ( $template_priority < $tab['priority'] ) {
$template_priority += $tab['priority'];
}
$cache[ $template_slug ] = array_merge(
$template_data,
array(
'field_template' => $template_slug,
'background_tab' => $background_tab_slug,
'priority' => $template_priority,
'tab_slug' => 'general',
'toggle_slug' => 'background',
)
);
$priority += 10;
}
$priority = 0;
}
}
$template = isset( $cache[ $field_template ] ) ? $cache[ $field_template ] : array();
if ( $overrides && is_array( $overrides ) ) {
$template = array_merge( $template, $overrides );
}
if ( $unsets && is_array( $unsets ) ) {
foreach ( $unsets as $unset ) {
unset( $template[ $unset ] );
}
}
return array_merge(
$template,
array(
'field_template' => $field_template,
)
);
}
/**
* ================================================================================================================
* -------------------------->>> Class-level (static) deprecations begin here! <<<---------------------------------
* ================================================================================================================
*/
// phpcs:disable -- Deprecated functions.
/**
* @deprecated See {@see self::get_parent_slugs_regex()}
*/
public static function get_parent_shortcodes( $post_type ) {
$method = __METHOD__;
$replacement = __CLASS__ . '::get_parent_slugs_regex()';
et_error( "You're Doing It Wrong! {$method} is deprecated. Use {$replacement} instead." );
return self::get_parent_slugs_regex( $post_type );
}
/**
* @deprecated See {@see self::get_child_slugs_regex()}
*/
public static function get_child_shortcodes( $post_type ) {
$method = __METHOD__;
$replacement = __CLASS__ . '::get_child_slugs_regex()';
et_error( "You're Doing It Wrong! {$method} is deprecated. Use {$replacement} instead." );
return self::get_child_slugs_regex( $post_type );
}
/**
* Deprecated.
*
* @deprecated
*
* @param string $post_type
* @param string $mode
*
* @return array
*/
public static function get_defaults( $post_type = '', $mode = 'all' ) {
et_error( "You're Doing It Wrong! " . __METHOD__ . ' is deprecated and should not be used.' );
return array();
}
/**
* Deprecated.
*
* @deprecated
*
* @param string $post_type
* @param string $mode
*
* @return array
*/
public static function get_fields_defaults( $post_type = '', $mode = 'all' ) {
et_error( "You're Doing It Wrong! " . __METHOD__ . ' is deprecated and should not be used.' );
return array();
}
/**
* @deprecated
*/
public static function get_slugs_with_children( $post_type ) {
$parent_modules = self::get_parent_modules( $post_type );
$slugs = array();
foreach ( $parent_modules as $module ) {
if ( ! empty( $module->child_slug ) ) {
$slugs[] = sprintf( '"%1$s":"%2$s"', esc_js( $module->slug ), esc_js( $module->child_slug ) );
}
}
return '{' . implode( ',', $slugs ) . '}';
}
// phpcs:enable
/**
* ================================================================================================================
* ------------------------------->>> Non-static deprecations begin here! <<<--------------------------------------
* ================================================================================================================
*/
/**
* Determine if current request is VB Data Request by checking $_POST['action'] value
*
* @deprecated {@see et_builder_is_loading_vb_data()}
*
* @since 4.0.7 Deprecated.
*
* @return bool
*/
protected function is_loading_vb_data() {
return et_builder_is_loading_data();
}
/**
* Determine if current request is BB Data Request by checking $_POST['action'] value
*
* @deprecated {@see et_builder_is_loading_bb_data()}
*
* @since 4.0.7 Deprecated.
*
* @return bool
*/
protected function is_loading_bb_data() {
return et_builder_is_loading_data( 'bb' );
}
/* NOTE: Adding a new method? New methods should be placed BEFORE deprecated methods. */
}
do_action( 'et_pagebuilder_module_init' );
/**
* Base class for module.
*
* Class ET_Builder_Module
*/
class ET_Builder_Module extends ET_Builder_Element {}
/**
* Base class for structure elements.
*
* Class ET_Builder_Structure_Element
*/
class ET_Builder_Structure_Element extends ET_Builder_Element {
/**
* Whether element is structure element.
*
* @var bool
*/
public $is_structure_element = true;
/**
* BB :: Wrap setting option in parent div.
*
* @param string $option_output Setting options markup.
* @param array $field Setting field.
* @param string $name Setting field name e.g background_color.
*
* @return string|string[]
*/
public function wrap_settings_option( $option_output, $field, $name = '' ) {
// Option template convert array field into string id; return early to prevent error.
if ( is_string( $field ) ) {
return '';
}
$field_type = ! empty( $field['type'] ) ? $field['type'] : '';
switch ( $field_type ) {
case 'column_settings_background':
$output = $this->generate_columns_settings_background();
$field['hover'] = 'tabs';
break;
case 'column_settings_padding':
$output = $this->generate_columns_settings_padding();
break;
case 'column_settings_css_fields':
$output = $this->generate_columns_settings_css_fields();
break;
case 'column_settings_css':
$output = $this->generate_columns_settings_css();
break;
case 'column-structure':
// column structure option is not supported in BB.
return '';
break;
default:
$depends = false;
$new_depends = isset( $field['show_if'] ) || isset( $field['show_if_not'] );
if ( ! $new_depends && ( isset( $field['depends_show_if'] ) || isset( $field['depends_show_if_not'] ) ) ) {
$depends = true;
if ( isset( $field['depends_show_if_not'] ) ) {
$depends_show_if_not = is_array( $field['depends_show_if_not'] ) ? implode( ',', $field['depends_show_if_not'] ) : $field['depends_show_if_not'];
$depends_attr = sprintf( ' data-depends_show_if_not="%s"', esc_attr( $depends_show_if_not ) );
} else {
$depends_attr = sprintf( ' data-depends_show_if="%s"', esc_attr( $field['depends_show_if'] ) );
}
}
// Overriding background color's attribute, turning it into appropriate background attributes.
if ( isset( $field['type'] ) && isset( $field['name'] ) && in_array( $field['name'], array( 'background_color' ), true ) ) {
$field['type'] = 'background';
// Appending background class.
if ( isset( $field['option_class'] ) ) {
$field['option_class'] .= ' et-pb-option--background';
} else {
$field['option_class'] = 'et-pb-option--background';
}
// Removing depends default variable which hides background color for unified background field UI.
$depends = false;
if ( isset( $field['depends_show_if'] ) ) {
unset( $field['depends_show_if'] );
}
}
$output = sprintf(
'%6$s<div class="et-pb-option et-pb-option--%11$s%1$s%2$s%3$s%8$s%9$s%10$s%13$s"%4$s data-option_name="%12$s">%5$s</div>%7$s',
( ! empty( $field['type'] ) && 'tiny_mce' === $field['type'] ? ' et-pb-option-main-content' : '' ),
$depends || $new_depends ? ' et-pb-depends' : '',
( ! empty( $field['type'] ) && 'hidden' === $field['type'] ? ' et_pb_hidden' : '' ),
( $depends ? $depends_attr : '' ),
"\n\t\t\t\t" . $option_output . "\n\t\t\t",
"\t",
"\n\n\t\t",
( ! empty( $field['type'] ) && 'hidden' === $field['type'] ? esc_attr( sprintf( ' et-pb-option-%1$s', $field['name'] ) ) : '' ),
( ! empty( $field['option_class'] ) ? ' ' . $field['option_class'] : '' ),
isset( $field['specialty_only'] ) && 'yes' === $field['specialty_only'] ? ' et-pb-specialty-only-option' : '',
isset( $field['type'] ) ? esc_attr( $field['type'] ) : '',
esc_attr( $field['name'] ),
$new_depends ? ' et-pb-new-depends' : ''
);
break;
}
if ( ! empty( $field['hover'] ) ) {
if ( 'tabs' === $field['hover'] ) {
$name = ( 'columns_background' === $name ) ? 'background_color_<%= counter %>' : $name;
$this->last_hover_tab_field = $name;
}
$hover = $this->last_hover_tab_field;
if ( $hover ) {
$begin = '<div class="et-pb-option ';
$pos = strpos( $output, $begin );
if ( $pos >= 0 ) {
$output = substr_replace(
$output,
"<div data-depends_hover=\"$hover\" class=\"et-pb-option-standard et-pb-option ",
$pos,
strlen( $begin )
);
}
}
}
return self::get_unique_bb_key( $output );
}
/**
* BB :: Generate custom css values for column padding settings.
*
* @return string
*/
public function generate_column_vars_css() {
$output = '';
for ( $i = 1; $i < 4; $i++ ) {
$output .= sprintf(
'case %1$s :
current_module_id_value = typeof et_pb_module_id_%1$s !== \'undefined\' ? et_pb_module_id_%1$s : \'\',
current_module_class_value = typeof et_pb_module_class_%1$s !== \'undefined\' ? et_pb_module_class_%1$s : \'\',
current_custom_css_before_value = typeof et_pb_custom_css_before_%1$s !== \'undefined\' ? et_pb_custom_css_before_%1$s : \'\',
current_custom_css_main_value = typeof et_pb_custom_css_main_%1$s !== \'undefined\' ? et_pb_custom_css_main_%1$s : \'\',
current_custom_css_after_value = typeof et_pb_custom_css_after_%1$s !== \'undefined\' ? et_pb_custom_css_after_%1$s : \'\';
break; ',
esc_attr( $i )
);
}
return $output;
}
/**
* BB :: Generate background values for column padding settings.
*
* @return string
*/
public function generate_column_vars_bg() {
$output = '';
for ( $i = 1; $i < 4; $i++ ) {
$output .= sprintf(
'case %1$s :
current_value_bg = typeof et_pb_background_color_%1$s !== \'undefined\' ? et_pb_background_color_%1$s : \'\',
current_value_bg_img = typeof et_pb_bg_img_%1$s !== \'undefined\' ? et_pb_bg_img_%1$s : \'\';
current_background_size_cover = typeof et_pb_background_size_%1$s !== \'undefined\' && et_pb_background_size_%1$s === \'cover\' ? \' selected="selected"\' : \'\';
current_background_size_contain = typeof et_pb_background_size_%1$s !== \'undefined\' && et_pb_background_size_%1$s === \'contain\' ? \' selected="selected"\' : \'\';
current_background_size_initial = typeof et_pb_background_size_%1$s !== \'undefined\' && et_pb_background_size_%1$s === \'initial\' ? \' selected="selected"\' : \'\';
current_background_position_topleft = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'top_left\' ? \' selected="selected"\' : \'\';
current_background_position_topcenter = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'top_center\' ? \' selected="selected"\' : \'\';
current_background_position_topright = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'top_right\' ? \' selected="selected"\' : \'\';
current_background_position_centerleft = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'center_left\' ? \' selected="selected"\' : \'\';
current_background_position_center = typeof et_pb_background_position_%1$s === \'undefined\' || et_pb_background_position_%1$s === \'center\' ? \' selected="selected"\' : \'\';
current_background_position_centerright = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'center_right\' ? \' selected="selected"\' : \'\';
current_background_position_bottomleft = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'bottom_left\' ? \' selected="selected"\' : \'\';
current_background_position_bottomcenter = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'bottom_center\' ? \' selected="selected"\' : \'\';
current_background_position_bottomright = typeof et_pb_background_position_%1$s !== \'undefined\' && et_pb_background_position_%1$s === \'bottom_right\' ? \' selected="selected"\' : \'\';
current_background_repeat_repeat = typeof et_pb_background_repeat_%1$s === \'undefined\' || et_pb_background_repeat_%1$s === \'repeat\' ? \' selected="selected"\' : \'\';
current_background_repeat_repeatx = typeof et_pb_background_repeat_%1$s !== \'undefined\' && et_pb_background_repeat_%1$s === \'repeat-x\' ? \' selected="selected"\' : \'\';
current_background_repeat_repeaty = typeof et_pb_background_repeat_%1$s !== \'undefined\' && et_pb_background_repeat_%1$s === \'repeat-y\' ? \' selected="selected"\' : \'\';
current_background_repeat_space = typeof et_pb_background_repeat_%1$s !== \'undefined\' && et_pb_background_repeat_%1$s === \'space\' ? \' selected="selected"\' : \'\';
current_background_repeat_round = typeof et_pb_background_repeat_%1$s !== \'undefined\' && et_pb_background_repeat_%1$s === \'round\' ? \' selected="selected"\' : \'\';
current_background_repeat_norepeat = typeof et_pb_background_repeat_%1$s !== \'undefined\' && et_pb_background_repeat_%1$s === \'no-repeat\' ? \' selected="selected"\' : \'\';
current_background_blend_normal = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'normal\' ? \' selected="selected"\' : \'\';
current_background_blend_multiply = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'multiply\' ? \' selected="selected"\' : \'\';
current_background_blend_screen = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'screen\' ? \' selected="selected"\' : \'\';
current_background_blend_overlay = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'overlay\' ? \' selected="selected"\' : \'\';
current_background_blend_darken = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'darken\' ? \' selected="selected"\' : \'\';
current_background_blend_lighten = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'lighten\' ? \' selected="selected"\' : \'\';
current_background_blend_colordodge = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'color-dodge\' ? \' selected="selected"\' : \'\';
current_background_blend_colorburn = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'color-burn\' ? \' selected="selected"\' : \'\';
current_background_blend_hardlight = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'hard-light\' ? \' selected="selected"\' : \'\';
current_background_blend_softlight = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'soft-light\' ? \' selected="selected"\' : \'\';
current_background_blend_difference = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'difference\' ? \' selected="selected"\' : \'\';
current_background_blend_exclusion = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'hue\' ? \' selected="selected"\' : \'\';
current_background_blend_hue = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'saturation\' ? \' selected="selected"\' : \'\';
current_background_blend_saturation = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'color\' ? \' selected="selected"\' : \'\';
current_background_blend_color = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'normal\' ? \' selected="selected"\' : \'\';
current_background_blend_luminosity = typeof et_pb_background_blend_%1$s !== \'undefined\' && et_pb_background_blend_%1$s === \'luminosity\' ? \' selected="selected"\' : \'\';
current_use_background_color_gradient = typeof et_pb_use_background_color_gradient_%1$s !== \'undefined\' && \'on\' === et_pb_use_background_color_gradient_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_start = typeof et_pb_background_color_gradient_start_%1$s !== \'undefined\' ? et_pb_background_color_gradient_start_%1$s : \'%2$s\';
current_background_color_gradient_end = typeof et_pb_background_color_gradient_end_%1$s !== \'undefined\' ? et_pb_background_color_gradient_end_%1$s : \'%3$s\';
current_background_color_gradient_type = typeof et_pb_background_color_gradient_type_%1$s !== \'undefined\' && \'radial\' === et_pb_background_color_gradient_type_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction = typeof et_pb_background_color_gradient_direction_%1$s !== \'undefined\' ? et_pb_background_color_gradient_direction_%1$s : \'%4$s\';
current_background_color_gradient_direction_radial_center = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'center\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_top_left = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'top left\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_top = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'top\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_top_right = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'top right\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_right = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'right\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_bottom_right = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'bottom right\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_bottom = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'bottom\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_bottom_left = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'bottom left\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_direction_radial_left = typeof et_pb_background_color_gradient_direction_radial_%1$s !== \'undefined\' && \'left\' === et_pb_background_color_gradient_direction_radial_%1$s ? \' selected="selected"\' : \'\';
current_background_color_gradient_start_position = typeof et_pb_background_color_gradient_start_position_%1$s !== \'undefined\' ? et_pb_background_color_gradient_start_position_%1$s : \'%5$s\';
current_background_color_gradient_end_position = typeof et_pb_background_color_gradient_end_position_%1$s !== \'undefined\' ? et_pb_background_color_gradient_end_position_%1$s : \'%6$s\';
current_background_color_gradient_overlays_image = typeof et_pb_background_color_gradient_overlays_image_%1$s !== \'undefined\' && \'on\' === et_pb_background_color_gradient_overlays_image_%1$s ? \' selected="selected"\' : \'\';
current_background_video_mp4 = typeof et_pb_background_video_mp4_%1$s !== \'undefined\' ? et_pb_background_video_mp4_%1$s : \'\';
current_background_video_webm = typeof et_pb_background_video_webm_%1$s !== \'undefined\' ? et_pb_background_video_webm_%1$s : \'\';
current_background_video_width = typeof et_pb_background_video_width_%1$s !== \'undefined\' ? et_pb_background_video_width_%1$s : \'\';
current_background_video_height = typeof et_pb_background_video_height_%1$s !== \'undefined\' ? et_pb_background_video_height_%1$s : \'\';
current_allow_played_pause = typeof et_pb_allow_player_pause_%1$s !== \'undefined\' && \'on\' === et_pb_allow_player_pause_%1$s ? \' selected="selected"\' : \'\';
current_background_video_pause_outside_viewport = typeof et_pb_background_video_pause_outside_viewport_%1$s !== \'undefined\' && \'off\' === et_pb_background_video_pause_outside_viewport_%1$s ? \' selected="selected"\' : \'\';
current_value_parallax = typeof et_pb_parallax_%1$s !== \'undefined\' && \'on\' === et_pb_parallax_%1$s ? \' selected="selected"\' : \'\';
current_value_parallax_method = typeof et_pb_parallax_method_%1$s !== \'undefined\' && \'on\' !== et_pb_parallax_method_%1$s ? \' selected="selected"\' : \'\';
break; ',
esc_attr( $i ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_start' ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_end' ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_direction' ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_start_position' ) ), // #5
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_end_position' ) )
);
}
return $output;
}
/**
* BB :: Generate Padding values for column padding settings.
*
* @return string
*/
public function generate_column_vars_padding() {
$output = '';
for ( $i = 1; $i < 4; $i++ ) {
$output .= sprintf(
'case %1$s :
current_value_pt = typeof et_pb_padding_top_%1$s !== \'undefined\' ? et_pb_padding_top_%1$s : \'\',
current_value_pr = typeof et_pb_padding_right_%1$s !== \'undefined\' ? et_pb_padding_right_%1$s : \'\',
current_value_pb = typeof et_pb_padding_bottom_%1$s !== \'undefined\' ? et_pb_padding_bottom_%1$s : \'\',
current_value_pl = typeof et_pb_padding_left_%1$s !== \'undefined\' ? et_pb_padding_left_%1$s : \'\',
current_value_padding_tablet = typeof et_pb_padding_%1$s_tablet !== \'undefined\' ? et_pb_padding_%1$s_tablet : \'\',
current_value_padding_phone = typeof et_pb_padding_%1$s_phone !== \'undefined\' ? et_pb_padding_%1$s_phone : \'\',
last_edited_padding_field = typeof et_pb_padding_%1$s_last_edited !== \'undefined\' ? et_pb_padding_%1$s_last_edited : \'\',
has_tablet_padding = typeof et_pb_padding_%1$s_tablet !== \'undefined\' ? \'yes\' : \'no\',
has_phone_padding = typeof et_pb_padding_%1$s_phone !== \'undefined\' ? \'yes\' : \'no\';
break; ',
esc_attr( $i )
);
}
return $output;
}
/**
* BB :: Generate Background settings for columns.
*
* @return string
*/
public function generate_columns_settings_background() {
$output = sprintf(
'<%% var columns = typeof columns_layout !== \'undefined\' ? columns_layout.split(",") : [],
counter = 1;
_.each( columns, function ( column_type ) {
var current_value_bg,
current_value_bg_img,
current_value_parallax,
current_value_parallax_method,
current_background_size_cover,
current_background_size_contain,
current_background_size_initial,
current_background_position_topleft,
current_background_position_topcenter,
current_background_position_topright,
current_background_position_centerleft,
current_background_position_center,
current_background_position_centerright,
current_background_position_bottomleft,
current_background_position_bottomcenter,
current_background_position_bottomright,
current_background_repeat_repeat,
current_background_repeat_repeatx,
current_background_repeat_repeaty,
current_background_repeat_space,
current_background_repeat_round,
current_background_repeat_norepeat,
current_background_blend_normal,
current_background_blend_multiply,
current_background_blend_screen,
current_background_blend_overlay,
current_background_blend_darken,
current_background_blend_lighten,
current_background_blend_colordodge,
current_background_blend_colorburn,
current_background_blend_hardlight,
current_background_blend_softlight,
current_background_blend_difference,
current_background_blend_exclusion,
current_background_blend_hue,
current_background_blend_saturation,
current_background_blend_color,
current_background_blend_luminosity,
current_use_background_color_gradient,
current_background_color_gradient_start,
current_background_color_gradient_end,
current_background_color_gradient_type,
current_background_color_gradient_direction,
current_background_color_gradient_direction_radial_center,
current_background_color_gradient_direction_radial_top_left,
current_background_color_gradient_direction_radial_top,
current_background_color_gradient_direction_radial_top_right,
current_background_color_gradient_direction_radial_right,
current_background_color_gradient_direction_radial_bottom_right,
current_background_color_gradient_direction_radial_bottom,
current_background_color_gradient_direction_radial_bottom_left,
current_background_color_gradient_direction_radial_left,
current_background_color_gradient_start_position,
current_background_color_gradient_end_position,
current_background_color_gradient_overlays_image,
current_background_video_mp4,
current_background_video_webm,
current_background_video_width,
current_background_video_height,
current_allow_played_pause,
current_background_video_pause_outside_viewport;
switch ( counter ) {
%1$s
}
%%>',
$this->generate_column_vars_bg()
);
$tab_navs = sprintf(
'<ul class="et_pb_background-tab-navs">
<li>
<a href="#" class="et_pb_background-tab-nav et_pb_background-tab-nav--color" data-tab="color" title="%1$s">
%5$s
</a>
</li><li>
<a href="#" class="et_pb_background-tab-nav et_pb_background-tab-nav--gradient" data-tab="gradient" title="%2$s">
%6$s
</a>
</li><li>
<a href="#" class="et_pb_background-tab-nav et_pb_background-tab-nav--image" data-tab="image" title="%3$s">
%7$s
</a>
</li><li>
<a href="#" class="et_pb_background-tab-nav et_pb_background-tab-nav--video" data-tab="video" title="%4$s">
%8$s
</a>
</li>
</ul>',
et_builder_i18n( 'Color' ),
esc_html__( 'Gradient', 'et_builder' ),
et_builder_i18n( 'Image' ),
esc_html__( 'Video', 'et_builder' ),
$this->get_icon( 'background-color' ),
$this->get_icon( 'background-gradient' ),
$this->get_icon( 'background-image' ),
$this->get_icon( 'background-video' )
);
$tab_color = sprintf(
'<div class="et_pb_background-tab et_pb_background-tab--color" data-tab="color">
<div class="et_pb_background-option et_pb_background-option--background_color et-pb-option et-pb-option--background_color et-pb-option--has-preview">
<label for="et_pb_background_color">%1$s: </label>
<div class="et-pb-option-container et-pb-option-container--color-alpha">
<div class="et-pb-option-preview et-pb-option-preview--empty">
<button class="et-pb-option-preview-button et-pb-option-preview-button--add">
%2$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--edit">
%3$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--delete">
%4$s
</button>
</div>
<input id="et_pb_background_color_<%%= counter %%>" class="et-pb-color-picker-hex et-pb-color-picker-hex-alpha et-pb-color-picker-hex-has-preview" type="text" data-alpha="true" placeholder="%5$s" data-selected-value="" value="<%%= current_value_bg %%>">
</div>
</div>
</div>',
esc_html__( 'Background Color', 'et_builder' ),
$this->get_icon( 'add' ),
$this->get_icon( 'setting' ),
$this->get_icon( 'delete' ),
esc_html__( 'Hex Value', 'et_builder' )
);
$tab_gradient = sprintf(
'<div class="et_pb_background-tab et_pb_background-tab--gradient" data-tab="gradient">
<div class="et-pb-option-preview et-pb-option-preview--empty">
<button class="et-pb-option-preview-button et-pb-option-preview-button--add">
%1$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--swap">
%2$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--delete">
%3$s
</button>
</div>
<div class="et_pb_background-option et_pb_background-option--use_background_color_gradient et_pb_background-template--use_color_gradient et-pb-option et-pb-option--use_background_color_gradient">
<label for="et_pb_use_background_color_gradient_<%%= counter %%>">%4$s: </label>
<div class="et-pb-option-container et-pb-option-container--yes_no_button">
<div class="et_pb_yes_no_button_wrapper ">
<div class="et_pb_yes_no_button et_pb_off_state">
<span class="et_pb_value_text et_pb_on_value">%5$s</span>
<span class="et_pb_button_slider"></span>
<span class="et_pb_value_text et_pb_off_value">%6$s</span>
</div>
<select name="et_pb_use_background_color_gradient_<%%= counter %%>" id="et_pb_use_background_color_gradient_<%%= counter %%>" class="et-pb-main-setting regular-text et-pb-affects" data-affects="background_color_gradient_start_<%%= counter %%>, background_color_gradient_end_<%%= counter %%>, background_color_gradient_start_position_<%%= counter %%>, background_color_gradient_end_position_<%%= counter %%>, background_color_gradient_type_<%%= counter %%>, background_color_gradient_overlays_image_<%%= counter %%>" data-default="off">
<option value="off">%6$s</option>
<option value="on" <%%= current_use_background_color_gradient %%>>%5$s</option>
</select>
</div><span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_start et_pb_background-template--color_gradient_start et-pb-option et-pb-option--background_color_gradient_start" data-depends_show_if="on">
<label for="et_pb_background_color_gradient_start_<%%= counter %%>">%7$s: </label>
<div class="et-pb-option-container et-pb-option-container--color-alpha">
<div class="wp-picker-container">
<input id="et_pb_background_color_gradient_start_<%%= counter %%>" class="et-pb-color-picker-hex et-pb-color-picker-hex-alpha et-pb-main-setting" type="text" data-alpha="true" placeholder="%8$s" data-selected-value="<%%= current_background_color_gradient_start %%>" value="<%%= current_background_color_gradient_start %%>" data-default-color="%26$s" data-default="%26$s">
</div>
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_end et_pb_background-template--color_gradient_end et-pb-option et-pb-option--background_color_gradient_end" data-depends_show_if="on">
<label for="et_pb_background_color_gradient_end_<%%= counter %%>">%9$s: </label>
<div class="et-pb-option-container et-pb-option-container--color-alpha">
<div class="wp-picker-container">
<input id="et_pb_background_color_gradient_end_<%%= counter %%>" class="et-pb-color-picker-hex et-pb-color-picker-hex-alpha et-pb-main-setting" type="text" data-alpha="true" placeholder="%8$s" data-selected-value="<%%= current_background_color_gradient_end %%>" value="<%%= current_background_color_gradient_end %%>" data-default-color="%27$s" data-default="%27$s">
</div>
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_type et_pb_background-template--color_gradient_type et-pb-option et-pb-option--background_color_gradient_type" data-depends_show_if="on">
<label for="et_pb_background_color_gradient_type_<%%= counter %%>">%10$s: </label>
<div class="et-pb-option-container et-pb-option-container--select">
<select name="et_pb_background_color_gradient_type_<%%= counter %%>" id="et_pb_background_color_gradient_type_<%%= counter %%>" class="et-pb-main-setting et-pb-affects" data-affects="background_color_gradient_direction_<%%= counter %%>, background_color_gradient_direction_radial_<%%= counter %%>" data-default="linear">
<option value="linear">%11$s</option>
<option value="radial" <%%= current_background_color_gradient_type %%>>%12$s</option>
</select>
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_direction et_pb_background-template--color_gradient_direction et-pb-option et-pb-option--background_color_gradient_direction" data-depends_show_if="linear">
<label for="et_pb_background_color_gradient_direction_<%%= counter %%>">%13$s: </label>
<div class="et-pb-option-container et-pb-option-container--range">
<input type="range" class="et-pb-main-setting et-pb-range et-pb-fixed-range" data-default="180" value="<%%= current_background_color_gradient_direction %%>" min="0" max="360" step="1">
<input id="et_pb_background_color_gradient_direction_<%%= counter %%>" type="text" class="regular-text et-pb-validate-unit et-pb-range-input" value="<%%= current_background_color_gradient_direction %%>" data-default="180deg">
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_direction_radial et_pb_background-template--color_gradient_direction_radial et-pb-option et-pb-option--background_color_gradient_direction_radial" data-depends_show_if="radial">
<label for="et_pb_background_color_gradient_direction_radial_<%%= counter %%>">%14$s: </label>
<div class="et-pb-option-container et-pb-option-container--select">
<select name="et_pb_background_color_gradient_direction_radial_<%%= counter %%>" id="et_pb_background_color_gradient_direction_radial_<%%= counter %%>" class="et-pb-main-setting" data-default="center">
<option value="center" <%%= current_background_color_gradient_direction_radial_center %%>>%15$s</option>
<option value="top left" <%%= current_background_color_gradient_direction_radial_top_left %%>>%16$s</option>
<option value="top" <%%= current_background_color_gradient_direction_radial_top %%>>%17$s</option>
<option value="top right" <%%= current_background_color_gradient_direction_radial_top_right %%>>%18$s</option>
<option value="right" <%%= current_background_color_gradient_direction_radial_right %%>>%19$s</option>
<option value="bottom right" <%%= current_background_color_gradient_direction_radial_bottom_right %%>>%20$s</option>
<option value="bottom" <%%= current_background_color_gradient_direction_radial_bottom %%>>%21$s</option>
<option value="bottom left" <%%= current_background_color_gradient_direction_radial_bottom_left %%>>%22$s</option>
<option value="left" <%%= current_background_color_gradient_direction_radial_left %%>>%23$s</option>
</select>
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_start_position et_pb_background-template--color_gradient_start_position et-pb-option et-pb-option--background_color_gradient_start_position" data-depends_show_if="on">
<label for="et_pb_background_color_gradient_start_position_<%%= counter %%>">%24$s: </label>
<div class="et-pb-option-container et-pb-option-container--range">
<input type="range" class="et-pb-main-setting et-pb-range et-pb-fixed-range" data-default="0" value="<%%= parseInt( current_background_color_gradient_start_position.trim() ) %%>" min="0" max="100" step="1">
<input id="et_pb_background_color_gradient_start_position_<%%= counter %%>" type="text" class="regular-text et-pb-validate-unit et-pb-range-input" value="<%%= current_background_color_gradient_start_position %%>" data-default="0%%">
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_end_position et_pb_background-template--color_gradient_end_position et-pb-option et-pb-option--background_color_gradient_end_position" data-depends_show_if="on">
<label for="et_pb_background_color_gradient_end_position_<%%= counter %%>">%25$s: </label>
<div class="et-pb-option-container et-pb-option-container--range">
<input type="range" class="et-pb-main-setting et-pb-range et-pb-fixed-range" data-default="100" value="<%%= parseInt( current_background_color_gradient_end_position.trim() ) %%>" min="0" max="100" step="1">
<input id="et_pb_background_color_gradient_end_position_<%%= counter %%>" type="text" class="regular-text et-pb-validate-unit et-pb-range-input" value="<%%= current_background_color_gradient_end_position %%>" data-default="100%%">
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_color_gradient_overlays_image et_pb_background-template--use_color_gradient et-pb-option et-pb-option--background_color_gradient_overlays_image">
<label for="et_pb_background_color_gradient_overlays_image_<%%= counter %%>">%35$s: </label>
<div class="et-pb-option-container et-pb-option-container--yes_no_button">
<div class="et_pb_yes_no_button_wrapper ">
<div class="et_pb_yes_no_button et_pb_off_state">
<span class="et_pb_value_text et_pb_on_value">%5$s</span>
<span class="et_pb_button_slider"></span>
<span class="et_pb_value_text et_pb_off_value">%6$s</span>
</div>
<select name="et_pb_background_color_gradient_overlays_image_<%%= counter %%>" id="et_pb_background_color_gradient_overlays_image_<%%= counter %%>" class="et-pb-main-setting regular-text" data-depends_show_if="on" data-default="off">
<option value="off">%6$s</option>
<option value="on" <%%= current_background_color_gradient_overlays_image %%>>%5$s</option>
</select>
</div><span class="et-pb-reset-setting"></span>
</div>
</div>
</div>',
$this->get_icon( 'add' ),
$this->get_icon( 'swap' ),
$this->get_icon( 'delete' ),
esc_html__( 'Background Gradient', 'et_builder' ),
et_builder_i18n( 'On' ), // #5
et_builder_i18n( 'Off' ),
esc_html__( 'Gradient Start', 'et_builder' ),
esc_html__( 'Hex Value', 'et_builder' ),
esc_html__( 'Gradient End', 'et_builder' ),
esc_html__( 'Gradient Type', 'et_builder' ), // #10
et_builder_i18n( 'Linear' ),
et_builder_i18n( 'Radial' ),
esc_html__( 'Gradient Direction', 'et_builder' ),
esc_html__( 'Radial Direction', 'et_builder' ),
et_builder_i18n( 'Center' ), // #15
et_builder_i18n( 'Top Left' ),
et_builder_i18n( 'Top' ),
et_builder_i18n( 'Top Right' ),
et_builder_i18n( 'Right' ),
et_builder_i18n( 'Bottom Right' ), // #20
et_builder_i18n( 'Bottom' ),
et_builder_i18n( 'Bottom Left' ),
et_builder_i18n( 'Left' ),
esc_html__( 'Start Position', 'et_builder' ),
esc_html__( 'End Position', 'et_builder' ), // #25
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_start' ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_end' ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_type' ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_direction' ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_direction_radial' ) ), // #30
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_start_position' ) ),
esc_attr( intval( ET_Global_Settings::get_value( 'all_background_gradient_start_position' ) ) ),
esc_attr( ET_Global_Settings::get_value( 'all_background_gradient_end_position' ) ),
esc_attr( intval( ET_Global_Settings::get_value( 'all_background_gradient_end_position' ) ) ),
esc_html__( 'Place Gradient Above Background Image', 'et_builder' ) // #35
);
$select_background_size = sprintf(
'<select name="et_pb_background_size_<%%= counter %%>" id="et_pb_background_size_<%%= counter %%>" class="et-pb-main-setting" data-default="cover">
<option value="cover"<%%= current_background_size_cover %%>>%1$s</option>
<option value="contain"<%%= current_background_size_contain %%>>%2$s</option>
<option value="initial"<%%= current_background_size_initial %%>>%3$s</option>
</select>',
esc_html__( 'Cover', 'et_builder' ),
esc_html__( 'Fit', 'et_builder' ),
esc_html__( 'Actual Size', 'et_builder' )
);
$select_background_position = sprintf(
'<select name="et_pb_background_position_<%%= counter %%>" id="et_pb_background_position_<%%= counter %%>" class="et-pb-main-setting" data-default="center">
<option value="top_left"<%%= current_background_position_topleft %%>>%1$s</option>
<option value="top_center"<%%= current_background_position_topcenter %%>>%2$s</option>
<option value="top_right"<%%= current_background_position_topright %%>>%3$s</option>
<option value="center_left"<%%= current_background_position_centerleft %%>>%4$s</option>
<option value="center"<%%= current_background_position_center %%>>%5$s</option>
<option value="center_right"<%%= current_background_position_centerright %%>>%6$s</option>
<option value="bottom_left"<%%= current_background_position_bottomleft %%>>%7$s</option>
<option value="bottom_center"<%%= current_background_position_bottomcenter %%>>%8$s</option>
<option value="bottom_right"<%%= current_background_position_bottomright %%>>%9$s</option>
</select>',
et_builder_i18n( 'Top Left' ),
et_builder_i18n( 'Top Center' ),
et_builder_i18n( 'Top Right' ),
et_builder_i18n( 'Center Left' ),
et_builder_i18n( 'Center' ),
et_builder_i18n( 'Center Right' ),
et_builder_i18n( 'Bottom Left' ),
et_builder_i18n( 'Bottom Center' ),
et_builder_i18n( 'Bottom Right' )
);
$select_background_repeat = sprintf(
'<select name="et_pb_background_repeat_<%%= counter %%>" id="et_pb_background_repeat_<%%= counter %%>" class="et-pb-main-setting" data-default="repeat">
<option value="no-repeat"<%%= current_background_repeat_norepeat %%>>%1$s</option>
<option value="repeat"<%%= current_background_repeat_repeat %%>>%2$s</option>
<option value="repeat-x"<%%= current_background_repeat_repeatx %%>>%3$s</option>
<option value="repeat-y"<%%= current_background_repeat_repeaty %%>>%4$s</option>
<option value="space"<%%= current_background_repeat_space %%>>%5$s</option>
<option value="round"<%%= current_background_repeat_round %%>>%6$s</option>
</select>',
esc_html__( 'No Repeat', 'et_builder' ),
esc_html__( 'Repeat', 'et_builder' ),
esc_html__( 'Repeat X (horizontal)', 'et_builder' ),
esc_html__( 'Repeat Y (vertical)', 'et_builder' ),
et_builder_i18n( 'Space' ),
esc_html__( 'Round', 'et_builder' )
);
$select_background_blend = sprintf(
'<select name="et_pb_background_blend_<%%= counter %%>" id="et_pb_background_blend_<%%= counter %%>" class="et-pb-main-setting" data-default="normal">
<option value="normal"<%%= current_background_blend_normal %%>>%1$s</option>
<option value="multiply"<%%= current_background_blend_multiply %%>>%2$s</option>
<option value="screen"<%%= current_background_blend_screen %%>>%3$s</option>
<option value="overlay"<%%= current_background_blend_overlay %%>>%4$s</option>
<option value="darken"<%%= current_background_blend_darken %%>>%5$s</option>
<option value="lighten"<%%= current_background_blend_lighten %%>>%6$s</option>
<option value="color-dodge"<%%= current_background_blend_colordodge %%>>%7$s</option>
<option value="color-burn"<%%= current_background_blend_colorburn %%>>%8$s</option>
<option value="hard-light"<%%= current_background_blend_hardlight %%>>%9$s</option>
<option value="soft-light"<%%= current_background_blend_softlight %%>>%10$s</option>
<option value="difference"<%%= current_background_blend_difference %%>>%11$s</option>
<option value="exclusion"<%%= current_background_blend_exclusion %%>>%12$s</option>
<option value="hue"<%%= current_background_blend_hue %%>>%13$s</option>
<option value="saturation"<%%= current_background_blend_saturation %%>>%14$s</option>
<option value="color"<%%= current_background_blend_color %%>>%15$s</option>
<option value="luminosity"<%%= current_background_blend_luminosity %%>>%16$s</option>
</select>',
et_builder_i18n( 'Normal' ),
et_builder_i18n( 'Multiply' ),
et_builder_i18n( 'Screen' ),
et_builder_i18n( 'Overlay' ),
et_builder_i18n( 'Darken' ),
et_builder_i18n( 'Lighten' ),
et_builder_i18n( 'Color Dodge' ),
et_builder_i18n( 'Color Burn' ),
et_builder_i18n( 'Hard Light' ),
et_builder_i18n( 'Soft Light' ),
et_builder_i18n( 'Difference' ),
et_builder_i18n( 'Exclusion' ),
et_builder_i18n( 'Hue' ),
et_builder_i18n( 'Saturation' ),
et_builder_i18n( 'Color' ),
et_builder_i18n( 'Luminosity' )
);
$tab_image = sprintf(
'<div class="et_pb_background-tab et_pb_background-tab--image" data-tab="image">
<div class="et_pb_background-option et_pb_background-option--background_image et-pb-option et-pb-option--background_image et-pb-option--has-preview">
<label for="et_pb_bg_img_<%%= counter %%>">%1$s: </label>
<div class="et-pb-option-container et-pb-option-container--upload">
<div class="et-pb-option-preview et-pb-option-preview--empty">
<button class="et-pb-option-preview-button et-pb-option-preview-button--add">
%2$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--edit">
%3$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--delete">
%4$s
</button>
</div>
<input id="et_pb_bg_img_<%%= counter %%>" type="text" class="et-pb-main-setting regular-text et-pb-upload-field" value="<%%= current_value_bg_img %%>">
<input type="button" class="button button-upload et-pb-upload-button" value="%5$s" data-choose="%6$s" data-update="%7$s" data-type="image">
<span class="et-pb-reset-setting" style="display: none;"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--parallax et_pb_background-template--parallax et-pb-option et-pb-option--parallax">
<label for="et_pb_parallax_<%%= counter %%>">%8$s: </label>
<div class="et-pb-option-container et-pb-option-container--yes_no_button">
<div class="et_pb_yes_no_button_wrapper ">
<div class="et_pb_yes_no_button et_pb_off_state">
<span class="et_pb_value_text et_pb_on_value">%9$s</span>
<span class="et_pb_button_slider"></span>
<span class="et_pb_value_text et_pb_off_value">%10$s</span>
</div>
<select name="et_pb_parallax_<%%= counter %%>" id="et_pb_parallax_<%%= counter %%>" class="et-pb-main-setting regular-text et-pb-affects" data-affects="parallax_method_<%%= counter %%>, background_size_<%%= counter %%>, background_position_<%%= counter %%>, background_repeat_<%%= counter %%>, background_blend_<%%= counter %%>" data-default="off">
<option value="off">%10$s</option>
<option value="on" <%%= current_value_parallax %%>>%9$s</option>
</select>
</div><span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--parallax_method et_pb_background-template--parallax_method et-pb-option et-pb-option--parallax_method" data-depends_show_if="on">
<label for="et_pb_parallax_method_<%%= counter %%>">%11$s: </label>
<div class="et-pb-option-container et-pb-option-container--select">
<select name="et_pb_parallax_method_<%%= counter %%>" id="et_pb_parallax_method_<%%= counter %%>" class="et-pb-main-setting" data-default="on">
<option value="on">%12$s</option>
<option value="off" <%%= current_value_parallax_method %%>>%13$s</option>
</select>
<span class="et-pb-reset-setting" style="display: none;"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_size et_pb_background-template--size et-pb-option et-pb-option--background_size" data-depends_show_if="off" data-option_name="background_size">
<label for="et_pb_background_size">%14$s:</label>
<div class="et-pb-option-container et-pb-option-container--select">
%15$s
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_position et_pb_background-template--position et-pb-option et-pb-option--background_position" data-depends_show_if="off" data-option_name="background_position">
<label for="et_pb_background_position">%16$s:</label>
<div class="et-pb-option-container et-pb-option-container--select">
%17$s
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_repeat et_pb_background-template--repeat et-pb-option et-pb-option--background_repeat" data-depends_show_if="off" data-option_name="background_repeat">
<label for="et_pb_background_repeat">%18$s:</label>
<div class="et-pb-option-container et-pb-option-container--select">
%19$s
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_blend et_pb_background-template--blend et-pb-option et-pb-option--background_blend" data-depends_show_if="off" data-option_name="background_blend">
<label for="et_pb_background_blend">%20$s: </label>
<div class="et-pb-option-container et-pb-option-container--select">
%21$s
</div>
</div>
</div>',
esc_html__( 'Background Image', 'et_builder' ),
$this->get_icon( 'add' ),
$this->get_icon( 'setting' ),
$this->get_icon( 'delete' ),
et_builder_i18n( 'Upload an image' ), // #5
esc_html__( 'Choose a Background Image', 'et_builder' ),
esc_html__( 'Set As Background', 'et_builder' ),
esc_html__( 'Use Parallax Effect', 'et_builder' ),
et_builder_i18n( 'On' ),
et_builder_i18n( 'Off' ), // #10
esc_html__( 'Parallax Method', 'et_builder' ),
esc_html__( 'True Parallax', 'et_builder' ),
esc_html__( 'CSS', 'et_builder' ),
esc_html__( 'Background Image Size', 'et_builder' ),
$select_background_size, // #15
esc_html__( 'Background Image Position', 'et_builder' ),
$select_background_position,
esc_html__( 'Background Image Repeat', 'et_builder' ),
$select_background_repeat,
esc_html__( 'Background Image Blend', 'et_builder' ), // #20
$select_background_blend
);
$tab_video = sprintf(
'<div class="et_pb_background-tab et_pb_background-tab--video" data-tab="video">
<div class="et_pb_background-option et_pb_background-option--background_video_mp4 et_pb_background-template--video_mp4 et-pb-option et-pb-option--background_video_mp4 et-pb-option--has-preview">
<label for="et_pb_background_video_mp4_<%%= counter %%>">%1$s: </label>
<div class="et-pb-option-container et-pb-option-container--upload">
<div class="et-pb-option-preview et-pb-option-preview--empty">
<button class="et-pb-option-preview-button et-pb-option-preview-button--add">
%2$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--edit">
%3$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--delete">
%4$s
</button>
</div>
<input id="et_pb_background_video_mp4_<%%= counter %%>" type="text" class="et-pb-main-setting regular-text et-pb-upload-field" value="<%%= current_background_video_mp4 %%>">
<input type="button" class="button button-upload et-pb-upload-button" value="%5$s" data-choose="%6$s" data-update="%7$s" data-type="video">
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_video_webm et_pb_background-template--video_webm et-pb-option et-pb-option--background_video_webm et-pb-option--has-preview">
<label for="et_pb_background_video_webm_<%%= counter %%>">%8$s: </label>
<div class="et-pb-option-container et-pb-option-container--upload">
<div class="et-pb-option-preview et-pb-option-preview--empty">
<button class="et-pb-option-preview-button et-pb-option-preview-button--add">
%2$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--edit">
%3$s
</button>
<button class="et-pb-option-preview-button et-pb-option-preview-button--delete">
%4$s
</button>
</div>
<input id="et_pb_background_video_webm_<%%= counter %%>" type="text" class="et-pb-main-setting regular-text et-pb-upload-field" value="<%%= current_background_video_webm %%>">
<input type="button" class="button button-upload et-pb-upload-button" value="%5$s" data-choose="%9$s" data-update="%7$s" data-type="video">
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_video_width et_pb_background-template--video_width et-pb-option et-pb-option--background_video_width">
<label for="et_pb_background_video_width_<%%= counter %%>">%10$s: </label>
<div class="et-pb-option-container et-pb-option-container--text">
<input id="et_pb_background_video_width_<%%= counter %%>" type="text" class="regular-text et-pb-main-setting" value="<%%= current_background_video_width %%>">
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_video_height et_pb_background-template--video_height et-pb-option et-pb-option--background_video_height">
<label for="et_pb_background_video_height_<%%= counter %%>">%11$s: </label>
<div class="et-pb-option-container et-pb-option-container--text">
<input id="et_pb_background_video_height_<%%= counter %%>" type="text" class="regular-text et-pb-main-setting" value="<%%= current_background_video_height %%>">
<span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--allow_player_pause et_pb_background-template--allow_player_pause et-pb-option et-pb-option--allow_player_pause">
<label for="et_pb_allow_player_pause_<%%= counter %%>">%12$s: </label>
<div class="et-pb-option-container et-pb-option-container--yes_no_button">
<div class="et_pb_yes_no_button_wrapper ">
<div class="et_pb_yes_no_button et_pb_off_state">
<span class="et_pb_value_text et_pb_on_value">%13$s</span>
<span class="et_pb_button_slider"></span>
<span class="et_pb_value_text et_pb_off_value">%14$s</span>
</div>
<select name="et_pb_allow_player_pause_<%%= counter %%>" id="et_pb_allow_player_pause_<%%= counter %%>" class="et-pb-main-setting regular-text" data-default="off">
<option value="off">%14$s</option>
<option value="on" <%%= current_allow_played_pause %%>>%13$s</option>
</select>
</div><span class="et-pb-reset-setting"></span>
</div>
</div>
<div class="et_pb_background-option et_pb_background-option--background_video_pause_outside_viewport et_pb_background-template--background_video_pause_outside_viewport et-pb-option et-pb-option--background_video_pause_outside_viewport">
<label for="et_pb_background_video_pause_outside_viewport_<%%= counter %%>">%15$s: </label>
<div class="et-pb-option-container et-pb-option-container--yes_no_button">
<div class="et_pb_yes_no_button_wrapper ">
<div class="et_pb_yes_no_button et_pb_off_state">
<span class="et_pb_value_text et_pb_on_value">%13$s</span>
<span class="et_pb_button_slider"></span>
<span class="et_pb_value_text et_pb_off_value">%14$s</span>
</div>
<select name="et_pb_background_video_pause_outside_viewport_<%%= counter %%>" id="et_pb_background_video_pause_outside_viewport_<%%= counter %%>" class="et-pb-main-setting regular-text" data-default="on">
<option value="on">%13$s</option>
<option value="off" <%%= current_background_video_pause_outside_viewport %%>>%14$s</option>
</select>
</div><span class="et-pb-reset-setting"></span>
</div>
</div>
</div>',
esc_html__( 'Background Video MP4', 'et_builder' ),
$this->get_icon( 'add' ),
$this->get_icon( 'setting' ),
$this->get_icon( 'delete' ),
esc_html__( 'Upload a video', 'et_builder' ), // #5
esc_html__( 'Choose a Background Video MP4 File', 'et_builder' ),
esc_html__( 'Set As Background Video', 'et_builder' ),
esc_html__( 'Background Video Webm', 'et_builder' ),
esc_html__( 'Choose a Background Video WEBM File', 'et_builder' ),
esc_html__( 'Background Video Width', 'et_builder' ), // #10
esc_html__( 'Background Video Height', 'et_builder' ),
esc_html__( 'Pause Video When Another Video Plays', 'et_builder' ),
et_builder_i18n( 'On' ),
et_builder_i18n( 'Off' ),
esc_html__( 'Pause Video While Not In View', 'et_builder' ) // #15
);
$output .= sprintf(
'<div class="et_pb_subtoggle_section">
<div class="et-pb-option-toggle-content">
<div class="et-pb-option et-pb-option--background" data-option_name="background_color_<%%= counter %%>">
<label for="et_pb_background">
%1$s
<%% if ( "4_4" !== column_type ) { %%>
<%%= counter + " " %%>
<%% } %%>
%2$s:
</label>
<div class="et-pb-option-container et-pb-option-container-inner et-pb-option-container--background" data-column-index="<%%= counter %%>" data-base_name="background">
%3$s
%4$s
%5$s
%6$s
%7$s
</div>
</div>
</div>
</div>
<%% counter++;
}); %%>',
esc_html__( 'Column', 'et_builder' ),
et_builder_i18n( 'Background' ),
$tab_navs,
$tab_color,
$tab_gradient, // #5
$tab_image,
$tab_video
);
return $output;
}
/**
* BB :: Generate Padding settings for columns.
*
* @return string
*/
public function generate_columns_settings_padding() {
$output = sprintf(
'<%% var columns = typeof columns_layout !== \'undefined\' ? columns_layout.split(",") : [],
counter = 1;
_.each( columns, function ( column_type ) {
var current_value_pt,
current_value_pr,
current_value_pb,
current_value_pl,
current_value_padding_tablet,
current_value_padding_phone,
has_tablet_padding,
has_phone_padding;
switch ( counter ) {
%1$s
}
%%>',
$this->generate_column_vars_padding()
);
$output .= sprintf(
'<div class="et_pb_subtoggle_section">
<div class="et-pb-option-toggle-content">
<div class="et-pb-option">
<label for="et_pb_padding_<%%= counter %%>">
%1$s
<%% if ( "4_4" !== column_type ) { %%>
<%%= counter + " " %%>
<%% } %%>
%2$s:
</label>
<div class="et-pb-option-container">
%7$s
<div class="et_margin_padding">
<label>
%3$s
<input type="text" class="medium-text et_custom_margin et_custom_margin_top et-pb-validate-unit et_pb_setting_mobile et_pb_setting_mobile_desktop et_pb_setting_mobile_active" id="et_pb_padding_top_<%%= counter %%>" name="et_pb_padding_top_<%%= counter %%>" value="<%%= current_value_pt %%>" data-device="desktop">
<input type="text" class="medium-text et_custom_margin et_custom_margin_top et_pb_setting_mobile et_pb_setting_mobile_tablet" data-device="tablet">
<input type="text" class="medium-text et_custom_margin et_custom_margin_top et_pb_setting_mobile et_pb_setting_mobile_phone" data-device="phone">
</label>
<label>
%4$s
<input type="text" class="medium-text et_custom_margin et_custom_margin_right et-pb-validate-unit et_pb_setting_mobile et_pb_setting_mobile_desktop et_pb_setting_mobile_active" id="et_pb_padding_right_<%%= counter %%>" name="et_pb_padding_right_<%%= counter %%>" value="<%%= current_value_pr %%>" data-device="desktop">
<input type="text" class="medium-text et_custom_margin et_custom_margin_right et_pb_setting_mobile et_pb_setting_mobile_tablet" data-device="tablet">
<input type="text" class="medium-text et_custom_margin et_custom_margin_right et_pb_setting_mobile et_pb_setting_mobile_phone" data-device="phone">
</label>
<label>
%5$s
<input type="text" class="medium-text et_custom_margin et_custom_margin_bottom et-pb-validate-unit et_pb_setting_mobile et_pb_setting_mobile_desktop et_pb_setting_mobile_active" id="et_pb_padding_bottom_<%%= counter %%>" name="et_pb_padding_bottom_<%%= counter %%>" value="<%%= current_value_pb %%>" data-device="desktop">
<input type="text" class="medium-text et_custom_margin et_custom_margin_bottom et_pb_setting_mobile et_pb_setting_mobile_tablet" data-device="tablet">
<input type="text" class="medium-text et_custom_margin et_custom_margin_bottom et_pb_setting_mobile et_pb_setting_mobile_phone" data-device="phone">
</label>
<label>
%6$s
<input type="text" class="medium-text et_custom_margin et_custom_margin_left et-pb-validate-unit et_pb_setting_mobile et_pb_setting_mobile_desktop et_pb_setting_mobile_active" id="et_pb_padding_left_<%%= counter %%>" name="et_pb_padding_left_<%%= counter %%>" value="<%%= current_value_pl %%>" data-device="desktop">
<input type="text" class="medium-text et_custom_margin et_custom_margin_left et_pb_setting_mobile et_pb_setting_mobile_tablet" data-device="tablet">
<input type="text" class="medium-text et_custom_margin et_custom_margin_left et_pb_setting_mobile et_pb_setting_mobile_phone" data-device="phone">
</label>
<input type="hidden" class="et_custom_margin_main et_pb_setting_mobile et_pb_setting_mobile_desktop et-pb-main-setting et_pb_setting_mobile_active" value="<%%= \'\' === current_value_pt && \'\' === current_value_pr && \'\' === current_value_pb && \'\' === current_value_pl ? \'\' : current_value_pt + \'|\' + current_value_pr + \'|\' + current_value_pb + \'|\' + current_value_pl %%>" data-device="desktop">
<input type="hidden" class="et_custom_margin_main et_pb_setting_mobile et_pb_setting_mobile_tablet et-pb-main-setting" id="et_pb_padding_<%%= counter %%>_tablet" name="et_pb_padding_<%%= counter %%>_tablet" value="<%%= current_value_padding_tablet %%>" data-device="tablet" data-has_saved_value="<%%= has_tablet_padding %%>">
<input type="hidden" class="et_custom_margin_main et_pb_setting_mobile et_pb_setting_mobile_phone et-pb-main-setting" id="et_pb_padding_<%%= counter %%>_phone" name="et_pb_padding_<%%= counter %%>_phone" value="<%%= current_value_padding_phone %%>" data-device="phone" data-has_saved_value="<%%= has_phone_padding %%>">
<input id="et_pb_padding_<%%= counter %%>_last_edited" type="hidden" class="et_pb_mobile_last_edited_field" value="<%%= last_edited_padding_field %%>">
</div>
<span class="et-pb-mobile-settings-toggle"></span>
<span class="et-pb-reset-setting"></span>
</div>
</div>
</div>
</div>
<%% counter++;
}); %%>',
esc_html__( 'Column', 'et_builder' ),
esc_html__( 'Padding', 'et_builder' ),
et_builder_i18n( 'Top' ),
et_builder_i18n( 'Right' ),
et_builder_i18n( 'Bottom' ), // #5
et_builder_i18n( 'Left' ),
et_pb_generate_mobile_settings_tabs() // #7
);
return $output;
}
/**
* BB :: Generate "Custom CSS" settings for columns.
*
* @return string
*/
public function generate_columns_settings_css() {
$output = sprintf(
'<%%
var columns_css = typeof columns_layout !== \'undefined\' ? columns_layout.split(",") : [],
counter_css = 1;
_.each( columns_css, function ( column_type ) {
var current_module_id_value,
current_module_class_value,
current_custom_css_before_value,
current_custom_css_main_value,
current_custom_css_after_value;
switch ( counter_css ) {
%1$s
} %%>
<div class="et_pb_subtoggle_section">
<div class="et-pb-option-toggle-content">
<div class="et-pb-option et-pb-option--custom_css">
<label for="et_pb_custom_css_before_<%%= counter_css %%>">
%2$s
<%% if ( "4_4" !== column_type ) { %%>
<%%= counter_css + " " %%>
<%% } %%>
%3$s:<span>.et_pb_column_<%%= \'row_inner\' === module_type ? \'inner_\' : \'\' %%><%%= typeof columns_order !== \'undefined\' && typeof columns_order[counter_css-1] !== \'undefined\' ? columns_order[counter_css-1] : \'\' %%>:before</span>
</label>
<div class="et-pb-option-container et-pb-custom-css-option">
<textarea id="et_pb_custom_css_before_<%%= counter_css %%>" class="et-pb-main-setting large-text coderegular-text" rows="4" cols="50"><%%= current_custom_css_before_value.replace( /\|\|/g, "\n" ) %%></textarea>
</div>
</div>
<div class="et-pb-option et-pb-option--custom_css">
<label for="et_pb_custom_css_main_<%%= counter_css %%>">
%2$s
<%% if ( "4_4" !== column_type ) { %%>
<%%= counter_css + " " %%>
<%% } %%>
%4$s:<span>.et_pb_column_<%%= \'row_inner\' === module_type ? \'inner_\' : \'\' %%><%%= typeof columns_order !== \'undefined\' && typeof columns_order[counter_css-1] !== \'undefined\' ? columns_order[counter_css-1] : \'\' %%></span>
</label>
<div class="et-pb-option-container et-pb-custom-css-option">
<textarea id="et_pb_custom_css_main_<%%= counter_css %%>" class="et-pb-main-setting large-text coderegular-text" rows="4" cols="50"><%%= current_custom_css_main_value.replace( /\|\|/g, "\n" ) %%></textarea>
</div>
</div>
<div class="et-pb-option et-pb-option--custom_css">
<label for="et_pb_custom_css_after_<%%= counter_css %%>">
%2$s
<%% if ( "4_4" !== column_type ) { %%>
<%%= counter_css + " " %%>
<%% } %%>
%5$s:<span>.et_pb_column_<%%= \'row_inner\' === module_type ? \'inner_\' : \'\' %%><%%= typeof columns_order !== \'undefined\' && typeof columns_order[counter_css-1] !== \'undefined\' ? columns_order[counter_css-1] : \'\' %%>:after</span>
</label>
<div class="et-pb-option-container et-pb-custom-css-option">
<textarea id="et_pb_custom_css_after_<%%= counter_css %%>" class="et-pb-main-setting large-text coderegular-text" rows="4" cols="50"><%%= current_custom_css_after_value.replace( /\|\|/g, "\n" ) %%></textarea>
</div>
</div>
</div>
</div>
<%% counter_css++;
}); %%>',
$this->generate_column_vars_css(),
esc_html__( 'Column', 'et_builder' ),
et_builder_i18n( 'Before' ),
et_builder_i18n( 'Main Element' ),
et_builder_i18n( 'After' )
);
return $output;
}
/**
* BB :: Generate "CSS ID & Classes" settings for columns.
*
* @return string
*/
public function generate_columns_settings_css_fields() {
$output = sprintf(
'<%%
var columns_css = typeof columns_layout !== \'undefined\' ? columns_layout.split(",") : [],
counter_css = 1;
_.each( columns_css, function ( column_type ) {
var current_module_id_value,
current_module_class_value;
switch ( counter_css ) {
%1$s
} %%>
<div class="et_pb_subtoggle_section">
<div class="et-pb-option-toggle-content">
<div class="et-pb-option et_pb_custom_css_regular">
<label for="et_pb_module_id_<%%= counter_css %%>">
%2$s
<%% if ( "4_4" !== column_type ) { %%>
<%%= counter_css + " " %%>
<%% } %%>
%3$s:
</label>
<div class="et-pb-option-container">
<input id="et_pb_module_id_<%%= counter_css %%>" type="text" class="regular-text et_pb_custom_css_regular et-pb-main-setting" value="<%%= current_module_id_value %%>">
</div>
</div>
<div class="et-pb-option et_pb_custom_css_regular">
<label for="et_pb_module_class_<%%= counter_css %%>">
%2$s
<%% if ( "4_4" !== column_type ) { %%>
<%%= counter_css + " " %%>
<%% } %%>
%4$s:
</label>
<div class="et-pb-option-container">
<input id="et_pb_module_class_<%%= counter_css %%>" type="text" class="regular-text et_pb_custom_css_regular et-pb-main-setting" value="<%%= current_module_class_value %%>">
</div>
</div>
</div>
</div>
<%% counter_css++;
}); %%>',
$this->generate_column_vars_css(),
esc_html__( 'Column', 'et_builder' ),
esc_html__( 'CSS ID', 'et_builder' ),
esc_html__( 'CSS Class', 'et_builder' )
);
return $output;
}
}