Docs: Fix missing documentation in Media and Plugin Install list tables#11023
Docs: Fix missing documentation in Media and Plugin Install list tables#11023noruzzamans wants to merge 10 commits intoWordPress:trunkfrom
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. |
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>
| * @global array $tabs The tabs shown on the Add Plugins screen. | ||
| * @global string $tab The current active tab. | ||
| * | ||
| * @return array Array of view links. |
There was a problem hiding this comment.
array for the return value and the $tabs should be fleshed out
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
This seems to be reducing information? Granted, it is returning an empty array.
There was a problem hiding this comment.
My apologies for the oversight. I have updated the doc blocks and restored the missing info.
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Co-authored-by: Weston Ruter <westonruter@gmail.com>
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.).