Changeset 50419 for trunk/src/wp-includes/class-wp-block-type-registry.php

Timestamp:

02/23/2021 07:16:26 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for WP_Block_Type properties.

Add a reference to WP_Block_Type::__construct() for information on accepted arguments in register_block_type().

Synchronize the documentation between several places, use WP_Block_Type::__construct() as the canonical source.

Props ediamin, audrasjb, peterwilsoncc.
Fixes #48640.

File:

• trunk/src/wp-includes/class-wp-block-type-registry.php (modified) (1 diff)

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

@@ -35 +35 @@
      * @since 5.0.0
      *
+     * @see WP_Block_Type::__construct()
+     *
      * @param string|WP_Block_Type $name Block type name including namespace, or alternatively
      *                                   a complete WP_Block_Type instance. In case a WP_Block_Type
      *                                   is provided, the $args parameter will be ignored.
-     * @param array                $args {
-     *     Optional. Array of block type arguments. Accepts any public property of `WP_Block_Type`.
-     *     Any arguments may be defined, however the ones described below are supported by default.
-     *     Default empty array.
-     *
-     *     @type callable $render_callback Callback used to render blocks of this block type.
-     *     @type array    $attributes      Block attributes mapping, property name to schema.
-     * }
+     * @param array                $args Optional. Array of block type arguments. Accepts any public property
+     *                                   of `WP_Block_Type`. See WP_Block_Type::__construct() for information
+     *                                   on accepted arguments. Default empty array.
      * @return WP_Block_Type|false The registered block type on success, or false on failure.
      */