Docs: Add missing @global annotations in abstract-testcase.php #10841

noruzzamans · 2026-02-02T05:16:45Z

Trac Ticket: https://core.trac.wordpress.org/ticket/64224

Why this change?

This change adds missing @global documentation tags to functions in
tests/phpunit/includes/abstract-testcase.php

By documenting the global variables used within these functions (such as $wpdb, $wp_rewrite, $wp_the_query, etc.), we align the test suite's codebase with the WordPress PHP Documentation Standards. This improves code clarity and enables better static analysis for the unit testing framework.

Files Changed:
tests/phpunit/includes/abstract-testcase.php

github-actions · 2026-02-02T05:16:57Z

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, mukesh27, westonruter, shailu25, huzaifaalmesbah.

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

github-actions · 2026-02-02T05:22:33Z

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

The Plugin and Theme Directories cannot be accessed within Playground.
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.

….php

mukeshpanchal27 · 2026-02-02T06:22:16Z

src/wp-includes/deprecated.php

 * @deprecated 0.71 Use get_the_category_by_ID()
 * @see get_the_category_by_ID()
 *
+ * @global int $currentcat


No needs to edit/update deprecated functions as it was not used

mukeshpanchal27 · 2026-02-02T06:24:48Z

src/wp-includes/meta.php

 * @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.


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.

@mukeshpanchal27 I have updated the @global documentation in abstract-testcase.php and reverted the changes in deprecated.php as suggested.

tests/phpunit/includes/abstract-testcase.php

westonruter · 2026-02-08T01:35:12Z

tests/phpunit/includes/abstract-testcase.php

+	 * @global array $wp_filter         Stores all of the filters and actions.
+	 * @global array $wp_actions        Stores the number of times each action was triggered.
+	 * @global array $wp_filters        Stores the number of times each filter was triggered.
+	 * @global array $wp_current_filter Stores the list of current filters with the current one last.


I don't think a these descriptions should start with a verb ("Stores"). They should be nouns. So strip the "Stores" off.

westonruter · 2026-02-08T01:35:21Z

tests/phpunit/includes/abstract-testcase.php

+	 * @global array $wp_filter         Stores all of the filters and actions.
+	 * @global array $wp_actions        Stores the number of times each action was triggered.
+	 * @global array $wp_filters        Stores the number of times each filter was triggered.
+	 * @global array $wp_current_filter Stores the list of current filters with the current one last.


Co-authored-by: Weston Ruter <westonruter@gmail.com>

shail-mehta · 2026-02-08T04:05:52Z

@noruzzamans Could you please resolve conflicts?

mukeshpanchal27 · 2026-02-08T04:17:31Z

tests/phpunit/includes/abstract-testcase.php

+	 * @global wpdb       $wpdb         WordPress database abstraction object.
+	 * @global WP_Query   $wp_the_query Main WordPress query object.
+	 * @global WP_Query   $wp_query     WordPress query object.
+	 * @global WP         $wp           WordPress environment object.


Suggested change

* @global wpdb $wpdb WordPress database abstraction object.

* @global WP_Query $wp_the_query Main WordPress query object.

* @global WP_Query $wp_query WordPress query object.

* @global WP $wp WordPress environment object.

* @global wpdb $wpdb WordPress database abstraction object.

* @global WP_Query $wp_the_query Main WordPress query object.

* @global WP_Query $wp_query WordPress query object.

* @global WP $wp WordPress environment object.

huzaifaalmesbah · 2026-02-08T04:30:18Z

It looks like this PR may already have been committed:

into fix/missing-global-tags

…ans/wordpress-develop into fix/missing-global-tags

noruzzamans · 2026-02-08T12:33:53Z

@shail-mehta @westonruter @mukeshpanchal27 @huzaifaalmesbah Thanks for review. I have updated all changes. if need any changes please let me know. Thanks

mukeshpanchal27

Let’s update the PR title and description, as they’re outdated now.

tests/phpunit/includes/abstract-testcase.php

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

noruzzamans · 2026-02-09T07:16:56Z

Let’s update the PR title and description, as they’re outdated now.

@mukeshpanchal27 Thanks. I have updated the title and description based on your suggestion.

Developed in #10841 Follow-up to [61589], [61584]. Props noruzzaman, mukesh27, westonruter, shailu25, huzaifaalmesbah. See #64224. git-svn-id: https://develop.svn.wordpress.org/trunk@61604 602fd350-edb4-49c9-b593-d223f7449a82

westonruter · 2026-02-09T18:43:36Z

Committed in r61604 (4cad33a)

Developed in WordPress/wordpress-develop#10841 Follow-up to [61589], [61584]. Props noruzzaman, mukesh27, westonruter, shailu25, huzaifaalmesbah. See #64224. Built from https://develop.svn.wordpress.org/trunk@61604 git-svn-id: http://core.svn.wordpress.org/trunk@60915 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Docs: Add missing @global annotations in meta.php and deprecated.php

969852d

Docs: Complete missing @global annotations in meta.php and deprecated…

b47e8b3

….php

mukeshpanchal27 reviewed Feb 2, 2026

View reviewed changes

noruzzamans added 2 commits February 2, 2026 13:10

Revert changes in deprecated.php as per committer feedback

6517956

Docs: Complete missing @global annotations in abstract-testcase.php

f308644

westonruter reviewed Feb 8, 2026

View reviewed changes

noruzzamans and others added 2 commits February 8, 2026 07:41

Update tests/phpunit/includes/abstract-testcase.php

1f4764e

Co-authored-by: Weston Ruter <westonruter@gmail.com>

Update tests/phpunit/includes/abstract-testcase.php

85ffa03

Co-authored-by: Weston Ruter <westonruter@gmail.com>

mukeshpanchal27 reviewed Feb 8, 2026

View reviewed changes

noruzzamans added 3 commits February 8, 2026 18:13

Merge branch 'trunk' of https://github.com/noruzzamans/wordpress-develop

b6f4b1f

into fix/missing-global-tags

Merge branch 'fix/missing-global-tags' of https://github.com/noruzzam…

0fdf818

…ans/wordpress-develop into fix/missing-global-tags

Docs: Refine @global annotations in abstract-testcase.php

2a0c790

mukeshpanchal27 reviewed Feb 9, 2026

View reviewed changes

tests/phpunit/includes/abstract-testcase.php Outdated Show resolved Hide resolved

noruzzamans and others added 2 commits February 9, 2026 12:42

Update tests/phpunit/includes/abstract-testcase.php

7c78ba5

Co-authored-by: Mukesh Panchal <mukeshpanchal27@users.noreply.github.com>

Merge branch 'trunk' into fix/missing-global-tags

ed0a528

noruzzamans changed the title ~~Docs: Add missing @global annotations in meta.php and deprecated.php~~ Docs: Add missing @global annotations in abstract-testcase.php Feb 9, 2026

westonruter approved these changes Feb 9, 2026

View reviewed changes

westonruter closed this Feb 9, 2026

Docs: Add missing @global annotations in abstract-testcase.php #10841

Docs: Add missing @global annotations in abstract-testcase.php #10841

Conversation

noruzzamans commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Feb 2, 2026

Test using WordPress Playground

Some things to be aware of

Uh oh!

mukeshpanchal27 Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

mukeshpanchal27 Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

noruzzamans Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

westonruter Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

mukeshpanchal27 Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

westonruter Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

shail-mehta commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mukeshpanchal27 Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

huzaifaalmesbah commented Feb 8, 2026

Uh oh!

noruzzamans commented Feb 8, 2026

Uh oh!

mukeshpanchal27 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

noruzzamans commented Feb 9, 2026

Uh oh!

westonruter commented Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

noruzzamans commented Feb 2, 2026 •

edited

Loading

github-actions bot commented Feb 2, 2026 •

edited

Loading

shail-mehta commented Feb 8, 2026 •

edited

Loading