Make WordPress Core


Ignore:
Timestamp:
11/19/2021 07:04:01 PM (2 months 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-block-pattern-categories-registry.php

    r51154 r52219  
    3434     *
    3535     * @param string $category_name       Pattern category name including namespace.
    36      * @param array  $category_properties Array containing the properties of the category: label.
     36     * @param array  $category_properties {
     37     *     List of properties for the block pattern category.
     38     *
     39     *     @type string $label Required. A human-readable label for the pattern category.
     40     * }
    3741     * @return bool True if the pattern was registered with success and false otherwise.
    3842     */
     
    142146 *
    143147 * @param string $category_name       Pattern category name including namespace.
    144  * @param array  $category_properties Array containing the properties of the category.
     148 * @param array  $category_properties List of properties for the block pattern.
     149 *                                    See WP_Block_Pattern_Categories_Registry::register() for
     150 *                                    accepted arguments.
    145151 * @return bool True if the pattern category was registered with success and false otherwise.
    146152 */
Note: See TracChangeset for help on using the changeset viewer.