Changeset 57731

Timestamp:

02/27/2024 09:03:54 PM (5 months ago)

Author:

joemcgill

Message:

Docs: Improve docblock for WP_Block_Patterns_Registry::register.

This documents the new filePath property supported by WP_Block_Patterns_Registry::register and also updates the property name to camel case formatting to be consistent with other block pattern properties.

Props thekt12, spacedmonkey, joemcgill.
See #59532.

Location:

trunk

Files:

• src/wp-includes/block-patterns.php (modified) (1 diff)
• src/wp-includes/class-wp-block-patterns-registry.php (modified) (5 diffs)
• tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php (modified) (2 diffs)

trunk/src/wp-includes/block-patterns.php

@@ -392 +392 @@
             }
 
-            $pattern_data['file_path'] = $file_path;
+            $pattern_data['fileath'] = $file_path;
 
             // Translate the pattern metadata.

trunk/src/wp-includes/class-wp-block-patterns-registry.php

@@ -46 +46 @@
      * @since 6.1.0 Added support for the `postTypes` property.
      * @since 6.2.0 Added support for the `templateTypes` property.
+
      *
      * @param string $pattern_name       Block pattern name including namespace.
@@ -52 +53 @@
      *
      *     @type string   $title         Required. A human-readable title for the pattern.
-     *     @type string   $content       Required. Block HTML markup for the pattern.
+     *     @type string   $content       Optional. Block HTML markup for the pattern.
+     *                                   If not provided, the content will be retrieved from the `filePath` if set.
+     *                                   If both `content` and `filePath` are not set, the pattern will not be registered.
      *     @type string   $description   Optional. Visually hidden text used to describe the pattern
      *                                   in the inserter. A description is optional, but is strongly
@@ -80 +83 @@
      *                                   not part of the array the pattern is not available at all.
      *     @type string[] $templateTypes Optional. An array of template types where the pattern fits.
+
      * }
      * @return bool True if the pattern was registered with success and false otherwise.
@@ -102 +106 @@
         }
 
-        if ( ! isset( $pattern_properties['file_path'] ) ) {
+        if ( ! isset( $pattern_properties['fileath'] ) ) {
             if ( ! isset( $pattern_properties['content'] ) || ! is_string( $pattern_properties['content'] ) ) {
                 _doing_it_wrong(
@@ -195 +199 @@
             $patterns = &$this->registered_patterns;
         }
-        if ( ! isset( $patterns[ $pattern_name ]['content'] ) && isset( $patterns[ $pattern_name ]['file_path'] ) ) {
+        if ( ! isset( $patterns[ $pattern_name ]['content'] ) && isset( $patterns[ $pattern_name ]['fileath'] ) ) {
             ob_start();
-            include $patterns[ $pattern_name ]['file_path'];
+            include $patterns[ $pattern_name ]['fileath'];
             $patterns[ $pattern_name ]['content'] = ob_get_clean();
-            unset( $patterns[ $pattern_name ]['file_path'] );
+            unset( $patterns[ $pattern_name ]['fileath'] );
         }
         return $patterns[ $pattern_name ]['content'];

trunk/tests/phpunit/tests/blocks/wpBlockPatternsRegistry.php

@@ -580 +580 @@
 
         $this->assertTrue(
-            isset( $registered_patterns[ $pattern_name ]['file_path'] ) &&
+            isset( $registered_patterns[ $pattern_name ]['fileath'] ) &&
             ! isset( $registered_patterns[ $pattern_name ]['content'] ),
             'Pattern was not lazy loaded.'
@@ -634 +634 @@
 
         $this->assertTrue(
-            isset( $registered_patterns[ $pattern_name ]['file_path'] ) &&
+            isset( $registered_patterns[ $pattern_name ]['fileath'] ) &&
             ! isset( $registered_patterns[ $pattern_name ]['content'] ),
             'Pattern was not lazy loaded.'