| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043 |
- <?php
- namespace Elementor;
- use Elementor\Core\DynamicTags\Manager;
- if ( ! defined( 'ABSPATH' ) ) {
- exit; // Exit if accessed directly.
- }
- /**
- * Elementor controls stack.
- *
- * An abstract class that provides the needed properties and methods to
- * manage and handle controls in the editor panel to inheriting classes.
- *
- * @since 1.4.0
- * @abstract
- */
- abstract class Controls_Stack {
- /**
- * Responsive 'desktop' device name.
- */
- const RESPONSIVE_DESKTOP = 'desktop';
- /**
- * Responsive 'tablet' device name.
- */
- const RESPONSIVE_TABLET = 'tablet';
- /**
- * Responsive 'mobile' device name.
- */
- const RESPONSIVE_MOBILE = 'mobile';
- /**
- * Generic ID.
- *
- * Holds the unique ID.
- *
- * @access private
- *
- * @var string
- */
- private $id;
- /**
- * Parsed Settings.
- *
- * Holds the settings, which is the data entered by the user and processed
- * by elementor.
- *
- * @access private
- *
- * @var null|array
- */
- private $settings;
- private $active_settings;
- private $parsed_active_settings;
- /**
- * Parsed Dynamic Settings.
- *
- * @access private
- *
- * @var null|array
- */
- private $parsed_dynamic_settings;
- /**
- * Raw Data.
- *
- * Holds all the raw data including the element type, the child elements,
- * the user data.
- *
- * @access private
- *
- * @var null|array
- */
- private $data;
- /**
- * The configuration.
- *
- * Holds the configuration used to generate the Elementor editor. It includes
- * the element name, icon, categories, etc.
- *
- * @access private
- *
- * @var null|array
- */
- private $config;
- /**
- * Current section.
- *
- * Holds the current section while inserting a set of controls sections.
- *
- * @access private
- *
- * @var null|array
- */
- private $current_section;
- /**
- * Current tab.
- *
- * Holds the current tab while inserting a set of controls tabs.
- *
- * @access private
- *
- * @var null|array
- */
- private $current_tab;
- /**
- * Current popover.
- *
- * Holds the current popover while inserting a set of controls.
- *
- * @access private
- *
- * @var null|array
- */
- private $current_popover;
- /**
- * Injection point.
- *
- * Holds the injection point in the stack where the control will be inserted.
- *
- * @access private
- *
- * @var null|array
- */
- private $injection_point;
- /**
- * Data sanitized.
- *
- * @access private
- *
- * @var bool
- */
- private $settings_sanitized = false;
- /**
- * Get element name.
- *
- * Retrieve the element name.
- *
- * @since 1.4.0
- * @access public
- * @abstract
- *
- * @return string The name.
- */
- abstract public function get_name();
- /**
- * Get unique name.
- *
- * Some classes need to use unique names, this method allows you to create
- * them. By default it retrieves the regular name.
- *
- * @since 1.6.0
- * @access public
- *
- * @return string Unique name.
- */
- public function get_unique_name() {
- return $this->get_name();
- }
- /**
- * Get element ID.
- *
- * Retrieve the element generic ID.
- *
- * @since 1.4.0
- * @access public
- *
- * @return string The ID.
- */
- public function get_id() {
- return $this->id;
- }
- /**
- * Get element ID.
- *
- * Retrieve the element generic ID as integer.
- *
- * @since 1.8.0
- * @access public
- *
- * @return string The converted ID.
- */
- public function get_id_int() {
- return hexdec( $this->id );
- }
- /**
- * Get the type.
- *
- * Retrieve the type, e.g. 'stack', 'section', 'widget' etc.
- *
- * @since 1.4.0
- * @access public
- * @static
- *
- * @return string The type.
- */
- public static function get_type() {
- return 'stack';
- }
- /**
- * Get items.
- *
- * Utility method that receives an array with a needle and returns all the
- * items that match the needle. If needle is not defined the entire haystack
- * will be returned.
- *
- * @since 1.4.0
- * @access protected
- * @static
- *
- * @param array $haystack An array of items.
- * @param string $needle Optional. Needle. Default is null.
- *
- * @return mixed The whole haystack or the needle from the haystack when requested.
- */
- protected static function _get_items( array $haystack, $needle = null ) {
- if ( $needle ) {
- return isset( $haystack[ $needle ] ) ? $haystack[ $needle ] : null;
- }
- return $haystack;
- }
- /**
- * Get current section.
- *
- * When inserting new controls, this method will retrieve the current section.
- *
- * @since 1.7.1
- * @access public
- *
- * @return null|array Current section.
- */
- public function get_current_section() {
- return $this->current_section;
- }
- /**
- * Get current tab.
- *
- * When inserting new controls, this method will retrieve the current tab.
- *
- * @since 1.7.1
- * @access public
- *
- * @return null|array Current tab.
- */
- public function get_current_tab() {
- return $this->current_tab;
- }
- /**
- * Get controls.
- *
- * Retrieve all the controls or, when requested, a specific control.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $control_id The ID of the requested control. Optional field,
- * when set it will return a specific control.
- * Default is null.
- *
- * @return mixed Controls list.
- */
- public function get_controls( $control_id = null ) {
- return self::_get_items( $this->get_stack()['controls'], $control_id );
- }
- /**
- * Get active controls.
- *
- * Retrieve an array of active controls that meet the condition field.
- *
- * If specific controls was given as a parameter, retrieve active controls
- * from that list, otherwise check for all the controls available.
- *
- * @since 1.4.0
- * @since 2.0.9 Added the `controls` and the `settings` parameters.
- * @access public
- *
- * @param array $controls Optional. An array of controls. Default is null.
- * @param array $settings Optional. Controls settings. Default is null.
- *
- * @return array Active controls.
- */
- public function get_active_controls( array $controls = null, array $settings = null ) {
- if ( ! $controls ) {
- $controls = $this->get_controls();
- }
- if ( ! $settings ) {
- $settings = $this->get_controls_settings();
- }
- $active_controls = array_reduce(
- array_keys( $controls ), function( $active_controls, $control_key ) use ( $controls, $settings ) {
- $control = $controls[ $control_key ];
- if ( $this->is_control_visible( $control, $settings ) ) {
- $active_controls[ $control_key ] = $control;
- }
- return $active_controls;
- }, []
- );
- return $active_controls;
- }
- /**
- * Get controls settings.
- *
- * Retrieve the settings for all the controls that represent them.
- *
- * @since 1.5.0
- * @access public
- *
- * @return array Controls settings.
- */
- public function get_controls_settings() {
- return array_intersect_key( $this->get_settings(), $this->get_controls() );
- }
- /**
- * Add new control to stack.
- *
- * Register a single control to allow the user to set/update data.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $id Control ID.
- * @param array $args Control arguments.
- * @param array $options Optional. Control options. Default is an empty array.
- *
- * @return bool True if control added, False otherwise.
- */
- public function add_control( $id, array $args, $options = [] ) {
- $default_options = [
- 'overwrite' => false,
- 'position' => null,
- ];
- $options = array_merge( $default_options, $options );
- if ( $options['position'] ) {
- $this->start_injection( $options['position'] );
- }
- if ( $this->injection_point ) {
- $options['index'] = $this->injection_point['index']++;
- }
- if ( empty( $args['type'] ) || ! in_array( $args['type'], [ Controls_Manager::SECTION, Controls_Manager::WP_WIDGET ], true ) ) {
- $target_section_args = $this->current_section;
- $target_tab = $this->current_tab;
- if ( $this->injection_point ) {
- $target_section_args = $this->injection_point['section'];
- if ( ! empty( $this->injection_point['tab'] ) ) {
- $target_tab = $this->injection_point['tab'];
- }
- }
- if ( null !== $target_section_args ) {
- if ( ! empty( $args['section'] ) || ! empty( $args['tab'] ) ) {
- _doing_it_wrong( sprintf( '%s::%s', get_called_class(), __FUNCTION__ ), sprintf( 'Cannot redeclare control with `tab` or `section` args inside section "%s".', $id ), '1.0.0' );
- }
- $args = array_replace_recursive( $target_section_args, $args );
- if ( null !== $target_tab ) {
- $args = array_merge( $args, $target_tab );
- }
- } elseif ( empty( $args['section'] ) && ( ! $options['overwrite'] || is_wp_error( Plugin::$instance->controls_manager->get_control_from_stack( $this->get_unique_name(), $id ) ) ) ) {
- wp_die( sprintf( '%s::%s: Cannot add a control outside of a section (use `start_controls_section`).', get_called_class(), __FUNCTION__ ) );
- }
- }
- if ( $options['position'] ) {
- $this->end_injection();
- }
- unset( $options['position'] );
- if ( $this->current_popover && ! $this->current_popover['initialized'] ) {
- $args['popover'] = [
- 'start' => true,
- ];
- $this->current_popover['initialized'] = true;
- }
- return Plugin::$instance->controls_manager->add_control_to_stack( $this, $id, $args, $options );
- }
- /**
- * Remove control from stack.
- *
- * Unregister an existing control and remove it from the stack.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $control_id Control ID.
- *
- * @return bool|\WP_Error
- */
- public function remove_control( $control_id ) {
- return Plugin::$instance->controls_manager->remove_control_from_stack( $this->get_unique_name(), $control_id );
- }
- /**
- * Update control in stack.
- *
- * Change the value of an existing control in the stack. When you add new
- * control you set the `$args` parameter, this method allows you to update
- * the arguments by passing new data.
- *
- * @since 1.4.0
- * @since 1.8.1 New `$options` parameter added.
- *
- * @access public
- *
- * @param string $control_id Control ID.
- * @param array $args Control arguments. Only the new fields you want
- * to update.
- * @param array $options Optional. Some additional options. Default is
- * an empty array.
- *
- * @return bool
- */
- public function update_control( $control_id, array $args, array $options = [] ) {
- $is_updated = Plugin::$instance->controls_manager->update_control_in_stack( $this, $control_id, $args, $options );
- if ( ! $is_updated ) {
- return false;
- }
- $control = $this->get_controls( $control_id );
- if ( Controls_Manager::SECTION === $control['type'] ) {
- $section_args = $this->get_section_args( $control_id );
- $section_controls = $this->get_section_controls( $control_id );
- foreach ( $section_controls as $section_control_id => $section_control ) {
- $this->update_control( $section_control_id, $section_args );
- }
- }
- return true;
- }
- /**
- * Get stack.
- *
- * Retrieve the stack of controls.
- *
- * @since 1.9.2
- * @access public
- *
- * @return array Stack of controls.
- */
- public function get_stack() {
- $stack = Plugin::$instance->controls_manager->get_element_stack( $this );
- if ( null === $stack ) {
- $this->init_controls();
- return $this->get_stack();
- }
- return $stack;
- }
- /**
- * Get position information.
- *
- * Retrieve the position while injecting data, based on the element type.
- *
- * @since 1.7.0
- * @access public
- *
- * @param array $position {
- * The injection position.
- *
- * @type string $type Injection type, either `control` or `section`.
- * Default is `control`.
- * @type string $at Where to inject. If `$type` is `control` accepts
- * `before` and `after`. If `$type` is `section`
- * accepts `start` and `end`. Default values based on
- * the `type`.
- * @type string $of Control/Section ID.
- * @type array $fallback Fallback injection position. When the position is
- * not found it will try to fetch the fallback
- * position.
- * }
- *
- * @return bool|array Position info.
- */
- final public function get_position_info( array $position ) {
- $default_position = [
- 'type' => 'control',
- 'at' => 'after',
- ];
- if ( ! empty( $position['type'] ) && 'section' === $position['type'] ) {
- $default_position['at'] = 'end';
- }
- $position = array_merge( $default_position, $position );
- if (
- 'control' === $position['type'] && in_array( $position['at'], [ 'start', 'end' ], true ) ||
- 'section' === $position['type'] && in_array( $position['at'], [ 'before', 'after' ], true )
- ) {
- _doing_it_wrong( sprintf( '%s::%s', get_called_class(), __FUNCTION__ ), 'Invalid position arguments. Use `before` / `after` for control or `start` / `end` for section.', '1.7.0' );
- return false;
- }
- $target_control_index = $this->get_control_index( $position['of'] );
- if ( false === $target_control_index ) {
- if ( ! empty( $position['fallback'] ) ) {
- return $this->get_position_info( $position['fallback'] );
- }
- return false;
- }
- $target_section_index = $target_control_index;
- $registered_controls = $this->get_controls();
- $controls_keys = array_keys( $registered_controls );
- while ( Controls_Manager::SECTION !== $registered_controls[ $controls_keys[ $target_section_index ] ]['type'] ) {
- $target_section_index--;
- }
- if ( 'section' === $position['type'] ) {
- $target_control_index++;
- if ( 'end' === $position['at'] ) {
- while ( Controls_Manager::SECTION !== $registered_controls[ $controls_keys[ $target_control_index ] ]['type'] ) {
- if ( ++$target_control_index >= count( $registered_controls ) ) {
- break;
- }
- }
- }
- }
- $target_control = $registered_controls[ $controls_keys[ $target_control_index ] ];
- if ( 'after' === $position['at'] ) {
- $target_control_index++;
- }
- $section_id = $registered_controls[ $controls_keys[ $target_section_index ] ]['name'];
- $position_info = [
- 'index' => $target_control_index,
- 'section' => $this->get_section_args( $section_id ),
- ];
- if ( ! empty( $target_control['tabs_wrapper'] ) ) {
- $position_info['tab'] = [
- 'tabs_wrapper' => $target_control['tabs_wrapper'],
- 'inner_tab' => $target_control['inner_tab'],
- ];
- }
- return $position_info;
- }
- /**
- * Get control key.
- *
- * Retrieve the key of the control based on a given index of the control.
- *
- * @since 1.9.2
- * @access public
- *
- * @param string $control_index Control index.
- *
- * @return int Control key.
- */
- final public function get_control_key( $control_index ) {
- $registered_controls = $this->get_controls();
- $controls_keys = array_keys( $registered_controls );
- return $controls_keys[ $control_index ];
- }
- /**
- * Get control index.
- *
- * Retrieve the index of the control based on a given key of the control.
- *
- * @since 1.7.6
- * @access public
- *
- * @param string $control_key Control key.
- *
- * @return false|int Control index.
- */
- final public function get_control_index( $control_key ) {
- $controls = $this->get_controls();
- $controls_keys = array_keys( $controls );
- return array_search( $control_key, $controls_keys );
- }
- /**
- * Get section controls.
- *
- * Retrieve all controls under a specific section.
- *
- * @since 1.7.6
- * @access public
- *
- * @param string $section_id Section ID.
- *
- * @return array Section controls
- */
- final public function get_section_controls( $section_id ) {
- $section_index = $this->get_control_index( $section_id );
- $section_controls = [];
- $registered_controls = $this->get_controls();
- $controls_keys = array_keys( $registered_controls );
- while ( true ) {
- $section_index++;
- if ( ! isset( $controls_keys[ $section_index ] ) ) {
- break;
- }
- $control_key = $controls_keys[ $section_index ];
- if ( Controls_Manager::SECTION === $registered_controls[ $control_key ]['type'] ) {
- break;
- }
- $section_controls[ $control_key ] = $registered_controls[ $control_key ];
- };
- return $section_controls;
- }
- /**
- * Add new group control to stack.
- *
- * Register a set of related controls grouped together as a single unified
- * control. For example grouping together like typography controls into a
- * single, easy-to-use control.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $group_name Group control name.
- * @param array $args Group control arguments. Default is an empty array.
- * @param array $options Optional. Group control options. Default is an
- * empty array.
- */
- final public function add_group_control( $group_name, array $args = [], array $options = [] ) {
- $group = Plugin::$instance->controls_manager->get_control_groups( $group_name );
- if ( ! $group ) {
- wp_die( sprintf( '%s::%s: Group "%s" not found.', get_called_class(), __FUNCTION__, $group_name ) );
- }
- $group->add_controls( $this, $args, $options );
- }
- /**
- * Get scheme controls.
- *
- * Retrieve all the controls that use schemes.
- *
- * @since 1.4.0
- * @access public
- *
- * @return array Scheme controls.
- */
- final public function get_scheme_controls() {
- $enabled_schemes = Schemes_Manager::get_enabled_schemes();
- return array_filter(
- $this->get_controls(), function( $control ) use ( $enabled_schemes ) {
- return ( ! empty( $control['scheme'] ) && in_array( $control['scheme']['type'], $enabled_schemes ) );
- }
- );
- }
- /**
- * Get style controls.
- *
- * Retrieve style controls for all active controls or, when requested, from
- * a specific set of controls.
- *
- * @since 1.4.0
- * @since 2.0.9 Added the `settings` parameter.
- * @access public
- *
- * @param array $controls Optional. Controls list. Default is null.
- * @param array $settings Optional. Controls settings. Default is null.
- *
- * @return array Style controls.
- */
- final public function get_style_controls( array $controls = null, array $settings = null ) {
- $controls = $this->get_active_controls( $controls, $settings );
- $style_controls = [];
- foreach ( $controls as $control_name => $control ) {
- $control_obj = Plugin::$instance->controls_manager->get_control( $control['type'] );
- if ( ! $control_obj instanceof Base_Data_Control ) {
- continue;
- }
- $control = array_merge( $control_obj->get_settings(), $control );
- if ( Controls_Manager::REPEATER === $control['type'] ) {
- $style_fields = [];
- foreach ( $this->get_settings( $control_name ) as $item ) {
- $style_fields[] = $this->get_style_controls( $control['fields'], $item );
- }
- $control['style_fields'] = $style_fields;
- }
- if ( ! empty( $control['selectors'] ) || ! empty( $control['dynamic'] ) || ! empty( $control['style_fields'] ) ) {
- $style_controls[ $control_name ] = $control;
- }
- }
- return $style_controls;
- }
- /**
- * Get class controls.
- *
- * Retrieve the controls that use the same prefix class from all the active
- * controls
- *
- * @since 1.4.0
- * @deprecated 2.1.0
- * @access public
- *
- * @return array Class controls.
- */
- final public function get_class_controls() {
- return array_filter(
- $this->get_active_controls(), function( $control ) {
- return ( isset( $control['prefix_class'] ) );
- }
- );
- }
- /**
- * Get tabs controls.
- *
- * Retrieve all the tabs assigned to the control.
- *
- * @since 1.4.0
- * @access public
- *
- * @return array Tabs controls.
- */
- final public function get_tabs_controls() {
- return $this->get_stack()['tabs'];
- }
- /**
- * Add new responsive control to stack.
- *
- * Register a set of controls to allow editing based on user screen size.
- * This method registers three screen sizes: Desktop, Tablet and Mobile.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $id Responsive control ID.
- * @param array $args Responsive control arguments.
- * @param array $options Optional. Responsive control options. Default is
- * an empty array.
- */
- final public function add_responsive_control( $id, array $args, $options = [] ) {
- $args['responsive'] = [];
- $devices = [
- self::RESPONSIVE_DESKTOP,
- self::RESPONSIVE_TABLET,
- self::RESPONSIVE_MOBILE,
- ];
- if ( isset( $args['devices'] ) ) {
- $devices = array_intersect( $devices, $args['devices'] );
- $args['responsive']['devices'] = $devices;
- unset( $args['devices'] );
- }
- if ( isset( $args['default'] ) ) {
- $args['desktop_default'] = $args['default'];
- unset( $args['default'] );
- }
- foreach ( $devices as $device_name ) {
- $control_args = $args;
- if ( isset( $control_args['device_args'] ) ) {
- if ( ! empty( $control_args['device_args'][ $device_name ] ) ) {
- $control_args = array_merge( $control_args, $control_args['device_args'][ $device_name ] );
- }
- unset( $control_args['device_args'] );
- }
- if ( ! empty( $args['prefix_class'] ) ) {
- $device_to_replace = self::RESPONSIVE_DESKTOP === $device_name ? '' : '-' . $device_name;
- $control_args['prefix_class'] = sprintf( $args['prefix_class'], $device_to_replace );
- }
- $control_args['responsive']['max'] = $device_name;
- if ( isset( $control_args['min_affected_device'] ) ) {
- if ( ! empty( $control_args['min_affected_device'][ $device_name ] ) ) {
- $control_args['responsive']['min'] = $control_args['min_affected_device'][ $device_name ];
- }
- unset( $control_args['min_affected_device'] );
- }
- if ( isset( $control_args[ $device_name . '_default' ] ) ) {
- $control_args['default'] = $control_args[ $device_name . '_default' ];
- }
- unset( $control_args['desktop_default'] );
- unset( $control_args['tablet_default'] );
- unset( $control_args['mobile_default'] );
- $id_suffix = self::RESPONSIVE_DESKTOP === $device_name ? '' : '_' . $device_name;
- if ( ! empty( $options['overwrite'] ) ) {
- $this->update_control( $id . $id_suffix, $control_args, [
- 'recursive' => ! empty( $options['recursive'] ),
- ] );
- } else {
- $this->add_control( $id . $id_suffix, $control_args, $options );
- }
- }
- }
- /**
- * Update responsive control in stack.
- *
- * Change the value of an existing responsive control in the stack. When you
- * add new control you set the `$args` parameter, this method allows you to
- * update the arguments by passing new data.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $id Responsive control ID.
- * @param array $args Responsive control arguments.
- * @param array $options Optional. Additional options.
- */
- final public function update_responsive_control( $id, array $args, array $options = [] ) {
- $this->add_responsive_control( $id, $args, [
- 'overwrite' => true,
- 'recursive' => ! empty( $options['recursive'] ),
- ] );
- }
- /**
- * Remove responsive control from stack.
- *
- * Unregister an existing responsive control and remove it from the stack.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $id Responsive control ID.
- */
- final public function remove_responsive_control( $id ) {
- $devices = [
- self::RESPONSIVE_DESKTOP,
- self::RESPONSIVE_TABLET,
- self::RESPONSIVE_MOBILE,
- ];
- foreach ( $devices as $device_name ) {
- $id_suffix = self::RESPONSIVE_DESKTOP === $device_name ? '' : '_' . $device_name;
- $this->remove_control( $id . $id_suffix );
- }
- }
- /**
- * Get class name.
- *
- * Retrieve the name of the current class.
- *
- * @since 1.4.0
- * @access public
- *
- * @return string Class name.
- */
- final public function get_class_name() {
- return get_called_class();
- }
- /**
- * Get the config.
- *
- * Retrieve the config or, if non set, use the initial config.
- *
- * @since 1.4.0
- * @access public
- *
- * @return array|null The config.
- */
- final public function get_config() {
- if ( null === $this->config ) {
- $this->config = $this->_get_initial_config();
- }
- return $this->config;
- }
- /**
- * Get frontend settings keys.
- *
- * Retrieve settings keys for all frontend controls.
- *
- * @since 1.6.0
- * @access public
- *
- * @return array Settings keys for each control.
- */
- final public function get_frontend_settings_keys() {
- $controls = [];
- foreach ( $this->get_controls() as $control ) {
- if ( ! empty( $control['frontend_available'] ) ) {
- $controls[] = $control['name'];
- }
- }
- return $controls;
- }
- /**
- * Get controls pointer index.
- *
- * Retrieve pointer index where the next control should be added.
- *
- * While using injection point, it will return the injection point index.
- * Otherwise index of the last control plus one.
- *
- * @since 1.9.2
- * @access public
- *
- * @return int Controls pointer index.
- */
- public function get_pointer_index() {
- if ( null !== $this->injection_point ) {
- return $this->injection_point['index'];
- }
- return count( $this->get_controls() );
- }
- /**
- * Get the raw data.
- *
- * Retrieve all the items or, when requested, a specific item.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $item Optional. The requested item. Default is null.
- *
- * @return mixed The raw data.
- */
- public function get_data( $item = null ) {
- if ( ! $this->settings_sanitized && ( ! $item || 'settings' === $item ) ) {
- $this->data['settings'] = $this->sanitize_settings( $this->data['settings'] );
- $this->settings_sanitized = true;
- }
- return self::_get_items( $this->data, $item );
- }
- /**
- * Get the settings.
- *
- * Retrieve all the settings or, when requested, a specific setting.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $setting Optional. The requested setting. Default is null.
- *
- * @return mixed The settings.
- */
- public function get_settings( $setting = null ) {
- if ( ! $this->settings ) {
- $this->settings = $this->_get_parsed_settings();
- }
- return self::_get_items( $this->settings, $setting );
- }
- public function get_parsed_dynamic_settings( $setting = null ) {
- if ( null === $this->parsed_dynamic_settings ) {
- $this->parsed_dynamic_settings = $this->parse_dynamic_settings( $this->get_settings() );
- }
- return self::_get_items( $this->parsed_dynamic_settings, $setting );
- }
- /**
- * Get active settings.
- *
- * Retrieve the settings from all the active controls.
- *
- * @since 1.4.0
- * @since 2.1.0 Added the `controls` and the `settings` parameters.
- * @access public
- *
- * @param array $controls Optional. An array of controls. Default is null.
- * @param array $settings Optional. Controls settings. Default is null.
- *
- * @return array Active settings.
- */
- public function get_active_settings( $settings = null, $controls = null ) {
- $is_first_request = ! $settings && ! $this->active_settings;
- if ( ! $settings ) {
- if ( $this->active_settings ) {
- return $this->active_settings;
- }
- $settings = $this->get_controls_settings();
- $controls = $this->get_controls();
- }
- $active_settings = [];
- foreach ( $settings as $setting_key => $setting ) {
- if ( ! isset( $controls[ $setting_key ] ) ) {
- $active_settings[ $setting_key ] = $setting;
- continue;
- }
- $control = $controls[ $setting_key ];
- if ( $this->is_control_visible( $control, $settings ) ) {
- if ( Controls_Manager::REPEATER === $control['type'] ) {
- foreach ( $setting as & $item ) {
- $item = $this->get_active_settings( $item, $control['fields'] );
- }
- }
- $active_settings[ $setting_key ] = $setting;
- } else {
- $active_settings[ $setting_key ] = null;
- }
- }
- if ( $is_first_request ) {
- $this->active_settings = $active_settings;
- }
- return $active_settings;
- }
- /**
- * Get settings for display.
- *
- * Retrieve all the settings or, when requested, a specific setting for display.
- *
- * Unlike `get_settings()` method, this method retrieves only active settings
- * that passed all the conditions, rendered all the shortcodes and all the dynamic
- * tags.
- *
- * @since 2.0.0
- * @access public
- *
- * @param string $setting_key Optional. The key of the requested setting.
- * Default is null.
- *
- * @return array The settings.
- */
- public function get_settings_for_display( $setting_key = null ) {
- if ( ! $this->parsed_active_settings ) {
- $this->parsed_active_settings = $this->get_active_settings( $this->get_parsed_dynamic_settings(), $this->get_controls() );
- }
- return self::_get_items( $this->parsed_active_settings, $setting_key );
- }
- /**
- * Parse dynamic settings.
- *
- * Retrieve the settings with rendered dynamic tags.
- *
- * @since 2.0.0
- * @access public
- *
- * @param array $settings Optional. The requested setting. Default is null.
- * @param array $controls Optional. The controls array. Default is null.
- * @param array $all_settings Optional. All the settings. Default is null.
- *
- * @return array The settings with rendered dynamic tags.
- */
- public function parse_dynamic_settings( $settings, $controls = null, $all_settings = null ) {
- if ( null === $all_settings ) {
- $all_settings = $this->get_settings();
- }
- if ( null === $controls ) {
- $controls = $this->get_controls();
- }
- foreach ( $controls as $control ) {
- $control_name = $control['name'];
- $control_obj = Plugin::$instance->controls_manager->get_control( $control['type'] );
- if ( ! $control_obj instanceof Base_Data_Control ) {
- continue;
- }
- if ( 'repeater' === $control_obj->get_type() ) {
- foreach ( $settings[ $control_name ] as & $field ) {
- $field = $this->parse_dynamic_settings( $field, $control['fields'], $field );
- }
- continue;
- }
- if ( empty( $control['dynamic'] ) || ! isset( $all_settings[ Manager::DYNAMIC_SETTING_KEY ][ $control_name ] ) ) {
- continue;
- }
- $dynamic_settings = array_merge( $control_obj->get_settings( 'dynamic' ), $control['dynamic'] );
- if ( ! empty( $dynamic_settings['active'] ) && ! empty( $all_settings[ Manager::DYNAMIC_SETTING_KEY ][ $control_name ] ) ) {
- $parsed_value = $control_obj->parse_tags( $all_settings[ Manager::DYNAMIC_SETTING_KEY ][ $control_name ], $dynamic_settings );
- $dynamic_property = ! empty( $dynamic_settings['property'] ) ? $dynamic_settings['property'] : null;
- if ( $dynamic_property ) {
- $settings[ $control_name ][ $dynamic_property ] = $parsed_value;
- } else {
- $settings[ $control_name ] = $parsed_value;
- }
- }
- }
- return $settings;
- }
- /**
- * Get frontend settings.
- *
- * Retrieve the settings for all frontend controls.
- *
- * @since 1.6.0
- * @access public
- *
- * @return array Frontend settings.
- */
- public function get_frontend_settings() {
- $frontend_settings = array_intersect_key( $this->get_active_settings(), array_flip( $this->get_frontend_settings_keys() ) );
- foreach ( $frontend_settings as $key => $setting ) {
- if ( in_array( $setting, [ null, '' ], true ) ) {
- unset( $frontend_settings[ $key ] );
- }
- }
- return $frontend_settings;
- }
- /**
- * Filter controls settings.
- *
- * Receives controls, settings and a callback function to filter the settings by
- * and returns filtered settings.
- *
- * @since 1.5.0
- * @access public
- *
- * @param callable $callback The callback function.
- * @param array $settings Optional. Control settings. Default is an empty
- * array.
- * @param array $controls Optional. Controls list. Default is an empty
- * array.
- *
- * @return array Filtered settings.
- */
- public function filter_controls_settings( callable $callback, array $settings = [], array $controls = [] ) {
- if ( ! $settings ) {
- $settings = $this->get_settings();
- }
- if ( ! $controls ) {
- $controls = $this->get_controls();
- }
- return array_reduce(
- array_keys( $settings ), function( $filtered_settings, $setting_key ) use ( $controls, $settings, $callback ) {
- if ( isset( $controls[ $setting_key ] ) ) {
- $result = $callback( $settings[ $setting_key ], $controls[ $setting_key ] );
- if ( null !== $result ) {
- $filtered_settings[ $setting_key ] = $result;
- }
- }
- return $filtered_settings;
- }, []
- );
- }
- /**
- * Whether the control is visible or not.
- *
- * Used to determine whether the control is visible or not.
- *
- * @since 1.4.0
- * @access public
- *
- * @param array $control The control.
- * @param array $values Optional. Condition values. Default is null.
- *
- * @return bool Whether the control is visible.
- */
- public function is_control_visible( $control, $values = null ) {
- if ( null === $values ) {
- $values = $this->get_settings();
- }
- if ( ! empty( $control['conditions'] ) ) {
- return Conditions::check( $control['conditions'], $values );
- }
- if ( empty( $control['condition'] ) ) {
- return true;
- }
- foreach ( $control['condition'] as $condition_key => $condition_value ) {
- preg_match( '/([a-z_0-9]+)(?:\[([a-z_]+)])?(!?)$/i', $condition_key, $condition_key_parts );
- $pure_condition_key = $condition_key_parts[1];
- $condition_sub_key = $condition_key_parts[2];
- $is_negative_condition = ! ! $condition_key_parts[3];
- if ( ! isset( $values[ $pure_condition_key ] ) || null === $values[ $pure_condition_key ] ) {
- return false;
- }
- $instance_value = $values[ $pure_condition_key ];
- if ( $condition_sub_key && is_array( $instance_value ) ) {
- if ( ! isset( $instance_value[ $condition_sub_key ] ) ) {
- return false;
- }
- $instance_value = $instance_value[ $condition_sub_key ];
- }
- /**
- * If the $condition_value is a non empty array - check if the $condition_value contains the $instance_value,
- * If the $instance_value is a non empty array - check if the $instance_value contains the $condition_value
- * otherwise check if they are equal. ( and give the ability to check if the value is an empty array )
- */
- if ( is_array( $condition_value ) && ! empty( $condition_value ) ) {
- $is_contains = in_array( $instance_value, $condition_value, true );
- } elseif ( is_array( $instance_value ) && ! empty( $instance_value ) ) {
- $is_contains = in_array( $condition_value, $instance_value, true );
- } else {
- $is_contains = $instance_value === $condition_value;
- }
- if ( $is_negative_condition && $is_contains || ! $is_negative_condition && ! $is_contains ) {
- return false;
- }
- }
- return true;
- }
- /**
- * Start controls section.
- *
- * Used to add a new section of controls. When you use this method, all the
- * registered controls from this point will be assigned to this section,
- * until you close the section using `end_controls_section()` method.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $section_id Section ID.
- * @param array $args Section arguments.
- */
- public function start_controls_section( $section_id, array $args ) {
- $section_name = $this->get_name();
- /**
- * Before section start.
- *
- * Fires before Elementor section starts in the editor panel.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param string $section_id Section ID.
- * @param array $args Section arguments.
- */
- do_action( 'elementor/element/before_section_start', $this, $section_id, $args );
- /**
- * Before section start.
- *
- * Fires before Elementor section starts in the editor panel.
- *
- * The dynamic portions of the hook name, `$section_name` and `$section_id`, refers to the section name and section ID, respectively.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param array $args Section arguments.
- */
- do_action( "elementor/element/{$section_name}/{$section_id}/before_section_start", $this, $args );
- $args['type'] = Controls_Manager::SECTION;
- $this->add_control( $section_id, $args );
- if ( null !== $this->current_section ) {
- wp_die( sprintf( 'Elementor: You can\'t start a section before the end of the previous section "%s".', $this->current_section['section'] ) ); // XSS ok.
- }
- $this->current_section = $this->get_section_args( $section_id );
- if ( $this->injection_point ) {
- $this->injection_point['section'] = $this->current_section;
- }
- /**
- * After section start.
- *
- * Fires after Elementor section starts in the editor panel.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param string $section_id Section ID.
- * @param array $args Section arguments.
- */
- do_action( 'elementor/element/after_section_start', $this, $section_id, $args );
- /**
- * After section start.
- *
- * Fires after Elementor section starts in the editor panel.
- *
- * The dynamic portions of the hook name, `$section_name` and `$section_id`, refers to the section name and section ID, respectively.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param array $args Section arguments.
- */
- do_action( "elementor/element/{$section_name}/{$section_id}/after_section_start", $this, $args );
- }
- /**
- * End controls section.
- *
- * Used to close an existing open controls section. When you use this method
- * it stops adding new controls to this section.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.4.0
- * @access public
- */
- public function end_controls_section() {
- $stack_name = $this->get_name();
- // Save the current section for the action.
- $current_section = $this->current_section;
- $section_id = $current_section['section'];
- $args = [
- 'tab' => $current_section['tab'],
- ];
- /**
- * Before section end.
- *
- * Fires before Elementor section ends in the editor panel.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param string $section_id Section ID.
- * @param array $args Section arguments.
- */
- do_action( 'elementor/element/before_section_end', $this, $section_id, $args );
- /**
- * Before section end.
- *
- * Fires before Elementor section ends in the editor panel.
- *
- * The dynamic portions of the hook name, `$stack_name` and `$section_id`, refers to the stack name and section ID, respectively.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param array $args Section arguments.
- */
- do_action( "elementor/element/{$stack_name}/{$section_id}/before_section_end", $this, $args );
- $this->current_section = null;
- /**
- * After section end.
- *
- * Fires after Elementor section ends in the editor panel.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param string $section_id Section ID.
- * @param array $args Section arguments.
- */
- do_action( 'elementor/element/after_section_end', $this, $section_id, $args );
- /**
- * After section end.
- *
- * Fires after Elementor section ends in the editor panel.
- *
- * The dynamic portions of the hook name, `$stack_name` and `$section_id`, refers to the section name and section ID, respectively.
- *
- * @since 1.4.0
- *
- * @param Controls_Stack $this The control.
- * @param array $args Section arguments.
- */
- do_action( "elementor/element/{$stack_name}/{$section_id}/after_section_end", $this, $args );
- }
- /**
- * Start controls tabs.
- *
- * Used to add a new set of tabs inside a section. You should use this
- * method before adding new individual tabs using `start_controls_tab()`.
- * Each tab added after this point will be assigned to this group of tabs,
- * until you close it using `end_controls_tabs()` method.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $tabs_id Tabs ID.
- */
- public function start_controls_tabs( $tabs_id ) {
- if ( null !== $this->current_tab ) {
- wp_die( sprintf( 'Elementor: You can\'t start tabs before the end of the previous tabs "%s".', $this->current_tab['tabs_wrapper'] ) ); // XSS ok.
- }
- $this->add_control(
- $tabs_id,
- [
- 'type' => Controls_Manager::TABS,
- ]
- );
- $this->current_tab = [
- 'tabs_wrapper' => $tabs_id,
- ];
- if ( $this->injection_point ) {
- $this->injection_point['tab'] = $this->current_tab;
- }
- }
- /**
- * End controls tabs.
- *
- * Used to close an existing open controls tabs. When you use this method it
- * stops adding new controls to this tabs.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.4.0
- * @access public
- */
- public function end_controls_tabs() {
- $this->current_tab = null;
- }
- /**
- * Start controls tab.
- *
- * Used to add a new tab inside a group of tabs. Use this method before
- * adding new individual tabs using `start_controls_tab()`.
- * Each tab added after this point will be assigned to this group of tabs,
- * until you close it using `end_controls_tab()` method.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string $tab_id Tab ID.
- * @param array $args Tab arguments.
- */
- public function start_controls_tab( $tab_id, $args ) {
- if ( ! empty( $this->current_tab['inner_tab'] ) ) {
- wp_die( sprintf( 'Elementor: You can\'t start a tab before the end of the previous tab "%s".', $this->current_tab['inner_tab'] ) ); // XSS ok.
- }
- $args['type'] = Controls_Manager::TAB;
- $args['tabs_wrapper'] = $this->current_tab['tabs_wrapper'];
- $this->add_control( $tab_id, $args );
- $this->current_tab['inner_tab'] = $tab_id;
- if ( $this->injection_point ) {
- $this->injection_point['tab']['inner_tab'] = $this->current_tab['inner_tab'];
- }
- }
- /**
- * End controls tab.
- *
- * Used to close an existing open controls tab. When you use this method it
- * stops adding new controls to this tab.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.4.0
- * @access public
- */
- public function end_controls_tab() {
- unset( $this->current_tab['inner_tab'] );
- }
- /**
- * Start popover.
- *
- * Used to add a new set of controls in a popover. When you use this method,
- * all the registered controls from this point will be assigned to this
- * popover, until you close the popover using `end_popover()` method.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.9.0
- * @access public
- */
- final public function start_popover() {
- $this->current_popover = [
- 'initialized' => false,
- ];
- }
- /**
- * End popover.
- *
- * Used to close an existing open popover. When you use this method it stops
- * adding new controls to this popover.
- *
- * This method should be used inside `_register_controls()`.
- *
- * @since 1.9.0
- * @access public
- */
- final public function end_popover() {
- $this->current_popover = null;
- $last_control_key = $this->get_control_key( $this->get_pointer_index() - 1 );
- $args = [
- 'popover' => [
- 'end' => true,
- ],
- ];
- $options = [
- 'recursive' => true,
- ];
- $this->update_control( $last_control_key, $args, $options );
- }
- /**
- * Print element template.
- *
- * Used to generate the element template on the editor.
- *
- * @since 2.0.0
- * @access public
- */
- public function print_template() {
- ob_start();
- $this->_content_template();
- $template_content = ob_get_clean();
- $element_type = $this->get_type();
- /**
- * Template content.
- *
- * Filters the controls stack template content before it's printed in the editor.
- *
- * The dynamic portion of the hook name, `$element_type`, refers to the element type.
- *
- * @since 1.0.0
- *
- * @param string $content_template The controls stack template in the editor.
- * @param Controls_Stack $this The controls stack.
- */
- $template_content = apply_filters( "elementor/{$element_type}/print_template", $template_content, $this );
- if ( empty( $template_content ) ) {
- return;
- }
- ?>
- <script type="text/html" id="tmpl-elementor-<?php echo esc_attr( $this->get_name() ); ?>-content">
- <?php $this->print_template_content( $template_content ); ?>
- </script>
- <?php
- }
- /**
- * Start injection.
- *
- * Used to inject controls and sections to a specific position in the stack.
- *
- * When you use this method, all the registered controls and sections will
- * be injected to a specific position in the stack, until you stop the
- * injection using `end_injection()` method.
- *
- * @since 1.7.1
- * @access public
- *
- * @param array $position {
- * The position where to start the injection.
- *
- * @type string $type Injection type, either `control` or `section`.
- * Default is `control`.
- * @type string $at Where to inject. If `$type` is `control` accepts
- * `before` and `after`. If `$type` is `section`
- * accepts `start` and `end`. Default values based on
- * the `type`.
- * @type string $of Control/Section ID.
- * }
- */
- final public function start_injection( array $position ) {
- if ( $this->injection_point ) {
- wp_die( 'A controls injection is already opened. Please close current injection before starting a new one (use `end_injection`).' );
- }
- $this->injection_point = $this->get_position_info( $position );
- }
- /**
- * End injection.
- *
- * Used to close an existing opened injection point.
- *
- * When you use this method it stops adding new controls and sections to
- * this point and continue to add controls to the regular position in the
- * stack.
- *
- * @since 1.7.1
- * @access public
- */
- final public function end_injection() {
- $this->injection_point = null;
- }
- /**
- * Get injection point.
- *
- * Retrieve the injection point in the stack where new controls and sections
- * will be inserted.
- *
- * @since 1.9.2
- * @access public
- *
- * @return array|null An array when an injection point is defined, null
- * otherwise.
- */
- final public function get_injection_point() {
- return $this->injection_point;
- }
- /**
- * Set settings.
- *
- * Change or add new settings to an existing control in the stack.
- *
- * @since 1.4.0
- * @access public
- *
- * @param string|array $key Setting name, or an array of key/value.
- * @param string|null $value Optional. Setting value. Optional field if
- * `$key` is an array. Default is null.
- */
- final public function set_settings( $key, $value = null ) {
- if ( ! $this->settings ) {
- $this->get_settings();
- }
- // strict check if override all settings.
- if ( is_array( $key ) ) {
- $this->settings = $key;
- } else {
- $this->settings[ $key ] = $value;
- }
- }
- /**
- * Register controls.
- *
- * Used to add new controls to any element type. For example, external
- * developers use this method to register controls in a widget.
- *
- * Should be inherited and register new controls using `add_control()`,
- * `add_responsive_control()` and `add_group_control()`, inside control
- * wrappers like `start_controls_section()`, `start_controls_tabs()` and
- * `start_controls_tab()`.
- *
- * @since 1.4.0
- * @access protected
- */
- protected function _register_controls() {}
- /**
- * Get default data.
- *
- * Retrieve the default data. Used to reset the data on initialization.
- *
- * @since 1.4.0
- * @access protected
- *
- * @return array Default data.
- */
- protected function get_default_data() {
- return [
- 'id' => 0,
- 'settings' => [],
- ];
- }
- /**
- * Get parsed settings.
- *
- * Retrieve the parsed settings for all the controls that represent them.
- * The parser set default values and process the settings.
- *
- * Classes that extend `Controls_Stack` can add new process to the settings
- * parser.
- *
- * @since 1.4.0
- * @access protected
- *
- * @return array Parsed settings.
- */
- protected function _get_parsed_settings() {
- $settings = $this->get_data( 'settings' );
- foreach ( $this->get_controls() as $control ) {
- $control_obj = Plugin::$instance->controls_manager->get_control( $control['type'] );
- if ( ! $control_obj instanceof Base_Data_Control ) {
- continue;
- }
- $control = array_merge_recursive( $control_obj->get_settings(), $control );
- $settings[ $control['name'] ] = $control_obj->get_value( $control, $settings );
- }
- return $settings;
- }
- /**
- * Sanitize initial data.
- *
- * Performs data cleaning and sanitization.
- *
- * @since 2.0.0
- * @deprecated 2.1.5 Use `Controls_Stack::sanitize_settings` instead
- * @access protected
- *
- * @param array $data Data to sanitize.
- * @param array $controls Optional. An array of controls. Default is an
- * empty array.
- *
- * @return array Sanitized data.
- */
- protected function sanitize_initial_data( $data, array $controls = [] ) {
- _deprecated_function( __METHOD__, '2.1.5', 'Controls_Stack::sanitize_settings' );
- $data['settings'] = $this->sanitize_settings( $data['settings'], $controls );
- return $data;
- }
- /**
- * Get initial config.
- *
- * Retrieve the current element initial configuration - controls list and
- * the tabs assigned to the control.
- *
- * @since 1.4.0
- * @access protected
- *
- * @return array The initial config.
- */
- protected function _get_initial_config() {
- return [
- 'controls' => $this->get_controls(),
- 'tabs_controls' => $this->get_tabs_controls(),
- ];
- }
- /**
- * Get section arguments.
- *
- * Retrieve the section arguments based on section ID.
- *
- * @since 1.4.0
- * @access protected
- *
- * @param string $section_id Section ID.
- *
- * @return array Section arguments.
- */
- protected function get_section_args( $section_id ) {
- $section_control = $this->get_controls( $section_id );
- $section_args_keys = [ 'tab', 'condition' ];
- $args = array_intersect_key( $section_control, array_flip( $section_args_keys ) );
- $args['section'] = $section_id;
- return $args;
- }
- /**
- * Render element.
- *
- * Generates the final HTML on the frontend.
- *
- * @since 2.0.0
- * @access protected
- */
- protected function render() {}
- /**
- * Print content template.
- *
- * Used to generate the content template on the editor, using a
- * Backbone JavaScript template.
- *
- * @access protected
- * @since 2.0.0
- *
- * @param string $template_content Template content.
- */
- protected function print_template_content( $template_content ) {
- echo $template_content;
- }
- /**
- * Render element output in the editor.
- *
- * Used to generate the live preview, using a Backbone JavaScript template.
- *
- * @since 2.0.0
- * @access protected
- */
- protected function _content_template() {}
- /**
- * Initialize controls.
- *
- * Register the all controls added by `_register_controls()`.
- *
- * @since 2.0.0
- * @access protected
- */
- protected function init_controls() {
- Plugin::$instance->controls_manager->open_stack( $this );
- $this->_register_controls();
- }
- /**
- * Initialize the class.
- *
- * Set the raw data, the ID and the parsed settings.
- *
- * @since 1.4.0
- * @access protected
- *
- * @param array $data Initial data.
- */
- protected function _init( $data ) {
- $this->data = array_merge( $this->get_default_data(), $data );
- $this->id = $data['id'];
- }
- /**
- * Sanitize initial data.
- *
- * Performs settings cleaning and sanitization.
- *
- * @since 2.1.5
- * @access private
- *
- * @param array $settings Settings to sanitize.
- * @param array $controls Optional. An array of controls. Default is an
- * empty array.
- *
- * @return array Sanitized settings.
- */
- private function sanitize_settings( array $settings, array $controls = [] ) {
- if ( ! $controls ) {
- $controls = $this->get_controls();
- }
- foreach ( $controls as $control ) {
- if ( 'repeater' === $control['type'] ) {
- if ( empty( $settings[ $control['name'] ] ) ) {
- continue;
- }
- foreach ( $settings[ $control['name'] ] as $index => $repeater_row_data ) {
- $sanitized_row_data = $this->sanitize_settings( $repeater_row_data, $control['fields'] );
- $settings[ $control['name'] ][ $index ] = $sanitized_row_data;
- }
- continue;
- }
- $is_dynamic = isset( $settings[ Manager::DYNAMIC_SETTING_KEY ][ $control['name'] ] );
- if ( ! $is_dynamic ) {
- continue;
- }
- $value_to_check = $settings[ Manager::DYNAMIC_SETTING_KEY ][ $control['name'] ];
- $tag_text_data = Plugin::$instance->dynamic_tags->tag_text_to_tag_data( $value_to_check );
- if ( ! Plugin::$instance->dynamic_tags->get_tag_info( $tag_text_data['name'] ) ) {
- unset( $settings[ Manager::DYNAMIC_SETTING_KEY ][ $control['name'] ] );
- }
- }
- return $settings;
- }
- /**
- * Controls stack constructor.
- *
- * Initializing the control stack class using `$data`. The `$data` is required
- * for a normal instance. It is optional only for internal `type instance`.
- *
- * @since 1.4.0
- * @access public
- *
- * @param array $data Optional. Control stack data. Default is an empty array.
- */
- public function __construct( array $data = [] ) {
- if ( $data ) {
- $this->_init( $data );
- }
- }
- }
|