Changeset 52757 for trunk/src/wp-includes/block-supports/duotone.php

Timestamp:

02/17/2022 04:16:59 PM (3 years ago)

Author:

audrasjb

Message:

Editor: Backport Duotone fixes for 5.9.1.

This changeset is a backport for the following Gutenberg PRs:

• Fix duotone theme cache gutenberg#36236
• Fix duotone render in non-fse themes gutenberg#37954
• Duotone: Allow users to specify custom filters gutenberg#38442

Props oandregal, scruffian, Mamaduka.
See #55179.

File:

• trunk/src/wp-includes/block-supports/duotone.php (modified) (6 diffs)

trunk/src/wp-includes/block-supports/duotone.php

@@ -353 +353 @@
 }
 
-
-/**
- * Registers the style and colors block attributes for block types that support it.
- *
- * @since 5.8.0
- * @access private
- *
- * @param WP_Block_Type $block_type Block Type.
- */
-function wp_register_duotone_support( $block_type ) {
-    $has_duotone_support = false;
-    if ( property_exists( $block_type, 'supports' ) ) {
-        $has_duotone_support = _wp_array_get( $block_type->supports, array( 'color', '__experimentalDuotone' ), false );
-    }
-
-    if ( $has_duotone_support ) {
-        if ( ! $block_type->attributes ) {
-            $block_type->attributes = array();
-        }
-
-        if ( ! array_key_exists( 'style', $block_type->attributes ) ) {
-            $block_type->attributes['style'] = array(
-                'type' => 'object',
-            );
-        }
-    }
-}
-
-/**
- * Renders the duotone filter SVG and returns the CSS filter property to
- * reference the rendered SVG.
+/**
+ * Returns the prefixed id for the duotone filter for use as a CSS id.
+ *
+ * @since 5.9.1
+ * @access private
+ *
+ * @param array $preset Duotone preset value as seen in theme.json.
+ * @return string Duotone filter CSS id.
+ */
+function wp_get_duotone_filter_id( $preset ) {
+    if ( ! isset( $preset['slug'] ) ) {
+        return '';
+    }
+
+    return 'wp-duotone-' . $preset['slug'];
+}
+
+/**
+ * Returns the CSS filter property url to reference the rendered SVG.
  *
  * @since 5.9.0
  * @access private
-
+ *
  * @param array $preset Duotone preset value as seen in theme.json.
- * @return string Duotone CSS filter property.
- */
-function wp_render_duotone_filter_preset( $preset ) {
-    $duotone_id     = $preset['slug'];
-    $duotone_colors = $preset['colors'];
-    $filter_id      = 'wp-duotone-' . $duotone_id;
+ * @return string Duotone CSS filter property url value.
+ */
+function wp_get_duotone_filter_property( $preset ) {
+    $filter_id = wp_get_duotone_filter_id( $preset );
+    return "url('#" . $filter_id . "')";
+}
+
+/**
+ * Returns the duotone filter SVG string for the preset.
+ *
+ * @since 5.9.1
+ * @access private
+ *
+ * @param array $preset Duotone preset value as seen in theme.json.
+ * @return string Duotone SVG filter.
+ */
+function wp_get_duotone_filter_svg( $preset ) {
+    $filter_id = wp_get_duotone_filter_id( $preset );
+
     $duotone_values = array(
         'r' => array(),
@@ -401 +402 @@
         'a' => array(),
     );
-    foreach ( $duotone_colors as $color_str ) {
+
+    if ( ! isset( $preset['colors'] ) || ! is_array( $preset['colors'] ) ) {
+        $preset['colors'] = array();
+    }
+
+    foreach ( $preset['colors'] as $color_str ) {
         $color = wp_tinycolor_string_to_rgb( $color_str );
 
@@ -457 +463 @@
     }
 
-    add_action(
-        // Safari doesn't render SVG filters defined in data URIs,
-        // and SVG filters won't render in the head of a document,
-        // so the next best place to put the SVG is in the footer.
-        is_admin() ? 'admin_footer' : 'wp_footer',
-        function () use ( $svg ) {
-            echo $svg;
+    return $svg;
+}
+
+/**
+ * Registers the style and colors block attributes for block types that support it.
+ *
+ * @since 5.8.0
+ * @access private
+ *
+ * @param WP_Block_Type $block_type Block Type.
+ */
+function wp_register_duotone_support( $block_type ) {
+    $has_duotone_support = false;
+    if ( property_exists( $block_type, 'supports' ) ) {
+        $has_duotone_support = _wp_array_get( $block_type->supports, array( 'color', '__experimentalDuotone' ), false );
+    }
+
+    if ( $has_duotone_support ) {
+        if ( ! $block_type->attributes ) {
+            $block_type->attributes = array();
         }
-    );
-
-    return "url('#" . $filter_id . "')";
+
+        if ( ! array_key_exists( 'style', $block_type->attributes ) ) {
+            $block_type->attributes['style'] = array(
+                'type' => 'object',
+            );
+        }
+    }
 }
 
@@ -501 +524 @@
         'colors' => $block['attrs']['style']['color']['duotone'],
     );
-    $filter_property = wp_render_duotone_filter_preset( $filter_preset );
-    $filter_id       = 'wp-duotone-' . $filter_preset['slug'];
+    $filter_property = wp_get_duotone_filter_property( $filter_preset );
+    $filter_id       = wp_get_duotone_filter_id( $filter_preset );
+    $filter_svg      = wp_get_duotone_filter_svg( $filter_preset );
 
     $scope     = '.' . $filter_id;
@@ -521 +545 @@
     wp_add_inline_style( $filter_id, $filter_style );
     wp_enqueue_style( $filter_id );
+
+    add_action(
+        'wp_footer',
+        static function () use ( $filter_svg, $selector ) {
+            echo $filter_svg;
+
+            /*
+             * Safari renders elements incorrectly on first paint when the SVG
+             * filter comes after the content that it is filtering, so we force
+             * a repaint with a WebKit hack which solves the issue.
+             */
+            global $is_safari;
+            if ( $is_safari ) {
+                printf(
+                    // Simply accessing el.offsetHeight flushes layout and style
+                    // changes in WebKit without having to wait for setTimeout.
+                    '<script>( function() { var el = document.querySelector( %s ); var display = el.style.display; el.style.display = "none"; el.offsetHeight; el.style.display = display; } )();</script>',
+                    wp_json_encode( $selector )
+                );
+            }
+        }
+    );
 
     // Like the layout hook, this assumes the hook only applies to blocks with a single wrapper.
@@ -539 +585 @@
 );
 add_filter( 'render_block', 'wp_render_duotone_support', 10, 2 );
+
+/**
+ * Render the SVG filters supplied by theme.json.
+ *
+ * Note that this doesn't render the per-block user-defined
+ * filters which are handled by wp_render_duotone_support,
+ * but it should be rendered in the same location as those to satisfy
+ * Safari's rendering quirks.
+ *
+ * @since 5.9.1
+ */
+function wp_global_styles_render_svg_filters() {
+    $filters = wp_get_global_styles_svg_filters();
+    if ( ! empty( $filters ) ) {
+        echo $filters;
+    }
+}
+add_action( 'wp_body_open', 'wp_global_styles_render_svg_filters' );