Skip to content

Docs: Add missing @global descriptions and refine parameter documentation#10931

Open
noruzzamans wants to merge 11 commits intoWordPress:trunkfrom
noruzzamans:fix/missing-global-descriptions
Open

Docs: Add missing @global descriptions and refine parameter documentation#10931
noruzzamans wants to merge 11 commits intoWordPress:trunkfrom
noruzzamans:fix/missing-global-descriptions

Conversation

@noruzzamans
Copy link

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

Why this change?

This change adds missing @global documentation tags.

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.

@github-actions
Copy link

github-actions bot commented Feb 14, 2026

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

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

@github-actions
Copy link

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.

Copy link
Member

@huzaifaalmesbah huzaifaalmesbah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some function docblocks still have scope improvements on class-wp-links-list-table.php: L79 L86 L145

Although these are not related to globals or parameters, they are missing proper summaries and return documentation.
Could you please review and update these as well?

Co-authored-by: Huzaifa Al Mesbah <huzaifah4m@gmail.com>
@westonruter
Copy link
Member

Note: There's no real need to merge trunk back into a branch unless it's likely there will be a merge conflict or a breakage. The committer will ultimately ensure the latest from trunk is merged at the time of commit to SVN.

@noruzzamans noruzzamans force-pushed the fix/missing-global-descriptions branch from cbf4521 to ca51273 Compare February 15, 2026 04:23
@noruzzamans
Copy link
Author

Some function docblocks still have scope improvements on class-wp-links-list-table.php: L79 L86 L145

Although these are not related to globals or parameters, they are missing proper summaries and return documentation. Could you please review and update these as well?

Thanks @huzaifaalmesbah. I have updated and improved the missing docs.

@noruzzamans
Copy link
Author

noruzzamans commented Feb 15, 2026

Note: There's no real need to merge trunk back into a branch unless it's likely there will be a merge conflict or a breakage. The committer will ultimately ensure the latest from trunk is merged at the time of commit to SVN.

Thanks @westonruter! I have resolved all issues.

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.

3 participants