Changeset 41205 for trunk/src/wp-includes/theme.php

Timestamp:

08/02/2017 05:34:32 AM (6 years ago)

Author:

westonruter

Message:

Customize: Introduce settings_previewed arg and getter on WP_Customize_Manager which controls whether WP_Customize_Setting::preview() should be called on settings.

The settings_previewed property eliminates the need for the Customizer components from having to look at global doing_ajax state. This is in particular needed when saving settings, as some settings will short-circuit the update operation if they detect no changes are introduced. This is also needed for low-level integrations with the Customizer, such as in REST API endpoints under development.

Props stubgo, westonruter, utkarshpatel for testing.
See #38900.
Fixes #39221.

File:

• trunk/src/wp-includes/theme.php (modified) (2 diffs)

trunk/src/wp-includes/theme.php

@@ -2817 +2817 @@
     }
 
+    /*
+     * Note that settings must be previewed even outside the customizer preview
+     * and also in the customizer pane itself. This is to enable loading an existing
+     * changeset into the customizer. Previewing the settings only has to be prevented
+     * here in the case of a customize_save action because this will cause WP to think
+     * there is nothing changed that needs to be saved.
+     */
+    $is_customize_save_action = (
+        wp_doing_ajax()
+        &&
+        isset( $_REQUEST['action'] )
+        &&
+        'customize_save' === wp_unslash( $_REQUEST['action'] )
+    );
+    $settings_previewed = ! $is_customize_save_action;
+
     require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
-    $GLOBALS['wp_customize'] = new WP_Customize_Manager( compact( 'changeset_uuid', 'theme', 'messenger_channel' ) );
+    $GLOBALS['wp_customize'] = new WP_Customize_Manager( compact( 'changeset_uuid', 'theme', 'messenger_channel', 'settings_previewed' ) );
 }
 
@@ -2850 +2866 @@
     if ( empty( $wp_customize ) ) {
         require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
-        $wp_customize = new WP_Customize_Manager( array( 'changeset_uuid' => $changeset_post->post_name ) );
+        $wp_customize = new WP_Customize_Manager( array(
+            'changeset_uuid' => $changeset_post->post_name,
+            'settings_previewed' => false,
+        ) );
     }