Changeset 14190

Timestamp:

11/21/2024 07:16:33 PM (2 months ago)

Author:

ryelle

Message:

Theme Previews: Filter out duplicate style variations

If there are duplicate style variations, it's likely that one is a subset (color palette or type set) and one is combined. Find the one with more settings and use that.

Merges WordPress/wordpress.org#425, fixes WordPress/wporg-theme-directory#158.

Location:

sites/trunk/wp-themes.com/public_html/wp-content/plugins/style-variations

Files:

• inc/page-intercept.php (modified) (3 diffs)
• inc/styles-endpoint.php (modified) (2 diffs)
• style-variations.php (modified) (1 diff)

sites/trunk/wp-themes.com/public_html/wp-content/plugins/style-variations/inc/page-intercept.php

@@ -2 +2 @@
 
 namespace WordPressdotorg\Theme_Preview\Style_Variations\Page_Intercept;
+
+use function WordPressdotorg\Theme_Preview\Style_Variations\get_style_variations;
 
 /**
@@ -30 +32 @@
      * Retrieve all variations and match to make sure we have one with the same title.
      */
-    $variations = \WP_Theme_JSON_Resolver::get_style_variations();
+    $variations = get_style_variations();
     if ( empty( $variations ) ) {
         return false;
@@ -99 +101 @@
  * We need to call gutenberg's filter `theme_json_user` to make sure the styles are applied to the page.
  * This use to work for both the page and card but a core change stopped that.
- * 
+ *
  * See: https://core.trac.wordpress.org/ticket/56812
- * 
+ *
  * We now need to also call the core filter `wp_theme_json_data_user` to get the card preview to work.
  * Hopefully this code can be remove when we have a better component to use.
- * 
+ *
  * Ref: https://github.com/WordPress/gutenberg/issues/44886
 

sites/trunk/wp-themes.com/public_html/wp-content/plugins/style-variations/inc/styles-endpoint.php

@@ -3 +3 @@
 namespace WordPressdotorg\Theme_Preview\Style_Variations\API_Endpoint;
 
+use function WordPressdotorg\Theme_Preview\Style_Variations\get_style_variations;
+
 function endpoint_handler() {
-    $variations = \WP_Theme_JSON_Resolver::get_style_variations();
+    $variations = get_style_variations();
     $theme_slug = get_option( 'stylesheet' );
     $styles     = array();
@@ -26 +28 @@
         foreach ( $variations as $variation ) {
             $title = strtolower( $variation['title'] );
-            $link  = add_query_arg( 'style_variation', urlencode( $title ), $base );;
+            $link  = add_query_arg( 'style_variation', urlencode( $title ), $base );
 
             $styles[] = array(

sites/trunk/wp-themes.com/public_html/wp-content/plugins/style-variations/style-variations.php

@@ -13 +13 @@
 defined( 'WPINC' ) || die();
 
+/**
+ * Get unique style variations.
+ *
+ * If there are multiple variations matching a title, use the longest. This is
+ * a rough way to check for full (combined) style variations, as opposed to
+ * color palettes or type sets.
+ *
+ * @return array Variation list, or empty array.
+ */
+function get_style_variations() {
+    $variations = array();
+    $all_variations = \WP_Theme_JSON_Resolver::get_style_variations();
+
+    foreach ( $all_variations as $variation ) {
+        // Safety check: variations must have a title and settings.
+        if ( ! isset( $variation['title'], $variation['settings'] ) ) {
+            continue;
+        }
+        $found_variations = wp_list_filter(
+            $variations,
+            array( 'title' => $variation['title'] )
+        );
+        if ( ! $found_variations ) {
+            $variations[] = $variation;
+        } else {
+            // Loop over the found variations, even though there should only
+            // ever be one, to keep track of the index value.
+            foreach ( $found_variations as $i => $found ) {
+                $found_settings = wp_json_encode( $found );
+                $new_settings = wp_json_encode( $variation );
+                if ( strlen( $new_settings ) > strlen( $found_settings ) ) {
+                    // Replace the item in the variations list.
+                    $variations[ $i ] = $variation;
+                }
+            }
+        }
+    }
+
+    return $variations;
+}
+
 require_once __DIR__ . '/inc/global-style-page.php';
 require_once __DIR__ . '/inc/page-intercept.php';