Changeset 52219 for trunk/src/wp-includes/class-wp-block-pattern-categories-registry.php

Timestamp:

11/19/2021 07:04:01 PM (3 years ago)

Author:

desrosj

Message:

Docs: Improve the documentation for registering block patterns and block pattern categories.

This expands the @param tag for the property argument available for the register() method in WP_Block_Patterns_Registry and WP_Block_Pattern_Cattegories_Registry.

See #53399.

File:

• trunk/src/wp-includes/class-wp-block-pattern-categories-registry.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-block-pattern-categories-registry.php

@@ -34 +34 @@
      *
      * @param string $category_name       Pattern category name including namespace.
-     * @param array  $category_properties Array containing the properties of the category: label.
+     * @param array  $category_properties {
+     *     List of properties for the block pattern category.
+     *
+     *     @type string $label Required. A human-readable label for the pattern category.
+     * }
      * @return bool True if the pattern was registered with success and false otherwise.
      */
@@ -142 +146 @@
  *
  * @param string $category_name       Pattern category name including namespace.
- * @param array  $category_properties Array containing the properties of the category.
+ * @param array  $category_properties List of properties for the block pattern.
+ *                                    See WP_Block_Pattern_Categories_Registry::register() for
+ *                                    accepted arguments.
  * @return bool True if the pattern category was registered with success and false otherwise.
  */