Changeset 53675

Timestamp:

07/06/2022 04:26:08 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Block Patterns: Update the value used for keywords.

Patterns on the ​Pattern Directory can have keywords for better discoverability while searching. The way these are stored ​was changed from a taxonomy to meta value, but the /wp/v2/pattern-directory/patterns endpoint was still pulling from that old value.

The correct property to use for this field is meta.wpop_keywords, which returns a single string with comma-separated keywords.

Follow-up to [51021].

Props ryelle, TimothyBlynJacobs.
Merges [53665] to the 5.8 branch.
See #56126.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php (modified) (2 diffs)
• tests/phpunit/data/blocks/pattern-directory/browse-all.json (modified) (3 diffs)
• tests/phpunit/data/blocks/pattern-directory/browse-category-2.json (modified) (2 diffs)
• tests/phpunit/data/blocks/pattern-directory/browse-keyword-11.json (modified) (3 diffs)
• tests/phpunit/data/blocks/pattern-directory/search-button.json (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php (modified) (2 diffs)

branches/5.8/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

@@ -211 +211 @@
             'content'        => wp_kses_post( $raw_pattern->pattern_content ),
             'categories'     => array_map( 'sanitize_title', $raw_pattern->category_slugs ),
-            'keywords'       => array_map( 'sanitize_title', $raw_pattern->keyword_slugs ),
+            'keywords'       => array_map( 'sanitize_text_field', explode( ',', $raw_pattern->meta->wpop_keywords ) ),
             'description'    => sanitize_text_field( $raw_pattern->meta->wpop_description ),
             'viewport_width' => absint( $raw_pattern->meta->wpop_viewport_width ),
@@ -279 +279 @@
 
                 'keywords'       => array(
-                    'description' => __( "The pattern's keyword slugs." ),
+                    'description' => __( "The pattern's keywords." ),
                     'type'        => 'array',
                     'uniqueItems' => true,

branches/5.8/tests/phpunit/data/blocks/pattern-directory/browse-all.json

@@ -10 +10 @@
             "spay_email": "",
             "wpop_description": "A heading preceded by a chapter number, and followed by a paragraph.",
+            "wpop_keywords": "blog post",
             "wpop_viewport_width": 1000
         },
@@ -26 +27 @@
             "spay_email": "",
             "wpop_description": "A large hero section with an example background image and a heading in the center.",
+            "wpop_keywords": "header, hero",
             "wpop_viewport_width": 1000
         },
@@ -42 +44 @@
             "spay_email": "",
             "wpop_description": "A large hero section with a bright gradient background, a big heading and a filled button.",
+            "wpop_keywords": "call to action, hero section",
             "wpop_viewport_width": 1000
         },

branches/5.8/tests/phpunit/data/blocks/pattern-directory/browse-category-2.json

@@ -10 +10 @@
             "spay_email": "",
             "wpop_description": "Three filled buttons with rounded corners, side by side.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 600
         },
@@ -26 +27 @@
             "spay_email": "",
             "wpop_description": "Two buttons, one filled and one outlined, side by side.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 500
         },

branches/5.8/tests/phpunit/data/blocks/pattern-directory/browse-keyword-11.json

@@ -10 +10 @@
             "spay_email": "",
             "wpop_description": "A heading preceded by a chapter number, and followed by a paragraph.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 1000
         },
@@ -26 +27 @@
             "spay_email": "",
             "wpop_description": "A large hero section with an example background image and a heading in the center.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 1000
         },
@@ -42 +44 @@
             "spay_email": "",
             "wpop_description": "A large hero section with a bright gradient background, a big heading and a filled button.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 1000
         },

branches/5.8/tests/phpunit/data/blocks/pattern-directory/search-button.json

@@ -10 +10 @@
             "spay_email": "",
             "wpop_description": "A large hero section with a bright gradient background, a big heading and a filled button.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 1000
         },
@@ -26 +27 @@
             "spay_email": "",
             "wpop_description": "Three small columns of text, each with an outlined button with rounded corners at the bottom.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 1000
         },
@@ -42 +44 @@
             "spay_email": "",
             "wpop_description": "Three filled buttons with rounded corners, side by side.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 600
         },
@@ -58 +61 @@
             "spay_email": "",
             "wpop_description": "Two buttons, one filled and one outlined, side by side.",
+            "wpop_keywords": "",
             "wpop_viewport_width": 500
         },

branches/5.8/tests/phpunit/tests/rest-api/rest-pattern-directory-controller.php

@@ -101 +101 @@
 
         array_walk( $patterns, array( $this, 'assertPatternMatchesSchema' ) );
+        $this->assertSame( array( 'blog post' ), $patterns[0]['keywords'] );
+        $this->assertSame( array( 'header', 'hero' ), $patterns[1]['keywords'] );
+        $this->assertSame( array( 'call to action', 'hero section' ), $patterns[2]['keywords'] );
     }
 
@@ -147 +150 @@
 
         array_walk( $patterns, array( $this, 'assertPatternMatchesSchema' ) );
-
-        foreach ( $patterns as $pattern ) {
-            $this->assertContains( 'core', $pattern['keywords'] );
-        }
     }