Changeset 63495

Timestamp:

09/05/2026 09:32:30 AM (6 weeks ago)

Author:

wildworks

Message:

Docs: Align @param tag columns in block editor docblocks.

Aligns @param tag columns in docblocks across the block editor per the PHP inline documentation standards.

Developed in: ​https://github.com/WordPress/wordpress-develop/pull/13311

Props mukesh27, wildworks.
See #65818.

Location:

trunk/src

Files:

• wp-admin/widgets-form-blocks.php (modified) (1 diff)
• wp-includes/block-supports/layout.php (modified) (1 diff)
• wp-includes/block-supports/settings.php (modified) (1 diff)
• wp-includes/block-template-utils.php (modified) (3 diffs)
• wp-includes/blocks.php (modified) (1 diff)
• wp-includes/class-wp-theme-json-schema.php (modified) (3 diffs)
• wp-includes/class-wp-theme-json.php (modified) (6 diffs)
• wp-includes/style-engine/class-wp-style-engine-css-rules-store.php (modified) (1 diff)

trunk/src/wp-admin/widgets-form-blocks.php

@@ -122 +122 @@
                  * @since 6.4.0
                  *
-                 * @param string $message The message being displayed.
+                 * @param string $message   The message being displayed.
                  * @param bool   $installed Whether the Classic Widget plugin is installed.
                  */

trunk/src/wp-includes/block-supports/layout.php

@@ -1564 +1564 @@
  *
  * @param string $block_content Rendered block content.
- * @param  array  $block        Block object.
+ * @param array  $block         Block object.
  * @return string Filtered block content.
  */

trunk/src/wp-includes/block-supports/settings.php

@@ -70 +70 @@
  * @access private
  *
- * @param string|null $pre_render   The pre-rendered content. Default null.
- * @param array       $block The block being rendered.
+ * @param string|null $pre_render The pre-rendered content. Default null.
+ * @param array       $block      The block being rendered.
  * @return null
  */

trunk/src/wp-includes/block-template-utils.php

@@ -1116 +1116 @@
          * @param WP_Block_Template[]|null $block_templates Return an array of block templates to short-circuit the default query,
          *                                                  or null to allow WP to run its normal queries.
-         * @param array  $query {
+         * @param array                    $query {
          *     Arguments to retrieve templates. All arguments are optional.
          *
@@ -1124 +1124 @@
          *     @type string   $post_type Post type to get the templates for.
          * }
-         * @param string $template_type Template type. Either 'wp_template' or 'wp_template_part'.
+         * @param string                   $template_type   Template type. Either 'wp_template' or 'wp_template_part'.
          */
         $templates = apply_filters( 'pre_get_block_templates', null, $query, $template_type );
@@ -1265 +1265 @@
          * @since 5.9.0
          *
-         * @param WP_Block_Template[] $query_result Array of found block templates.
+         * @param WP_Block_Template[] $query_result  Array of found block templates.
          * @param array               $query {
          *     Arguments to retrieve templates. All arguments are optional.

trunk/src/wp-includes/blocks.php

@@ -1259 +1259 @@
  * @access private
  *
- * @param string       $content  Serialized content.
- * @param WP_Post|null $post     A post object that the content belongs to. If set to `null`,
- *                               `get_post()` will be called to use the current post as context.
- *                               Default: `null`.
- * @param callable     $callback A function that will be called for each block to generate
- *                               the markup for a given list of blocks that are hooked to it.
- *                               Default: 'insert_hooked_blocks'.
+ * @param string       $content                       Serialized content.
+ * @param WP_Post|null $post                          A post object that the content belongs to. If set to `null`,
+ *                                                    `get_post()` will be called to use the current post as context.
+ *                                                    Default: `null`.
+ * @param callable     $callback                      A function that will be called for each block to generate
+ *                                                    the markup for a given list of blocks that are hooked to it.
+ *                                                    Default: 'insert_hooked_blocks'.
  * @param array|null   $ignored_hooked_blocks_at_root A reference to an array that will be populated
- *                               with the ignored hooked blocks at the root level.
- *                               Default: `null`.
+ *                                                    with the ignored hooked blocks at the root level.
+ *                                                    Default: `null`.
  * @return string The serialized markup.
  */

trunk/src/wp-includes/class-wp-theme-json-schema.php

@@ -38 +38 @@
          * @since 6.6.0 Migrate up to v3 and add $origin parameter.
          *
-         * @param array $theme_json The structure to migrate.
-         * @param string $origin    Optional. What source of data this object represents.
-         *                          One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
+         * @param array  $theme_json The structure to migrate.
+         * @param string $origin     Optional. What source of data this object represents.
+         *                           One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
          * @return array The structure in the last version.
          */
@@ -101 +101 @@
          * @since 6.6.0
          *
-         * @param array $old     Data to migrate.
+         * @param array  $old    Data to migrate.
          * @param string $origin What source of data this object represents.
          *                       One of 'blocks', 'default', 'theme', or 'custom'.
@@ -214 +214 @@
          *
          * @param array $settings Reference to the current settings array.
-         * @param array $path Path to the property to be removed.
+         * @param array $path     Path to the property to be removed.
          */
         private static function unset_setting_by_path( &$settings, $path ) {

trunk/src/wp-includes/class-wp-theme-json.php

@@ -955 +955 @@
          * Processes pseudo-selectors for any node (block or variation).
          *
-         * @param array  $node The node data (block or variation).
-         * @param string $base_selector The base selector.
-         * @param array  $settings The theme settings.
-         * @param string $block_name The block name.
-         * @param array|null $block_metadata Metadata about the block to get styles for.
+         * @param array      $node            The node data (block or variation).
+         * @param string     $base_selector   The base selector.
+         * @param array      $settings        The theme settings.
+         * @param string     $block_name      The block name.
+         * @param array|null $block_metadata  Metadata about the block to get styles for.
          * @param array|null $style_variation Style variation metadata.
          * @return array Array of pseudo-selector declarations.
@@ -2996 +2996 @@
          * @since 6.7.0 `ref` resolution of background properties, and assigning custom default values.
          *
-         * @param array   $styles Styles to process.
-         * @param array   $settings Theme settings.
-         * @param array   $properties Properties metadata.
-         * @param array   $theme_json Theme JSON array.
-         * @param string  $selector The style block selector.
+         * @param array   $styles           Styles to process.
+         * @param array   $settings         Theme settings.
+         * @param array   $properties       Properties metadata.
+         * @param array   $theme_json       Theme JSON array.
+         * @param string  $selector         The style block selector.
          * @param boolean $use_root_padding Whether to add custom properties at root level.
          * @return array Returns the modified $declarations.
@@ -3134 +3134 @@
          * @since 6.7.0 Added support for background image refs.
          *
-         * @param array $styles Styles subtree.
-         * @param array $path   Which property to process.
+         * @param array $styles     Styles subtree.
+         * @param array $path       Which property to process.
          * @param array $theme_json Theme JSON array.
          * @return string|array Style property value.
@@ -4196 +4196 @@
          * @since 7.0.0 Added `$options` parameter to control alignment styles output for classic themes.
          *
-         * @param string $selector The root node selector.
+         * @param string $selector       The root node selector.
          * @param array  $block_metadata The metadata for the root block.
          * @param array  $options        Optional. An array of options for now used for internal purposes only.
@@ -4599 +4599 @@
          * @since 5.9.0
          *
-         * @param string $slug The slug we want to find a match from default presets.
+         * @param string $slug      The slug we want to find a match from default presets.
          * @param array  $base_path The path to inspect. It's 'settings' by default.
          * @return string|null
@@ -5913 +5913 @@
          * @since 7.0.0
          *
-         * @param array  $style_variation Style variation metadata.
+         * @param array  $style_variation  Style variation metadata.
          * @param string $feature_selector CSS selector for the feature.
          * @return string Feature selector with block style variation selector added.

trunk/src/wp-includes/style-engine/class-wp-style-engine-css-rules-store.php

@@ -126 +126 @@
          * @since 6.6.0 Added the $rules_group parameter.
          *
-         * @param string $selector The CSS selector.
+         * @param string $selector    The CSS selector.
          * @param string $rules_group A parent CSS selector in the case of nested CSS, or a CSS nested @rule,
          *                            such as `@media (min-width: 80rem)` or `@layer module`.