Skip to content

docs: Add missing parameter descriptions to docblocks in some file #10570

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
rejaulalomkhan wants to merge 5 commits into from
Closed

docs: Add missing parameter descriptions to docblocks in some file #10570

rejaulalomkhan wants to merge 5 commits into from

Conversation

@rejaulalomkhan
Copy link

@rejaulalomkhan rejaulalomkhan commented Dec 1, 2025

Description

This PR improves inline documentation in wp-admin files by adding missing parameter descriptions to function docblocks.

Changes

  • ✅ Added proper @param descriptions for functions missing them
  • ✅ Added complete docblock for wp_load_press_this() function
  • ✅ Enhanced function summary for wp_nav_menu_max_depth()
  • ✅ All changes follow WordPress PHP Documentation Standards

Files Modified

  • wp-admin/install.php
  • wp-admin/nav-menus.php
  • wp-admin/update-core.php
  • wp-admin/includes/ajax-actions.php
  • wp-admin/includes/class-wp-importer.php

Testing

  • No functional changes, documentation only
  • All parameter descriptions are accurate and follow WP standards

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

@github-actions
Copy link

github-actions bot commented Dec 1, 2025 •
edited
Loading

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

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

@github-actions
Copy link

github-actions bot commented Dec 1, 2025

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.

huzaifaalmesbah
huzaifaalmesbah reviewed Dec 1, 2025
View reviewed changes
@rejaulalomkhan @huzaifaalmesbah
Update src/wp-admin/includes/class-wp-importer.php
862daeb 
Co-authored-by: Huzaifa Al Mesbah <huzaifah4m@gmail.com>
westonruter
westonruter reviewed Dec 3, 2025
View reviewed changes
@rejaulalomkhan
Copy link
Author

rejaulalomkhan commented Jan 22, 2026

Hi @westonruter, I've made the changes you suggested. Thanks for your help!

westonruter
westonruter reviewed Jan 23, 2026
View reviewed changes
src/wp-admin/includes/class-wp-importer.php Outdated
Comment on lines 292 to 294
* @param string $param
* @param bool $required
* @return mixed
* @param string $param The parameter name to retrieve.
* @param bool $required Whether the parameter is required. Default false.
* @return string|bool|null|never The parameter value or true if found, null otherwise. The function exits when a required param is missing.
Copy link
Member

@westonruter westonruter Jan 23, 2026

Choose a reason for hiding this comment

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

FYI: This phpdoc was supplied in eefa4e8 so I'll fix the merge conflict to defer to what is now in trunk.

@westonruter
Merge branch 'trunk' of https://github.com/WordPress/wordpress-develop …
e1b5e0d 
…into fix/docblock-missing-param-descriptions
pento pushed a commit that referenced this pull request Jan 23, 2026
@westonruter
Docs: Add missing descriptions to wp_nav_menu_max_depth() and `do_c…
1b3b45f 
…ore_upgrade()`.

Developed in #10570

Follow-up to [61512], [32642], [32654].

Props rejaulalomkhan, westonruter, huzaifaalmesbah.
See #64224.


git-svn-id: https://develop.svn.wordpress.org/trunk@61520 602fd350-edb4-49c9-b593-d223f7449a82
@westonruter
Copy link
Member

westonruter commented Jan 23, 2026 •
edited
Loading

Committed in r61520 (1b3b45f)

markjaquith pushed a commit to markjaquith/WordPress that referenced this pull request Jan 23, 2026
@westonruter
Docs: Add missing descriptions to wp_nav_menu_max_depth() and `do_c…
70df207 
…ore_upgrade()`.

Developed in WordPress/wordpress-develop#10570

Follow-up to [61512], [32642], [32654].

Props rejaulalomkhan, westonruter, huzaifaalmesbah.
See #64224.

Built from https://develop.svn.wordpress.org/trunk@61520


git-svn-id: http://core.svn.wordpress.org/trunk@60831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@westonruter westonruter westonruter approved these changes

+1 more reviewer

@huzaifaalmesbah huzaifaalmesbah huzaifaalmesbah left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rejaulalomkhan @westonruter @huzaifaalmesbah