Skip to content

Docs: Align @param and @return tags in block editor-related code #13416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mukeshpanchal27 wants to merge 3 commits into from
Closed

Docs: Align @param and @return tags in block editor-related code #13416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6951a27
Docs: Align param tag columns in lib/ docblocks
mukeshpanchal27 Sep 7, 2026
87ef218
Merge branch 'trunk' into docs/param-alignment-lib
mukeshpanchal27 Sep 8, 2026
2dd78be
Docs: Align remaining @param and @return tags from Gutenberg.
t-hamano Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/wp-includes/block-supports/background.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ function wp_register_background_support( $block_type ) {
*
* @access private
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
*/
function wp_render_background_support( $block_content, $block ) {
Expand Down
6 changes: 3 additions & 3 deletions src/wp-includes/block-supports/block-style-variations.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ function wp_render_block_style_variation_support_styles( $parsed_block ) {
*
* @see wp_render_block_style_variation_support_styles
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
*/
function wp_render_block_style_variation_class_name( $block_content, $block ) {
if ( ! $block_content || empty( $block['attrs']['className'] ) ) {
Expand Down
4 changes: 2 additions & 2 deletions src/wp-includes/block-supports/colors.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ function wp_register_colors_support( $block_type ) {
* @since 7.1.0 Suppresses color.gradient when background.gradient is supported and set.
* @access private
*
* @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes.
* @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes.
* @return array Colors CSS classes and inline styles.
*/
function wp_apply_colors_support( $block_type, $block_attributes ) {
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/block-supports/custom-css.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ function wp_enqueue_block_custom_css() {
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
* @return string Filtered block content.
*
* @phpstan-param array{
* attrs: array{
Expand Down
6 changes: 3 additions & 3 deletions src/wp-includes/block-supports/dimensions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ function wp_is_explicit_aspect_ratio_value( $aspect_ratio ) {
* @since 6.5.0
* @access private
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
*/
function wp_render_dimensions_support( $block_content, $block ) {
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
Expand Down
6 changes: 3 additions & 3 deletions src/wp-includes/block-supports/elements.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ function wp_get_elements_class_name(): string {
* @since 6.6.0
* @access private
*
* @param array $block Block object.
* @param array $options Per element type options e.g. whether to skip serialization.
* @param array $block Block object.
* @param array $options Per element type options e.g. whether to skip serialization.
* @return bool Whether the block needs an elements class name.
*/
function wp_should_add_elements_class_name( $block, $options ) {
Expand Down Expand Up @@ -264,7 +264,7 @@ function wp_render_elements_support_styles( $parsed_block ) {
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
* @return string Filtered block content.
*
* @phpstan-param array{
* attrs: array{
Expand Down
6 changes: 3 additions & 3 deletions src/wp-includes/block-supports/position.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ function wp_register_position_support( $block_type ) {
* @since 6.2.0
* @access private
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
*/
function wp_render_position_support( $block_content, $block ) {
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( $block['blockName'] );
Expand Down
6 changes: 3 additions & 3 deletions src/wp-includes/block-supports/settings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ function _wp_get_presets_class_name( $block ) {
* @since 6.2.0
* @access private
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @return string Filtered block content.
*/
function _wp_add_block_level_presets_class( $block_content, $block ) {
if ( ! $block_content ) {
Expand Down
4 changes: 2 additions & 2 deletions src/wp-includes/block-supports/shadow.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ function wp_register_shadow_support( $block_type ) {
* @since 6.6.0 Return early if __experimentalSkipSerialization is true.
* @access private
*
* @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes.
* @param WP_Block_Type $block_type Block type.
* @param array $block_attributes Block attributes.
* @return array Shadow CSS classes and inline styles.
*/
function wp_apply_shadow_support( $block_type, $block_attributes ) {
Expand Down
10 changes: 5 additions & 5 deletions src/wp-includes/class-wp-duotone.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,8 +753,8 @@ private static function get_filter_svg( $filter_id, $colors ) {
* @since 6.3.0
* @deprecated 6.3.0
*
* @param array $preset Duotone preset value as seen in theme.json.
* @return string Duotone filter CSS id.
* @param array $preset Duotone preset value as seen in theme.json.
* @return string Duotone filter CSS id.
*/
public static function get_filter_id_from_preset( $preset ) {
_deprecated_function( __FUNCTION__, '6.3.0' );
Expand Down Expand Up @@ -1080,9 +1080,9 @@ private static function get_all_global_style_block_names() {
*
* @since 6.3.0
*
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @param WP_Block $wp_block The block instance.
* @param string $block_content Rendered block content.
* @param array $block Block object.
* @param WP_Block $wp_block The block instance.
* @return string Filtered block content.
*/
public static function render_duotone_support( $block_content, $block, $wp_block ) {
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/class-wp-theme-json-resolver.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ protected static function has_same_registered_blocks( $origin ) {
* Added registration and merging of block style variations from partial theme.json files and the block styles registry.
*
* @param array $deprecated Deprecated. Not used.
* @param array $options {
* @param array $options {
* Options arguments.
*
* @type bool $with_supports Whether to include theme supports in the data. Default true.
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/class-wp-theme-json.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3522,7 +3522,7 @@ private static function update_button_width_declarations( $feature_declarations,
*
* @param array $theme_json The theme.json converted to an array.
* @param array $selectors Optional list of selectors per block.
* @param array $options {
* @param array $options {
* Optional. An array of options for now used for internal purposes only (may change without notice).
*
* @type bool $include_block_style_variations Include nodes for block style variations. Default false.
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/icons.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ function wp_unregister_icon_collection( $slug ) {
* reserved for WordPress core icons; third-party code should
* register icons under its own collection rather than the
* "core" collection.
* @param array $args {
* @param array $args {
* List of properties for the icon.
*
* @type string $label Required. A human-readable label for the icon.
Expand Down
4 changes: 2 additions & 2 deletions src/wp-includes/rest-api/endpoints/class-wp-rest-templates-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -852,7 +852,7 @@ public function prepare_item_for_response( $item, $request ) {
* @since 6.5.0
*
* @param WP_Block_Template $template_object Template instance.
* @return string Original source of the template one of theme, plugin, site, or user.
* @return string Original source of the template one of theme, plugin, site, or user.
*/
private static function get_wp_templates_original_source_field( $template_object ) {
if ( 'wp_template' === $template_object->type || 'wp_template_part' === $template_object->type ) {
Expand Down Expand Up @@ -904,7 +904,7 @@ private static function get_wp_templates_original_source_field( $template_object
* @since 6.5.0
*
* @param WP_Block_Template $template_object Template instance.
* @return string Human readable text for the author.
* @return string Human readable text for the author.
*/
private static function get_wp_templates_author_text_field( $template_object ) {
$original_source = self::get_wp_templates_original_source_field( $template_object );
Expand Down
Loading