Changeset 31370 for trunk/src/wp-includes/class-wp-customize-manager.php

Timestamp:

02/08/2015 11:10:05 PM (12 years ago)

Author:

ocean90

Message:

Customizer: Introduce an API to create WP_Customize_Settings for dynamically-created settings.

• Introduce WP_Customize_Manager::add_dynamic_settings() to register dynamically-created settings.
• Introduce customize_dynamic_setting_args filter to pass an array of args to a dynamic setting's constructor.
• Add unit tests for WP_Customize_Manager and WP_Customize_Widgets.
• See WP_Customize_Widgets as an example.

props westonruter.
fixes #30936.

File:

• trunk/src/wp-includes/class-wp-customize-manager.php (modified) (8 diffs)

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -66 +66 @@
          * Unsanitized values for Customize Settings parsed from $_POST['customized'].
          *
-         * @var array|false
+         * @var array
          */
         private $_post_values;
@@ -103 +103 @@
 
                 add_action( 'customize_register',                 array( $this, 'register_controls' ) );
+                add_action( 'customize_register',                 array( $this, 'register_dynamic_settings' ), 11 ); // allow code to create settings first
                 add_action( 'customize_controls_init',            array( $this, 'prepare_controls' ) );
                 add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_control_scripts' ) );
@@ -111 +112 @@
          *
          * @since 3.4.0
-         *
+         * @since 4.2.0 Added $action param.
+         *
+         * @param string|null $action whether the supplied Ajax action is being run.
          * @return bool
          */
-        public function doing_ajax() {
-                return isset( $_POST['customized'] ) || ( defined( 'DOING_AJAX' ) && DOING_AJAX );
+        public function doing_ajax( $action = null ) {
+                $doing_ajax = ( defined( 'DOING_AJAX' ) && DOING_AJAX );
+                if ( ! $doing_ajax ) {
+                        return false;
+                }
+
+                if ( ! $action ) {
+                        return true;
+                } else {
+                        // Note: we can't just use doing_action( "wp_ajax_{$action}" ) because we need to check before admin-ajax.php gets to that point
+                        return isset( $_REQUEST['action'] ) && wp_unslash( $_REQUEST['action'] ) === $action;
+                }
         }
 
@@ -412 +425 @@
                                 $this->_post_values = json_decode( wp_unslash( $_POST['customized'] ), true );
                         }
-                        if ( empty( $this->_post_values ) ) { // if not isset or of JSON error
-                                $this->_post_values = false;
+                        if ( empty( $this->_post_values ) ) { // if not isset or if JSON error
+                                $this->_post_values = array();
                         }
                 }
@@ -440 +453 @@
                         return $default;
                 }
+        }
+
+        /**
+         * Override a setting's (unsanitized) value as found in any incoming $_POST['customized']
+         *
+         * @since 4.2.0
+         *
+         * @param string $setting_id  The ID for the WP_Customize_Setting instance.
+         * @param mixed $value
+         */
+        public function set_post_value( $setting_id, $value ) {
+                $this->unsanitized_post_values();
+                $this->_post_values[ $setting_id ] = $value;
         }
 
@@ -728 +754 @@
 
         /**
+         * Register any dynamically-created settings, such as those from $_POST['customized'] that have no corresponding setting created.
+         *
+         * This is a mechanism to "wake up" settings that have been dynamically created
+         * on the frontend and have been sent to WordPress in $_POST['customized']. When WP
+         * loads, the dynamically-created settings then will get created and previewed
+         * even though they are not directly created statically with code.
+         *
+         * @since 4.2.0
+         *
+         * @param string[] $setting_ids The setting IDs to add.
+         * @return WP_Customize_Setting[] The settings added.
+         */
+        public function add_dynamic_settings( $setting_ids ) {
+                $new_settings = array();
+                foreach ( $setting_ids as $setting_id ) {
+                        // Skip settings already created
+                        if ( $this->get_setting( $setting_id ) ) {
+                                continue;
+                        }
+
+                        $setting_args = false;
+                        $setting_class = 'WP_Customize_Setting';
+
+                        /**
+                         * Filter a dynamic setting's constructor args.
+                         *
+                         * For a dynamic setting to be registered, this filter must be employed
+                         * to override the default false value with an array of args to pass to
+                         * the WP_Customize_Setting constructor.
+                         *
+                         * @since 4.2.0
+                         *
+                         * @param false|array $setting_args  The arguments to the WP_Customize_Setting constructor.
+                         * @param string      $setting_id    ID for dynamic setting, usually coming from $_POST['customized'].
+                         */
+                        $setting_args = apply_filters( 'customize_dynamic_setting_args', $setting_args, $setting_id );
+                        if ( false === $setting_args ) {
+                                continue;
+                        }
+
+                        /**
+                         * Allow non-statically created settings to be constructed with custom WP_Customize_Setting subclass.
+                         *
+                         * @since 4.2.0
+                         *
+                         * @param string $setting_class  WP_Customize_Setting or a subclass.
+                         * @param string $setting_id     ID for dynamic setting, usually coming from $_POST['customized'].
+                         * @param string $setting_args   WP_Customize_Setting or a subclass.
+                         */
+                        $setting_class = apply_filters( 'customize_dynamic_setting_class', $setting_class, $setting_id, $setting_args );
+
+                        $setting = new $setting_class( $this, $setting_id, $setting_args );
+                        $this->add_setting( $setting );
+                        $new_settings[] = $setting;
+                }
+                return $new_settings;
+        }
+
+        /**
          * Retrieve a customize setting.
          *
@@ -736 +821 @@
          */
         public function get_setting( $id ) {
-                if ( isset( $this->settings[ $id ] ) )
+                if ( isset( $this->settings[ $id ] ) ) {
                         return $this->settings[ $id ];
+                }
         }
 
@@ -1273 +1359 @@
                         ) );
                 }
+        }
+
+        /**
+         * Add settings from the POST data that were not added with code, e.g. dynamically-created settings for Widgets
+         *
+         * @since 4.2.0
+         */
+        public function register_dynamic_settings() {
+                $this->add_dynamic_settings( array_keys( $this->unsanitized_post_values() ) );
         }