Skip to content

Docs: Fix missing documentation in Media and Plugin Install list tables#11023

Open
noruzzamans wants to merge 10 commits intoWordPress:trunkfrom
noruzzamans:fix/missing-docs-ms-users-and-plugin-install-list-tables
Open

Docs: Fix missing documentation in Media and Plugin Install list tables#11023
noruzzamans wants to merge 10 commits intoWordPress:trunkfrom
noruzzamans:fix/missing-docs-ms-users-and-plugin-install-list-tables

Conversation

@noruzzamans
Copy link

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

Why this change?

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.

Missing Tags: Added missing @global, @param, and @return descriptions.
Method Summaries: Added summaries for several methods in both list table classes that were previously undocumented.
Property Docs: Added DocBlocks for class properties ($order, $orderby, etc.).

@github-actions
Copy link

github-actions bot commented Feb 24, 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.

noruzzamans and others added 4 commits February 24, 2026 10:26
Co-authored-by: Huzaifa Al Mesbah <huzaifah4m@gmail.com>
Co-authored-by: Huzaifa Al Mesbah <huzaifah4m@gmail.com>
Co-authored-by: Huzaifa Al Mesbah <huzaifah4m@gmail.com>
Co-authored-by: Huzaifa Al Mesbah <huzaifah4m@gmail.com>
Comment on lines 325 to 328
* @global array $tabs The tabs shown on the Add Plugins screen.
* @global string $tab The current active tab.
*
* @return array Array of view links.
Copy link
Member

Choose a reason for hiding this comment

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

array for the return value and the $tabs should be fleshed out

Copy link
Author

Choose a reason for hiding this comment

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

Thanks for the feedback! I have fleshed out the types for $tabs and the return value

*
* @since 3.1.0
*
* @return array Array of column titles.
Copy link
Member

Choose a reason for hiding this comment

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

This seems to be reducing information? Granted, it is returning an empty array.

Copy link
Author

Choose a reason for hiding this comment

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

My apologies for the oversight. I have updated the doc blocks and restored the missing info.

Co-authored-by: Weston Ruter <westonruter@gmail.com>
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