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

Timestamp:

11/23/2021 09:35:57 PM (3 years ago)

Author:

johnbillion

Message:

Docs: Various docblock corrections and improvements.

See #53399

File:

• trunk/src/wp-includes/class-wp-block-patterns-registry.php (modified) (9 diffs)

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

@@ -9 +9 @@
 
 /**
- * Class used for interacting with patterns.
+ * Class used for interacting with block patterns.
  *
  * @since 5.5.0
@@ -15 +15 @@
 final class WP_Block_Patterns_Registry {
     /**
-     * Registered patterns array.
+     * Registered block patterns array.
      *
      * @since 5.5.0
@@ -31 +31 @@
 
     /**
-     * Registers a pattern.
-     *
-     * @since 5.5.0
-     *
-     * @param string $pattern_name       Pattern name including namespace.
-     * @param array $pattern_properties  {
+     * Registers a block pattern.
+     *
+     * @since 5.5.0
+     *
+     * @param string $pattern_name       Block pattern name including namespace.
+     * @param array  $pattern_properties {
      *     List of properties for the block pattern.
      *
      *     @type string $title         Required. A human-readable title for the pattern.
      *     @type string $content       Required. Block HTML markup for the pattern.
-     *     @type string $description   Visually hidden text used to describe the pattern in the
+     *     @type string $description   Optional. Visually hidden text used to describe the pattern in the
      *                                 inserter. A description is optional, but is strongly
      *                                 encouraged when the title does not fully describe what the
      *                                 pattern does. The description will help users discover the
-     *                                 pattern while searching. Optional.
-     *     @type int    $viewportWidth The intended width of the pattern to allow for a scaled
-     *                                 preview within the pattern inserter. Optional.
-     *     @type array  $categories    A list of registered pattern categories used to group block
+     *                                 pattern while searching.
+     *     @type int    $viewportWidth Optional. The intended width of the pattern to allow for a scaled
+     *                                 preview within the pattern inserter.
+     *     @type array  $categories    Optional. A list of registered pattern categories used to group block
      *                                 patterns. Block patterns can be shown on multiple categories.
      *                                 A category must be registered separately in order to be used
-     *                                 here. Optional.
-     *     @type array  $keywords      A list of aliases or keywords that help users discover the
-     *                                 pattern while searching. Optional.
+     *                                 here.
+     *     @type array  $keywords      Optional. A list of aliases or keywords that help users discover the
+     *                                 pattern while searching.
      * }
      * @return bool True if the pattern was registered with success and false otherwise.
@@ -94 +94 @@
 
     /**
-     * Unregisters a pattern.
-     *
-     * @since 5.5.0
-     *
-     * @param string $pattern_name Pattern name including namespace.
+     * Unregisters a block pattern.
+     *
+     * @since 5.5.0
+     *
+     * @param string $pattern_name Block pattern name including namespace.
      * @return bool True if the pattern was unregistered with success and false otherwise.
      */
@@ -118 +118 @@
 
     /**
-     * Retrieves an array containing the properties of a registered pattern.
-     *
-     * @since 5.5.0
-     *
-     * @param string $pattern_name Pattern name including namespace.
+     * Retrieves an array containing the properties of a registered block pattern.
+     *
+     * @since 5.5.0
+     *
+     * @param string $pattern_name Block pattern name including namespace.
      * @return array Registered pattern properties.
      */
@@ -134 +134 @@
 
     /**
-     * Retrieves all registered patterns.
-     *
-     * @since 5.5.0
-     *
-     * @return array Array of arrays containing the registered patterns properties,
+     * Retrieves all registered block patterns.
+     *
+     * @since 5.5.0
+     *
+     * @return array Array of arrays containing the registered block patterns properties,
      *               and per style.
      */
@@ -146 +146 @@
 
     /**
-     * Checks if a pattern is registered.
-     *
-     * @since 5.5.0
-     *
-     * @param string $pattern_name Pattern name including namespace.
+     * Checks if a block pattern is registered.
+     *
+     * @since 5.5.0
+     *
+     * @param string $pattern_name Block pattern name including namespace.
      * @return bool True if the pattern is registered, false otherwise.
      */
@@ -176 +176 @@
 
 /**
- * Registers a new pattern.
- *
- * @since 5.5.0
- *
- * @param string $pattern_name       Pattern name including namespace.
+ * Registers a new block pattern.
+ *
+ * @since 5.5.0
+ *
+ * @param string $pattern_name       Block pattern name including namespace.
  * @param array  $pattern_properties List of properties for the block pattern.
  *                                   See WP_Block_Patterns_Registry::register() for accepted arguments.
@@ -188 +188 @@
     return WP_Block_Patterns_Registry::get_instance()->register( $pattern_name, $pattern_properties );
 }
-/**
- * Unregisters a pattern.
- *
- * @since 5.5.0
- *
- * @param string $pattern_name Pattern name including namespace.
+
+/**
+ * Unregisters a block pattern.
+ *
+ * @since 5.5.0
+ *
+ * @param string $pattern_name Block pattern name including namespace.
  * @return bool True if the pattern was unregistered with success and false otherwise.
  */