Docs: Add missing @global annotations in meta.php and deprecated.php #10841
Conversation
|
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
src/wp-includes/deprecated.php
Outdated
| * @deprecated 0.71 Use get_the_category_by_ID() | ||
| * @see get_the_category_by_ID() | ||
| * | ||
| * @global int $currentcat |
There was a problem hiding this comment.
No needs to edit/update deprecated functions as it was not used
| * @since 6.4.0 The `$revisions_enabled` argument was added to the arguments array. | ||
| * @since 6.7.0 The `label` argument was added to the arguments array. | ||
| * | ||
| * @global array $wp_meta_keys Global registry for meta keys. |
There was a problem hiding this comment.
Let's add similar description here https://github.com/WordPress/wordpress-develop/blob/trunk/tests/phpunit/includes/abstract-testcase.php#L455 and other places for code files.
There was a problem hiding this comment.
@mukeshpanchal27 I have updated the @global documentation in abstract-testcase.php and reverted the changes in deprecated.php as suggested.
2 participants
Trac Ticket: https://core.trac.wordpress.org/ticket/64224
Why this change?
This change adds missing @global documentation tags to functions in
src/wp-includes/meta.php
src/wp-includes/deprecated.php
This aligns the codebase with the WordPress PHP Documentation Standards, ensuring that global variables used within functions are properly documented for better static analysis and code clarity.
Files Changed:
src/wp-includes/meta.php
src/wp-includes/deprecated.php