Skip to content

Code Quality: Correct @param annotation for variadic parameter in WP_Block_Processor::opens_block() - #13500

Open
noruzzamans wants to merge 1 commit into
WordPress:trunkfrom
noruzzamans:fix/phpstan-parameter-doctype-block-processor
Open

Code Quality: Correct @param annotation for variadic parameter in WP_Block_Processor::opens_block()#13500
noruzzamans wants to merge 1 commit into
WordPress:trunkfrom
noruzzamans:fix/phpstan-parameter-doctype-block-processor

Conversation

@noruzzamans

Copy link
Copy Markdown

The @param annotation for $block_type in WP_Block_Processor::opens_block() documents the type as string[]. However, the method signature declares a variadic parameter: string ...$block_type.

Per WordPress inline documentation standards, variadic parameters should document the element type followed by ...$parameter_name (@param string ...$block_type). Because of the string[] notation, PHPStan flags this as parameter.phpDocType:

PHPDoc tag @param for parameter $block_type with type array<string> is incompatible with native type string.

Updating the annotation resolves this incompatibility and empties tests/phpstan/baselines/parameter.phpDocType.neon. As the baseline header directs, the file is deleted along with its includes entry in phpstan.neon.dist. The baseline was regenerated with:

composer phpstan:baselines -- --identifier=parameter.phpDocType

Background

WP_Block_Processor was introduced in [60939] (Trac #61401). The docblock has carried the string[] notation since its introduction and was baselined when PHPStan rule levels were bumped to 5.

Testing Instructions

  1. Run composer phpstan:baselines -- --identifier=parameter.phpDocType. The baseline empties out and the file is deleted along with its reference in phpstan.neon.dist.
  2. Run composer run phpstan -- src/wp-includes/class-wp-block-processor.php. Reports [OK] No errors.
  3. vendor/bin/phpcs src/wp-includes/class-wp-block-processor.php is clean.

Documentation-only change; no runtime behaviour is affected.

Follow-up to r60939.

Trac ticket: https://core.trac.wordpress.org/ticket/65817

Use of AI Tools

AI assistance: Yes
Model(s): Gemini 3.8 Flash High
Used for: Locating the occurrence via the PHPStan parameter.phpDocType baseline, git log -L archaeology identifying [60939] as the origin, and drafting this description. The docblock correction, baseline regeneration via composer phpstan:baselines, and verification against full PHPStan and PHPCS runs were reviewed and confirmed by me in a local development environment.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

…Block_Processor::opens_block().

Corrects the @PARAM annotation for $block_type in WP_Block_Processor::opens_block(), which documented the parameter as string[] instead of string ...$block_type.

This empties tests/phpstan/baselines/parameter.phpDocType.neon. As the baseline header directs, the file is deleted along with its includes entry in phpstan.neon.dist. The baseline was regenerated with:
composer phpstan:baselines -- --identifier=parameter.phpDocType

Follow-up to r60939.
See #65817.
@github-actions

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props noruzzaman.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant