Changeset 39209 for trunk/src/wp-includes/customize/class-wp-customize-custom-css-setting.php

Timestamp:

11/13/2016 02:42:04 AM (8 years ago)

Author:

westonruter

Message:

Customize: Improve extensibility of Custom CSS.

• Add customize_value_custom_css filter to WP_Customize_Custom_CSS::value() method.
• Introduce customize_update_custom_css_post_content_args filter in WP_Customize_Custom_CSS::update() method.
• Make clear that wp_get_custom_css() and wp_get_custom_css filter are specifically for obtaining the value to render/display. Eliminate use of wp_get_custom_css() when getting the setting value. Use the underlying post_value directly when is_previewed.
• Move anonymous functions handing JS previewing for custom_logo, custom_css, and background into named functions on the wp.customize.settingPreviewHandlers to allow plugins to override/extend preview logic.
• Update _custom_background_cb to always print a style tag wen in the customizer preview, and update background preview logic to replace existing style element instead of appending a new style to the head so that background changes don't unexpectedly override any Custom CSS in the preview's stylesheet cascade.

Props westonruter, georgestephanis.
See #22058.
Fixes #38672.

File:

• trunk/src/wp-includes/customize/class-wp-customize-custom-css-setting.php (modified) (3 diffs)

trunk/src/wp-includes/customize/class-wp-customize-custom-css-setting.php

@@ -101 +101 @@
 
     /**
-     * Filter wp_get_custom_css for applying customized value to return value.
+     * Filter `wp_get_custom_css` for applying the customized value.
+     *
+     * This is used in the preview when `wp_get_custom_css()` is called for rendering the styles.
      *
      * @since 4.7.0
      * @access private
+     * @see wp_get_custom_css()
      *
      * @param string $css        Original CSS.
@@ -121 +124 @@
 
     /**
-     * Fetch the value of the setting.
-     *
-     * @since 4.7.0
-     * @access public
+     * Fetch the value of the setting. Will return the previewed value when `preview()` is called.
+     *
+     * @since 4.7.0
+     * @access public
+     * @see WP_Customize_Setting::value()
      *
      * @return string
      */
     public function value() {
-        $value = wp_get_custom_css( $this->stylesheet );
+        $id_base = $this->id_data['base'];
+        if ( $this->is_previewed && null !== $this->post_value( null ) ) {
+            return $this->post_value();
+        }
+        $value = '';
+        $post = wp_get_custom_css_post( $this->stylesheet );
+        if ( $post ) {
+            $value = $post->post_content;
+        }
         if ( empty( $value ) ) {
             $value = $this->default;
         }
+
+        /** This filter is documented in wp-includes/class-wp-customize-setting.php */
+        $value = apply_filters( "customize_value_{$id_base}", $value, $this );
+
         return $value;
     }
@@ -227 +243 @@
      */
     public function update( $css ) {
+        $setting = $this;
+
+        if ( empty( $css ) ) {
+            $css = '';
+        }
 
         $args = array(
-            'post_content' => $css ? $css : '',
-            'post_title' => $this->stylesheet,
-            'post_name' => sanitize_title( $this->stylesheet ),
-            'post_type' => 'custom_css',
-            'post_status' => 'publish',
+            'post_content' => $css,
+            'post_content_filtered' => '',
+        );
+
+        /**
+         * Filters the `post_content` and `post_content_filtered` args for a `custom_css` post being updated.
+         *
+         * This filter can be used by plugin that offer CSS pre-processors, to store the original
+         * pre-processed CSS in `post_content_filtered` and then store processed CSS in `post_content`.
+         * When used in this way, the `post_content_filtered` should be supplied as the setting value
+         * instead of `post_content` via a the `customize_value_custom_css` filter, for example:
+         *
+         * <code>
+         * add_filter( 'customize_value_custom_css', function( $value, $setting ) {
+         *     $post = wp_get_custom_css_post( $setting->stylesheet );
+         *     if ( $post && ! empty( $post->post_content_filtered ) ) {
+         *         $css = $post->post_content_filtered;
+         *     }
+         *     return $css;
+         * }, 10, 2 );
+         * </code>
+         *
+         * @since 4.7.0
+         * @param array  $args {
+         *     Content post args (unslashed) for `wp_update_post()`/`wp_insert_post()`.
+         *
+         *     @type string $post_content          CSS.
+         *     @type string $post_content_filtered Pre-processed CSS. Normally empty string.
+         * }
+         * @param string                          $css     Original CSS being updated.
+         * @param WP_Customize_Custom_CSS_Setting $setting Custom CSS Setting.
+         */
+        $args = apply_filters( 'customize_update_custom_css_post_content_args', $args, $css, $setting );
+        $args = wp_array_slice_assoc( $args, array( 'post_content', 'post_content_filtered' ) );
+
+        $args = array_merge(
+            $args,
+            array(
+                'post_title' => $this->stylesheet,
+                'post_name' => sanitize_title( $this->stylesheet ),
+                'post_type' => 'custom_css',
+                'post_status' => 'publish',
+            )
         );