Update `add_meta_boxes` hook documentation to more accurately reflect the proper types #10527

opr · 2025-11-18T10:14:25Z

This patch updates the documentation for the add_meta_boxes_{$post_type} and add_meta_boxes hooks to correctly reflect that $post will not always be a WP_Post object.

Trac ticket: https://core.trac.wordpress.org/ticket/64251

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

github-actions · 2025-11-18T10:14:35Z

Hi @opr! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

The Developer Hub also documents the various coding standards that are followed:

Thank you,
The WordPress Project

github-actions · 2025-11-18T10:14:37Z

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 opr18, nikunj8866, westonruter.

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

github-actions · 2025-11-18T10:32:03Z

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.

nikunj8866

Also, ensure that both @param lines are consistently aligned and follow the same spacing format for clean and readable documentation.

nikunj8866 · 2025-11-19T08:24:46Z

src/wp-admin/includes/meta-boxes.php

 	 *
-	 * @param string  $post_type Post type.
-	 * @param WP_Post $post      Post object.
+	 * @param string                   $post_type Post type of the current screen. Can be 'post', 'page',


@opr Please add one more space before $post_type so that the description text aligns properly with the $post parameter in the PHPDoc block.

Done, thanks!

nikunj8866 · 2025-11-19T10:17:24Z

src/wp-admin/includes/meta-boxes.php

-	 * @param string  $post_type Post type.
-	 * @param WP_Post $post      Post object.
+	 * @param string                    $post_type Post type of the current screen. Can be 'post', 'page',
+	 *                                            custom post types, 'comment', or 'link'.


This description isn't lined up with the one above it. Could you adjust it so it matches, and also check the line below for the same? Thanks!

You're right, thanks 🙈 phpcs wasn't sniffing that one for some reason. Done!

nikunj8866

LGTM!

westonruter · 2025-11-19T17:13:32Z

src/wp-admin/includes/meta-boxes.php

 	 *
-	 * @param string  $post_type Post type.
-	 * @param WP_Post $post      Post object.
+	 * @param string                    $post_type Post type of the current screen. Can be 'post', 'page',


What about $object_type?

Thanks, I like the idea. Would you expect the variable passed to the hook to be renamed too, or just renamed in the documentation?

For example:

/** * Fires after all built-in meta boxes have been added. * * @since 3.0.0 * * @param string $object_type The type of the current object that meta boxes were added to. * Can be 'post', 'page', custom post types, 'comment', or 'link'. * @param WP_Post|WP_Comment|object $object The post, comment, or link object. Type varies depending on * `$post_type`. */ do_action( 'add_meta_boxes', $post_type, $post );

renaming the actual variable passed would require it throughout the file, or creating a new variable just before firing the hook.

I don't mind assigning to a new variable, but not keen on renaming through the whole file.

Just renaming the variable in the hook docs. There shouldn't be a need to change any PHP variable names or add new variables.

Thanks, I also applied similar changes to do_meta_boxes in ca5aad9

westonruter · 2025-11-19T17:13:48Z

src/wp-admin/includes/meta-boxes.php

-	 * @param WP_Post $post      Post object.
+	 * @param string                    $post_type Post type of the current screen. Can be 'post', 'page',
+	 *                                             custom post types, 'comment', or 'link'.
+	 * @param WP_Post|WP_Comment|object $post      The post, comment, or link object. Type varies depending on


Similarly, what about $object?

github-actions · 2025-11-22T04:36:14Z

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 61278
GitHub commit: 095b5ed

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

opr added 2 commits November 18, 2025 09:59

Update hook document to more accurately reflect the proper types

b0134e9

Update hook documentation for add_meta_boxes_{}

223bed7

nikunj8866 suggested changes Nov 19, 2025

View reviewed changes

Update spacing

eb4c11d

nikunj8866 suggested changes Nov 19, 2025

View reviewed changes

Fix spacing

068c9b4

nikunj8866 approved these changes Nov 19, 2025

View reviewed changes

westonruter reviewed Nov 19, 2025

View reviewed changes

opr added 3 commits November 20, 2025 17:46

Update hook variable names to be more generic

29e2289

Update hook docs for add_meta_boxes

ee6dc0b

Update hook docs for do_meta_boxes too

ca5aad9

opr force-pushed the update/meta-box-hook-docs branch from 590257d to ca5aad9 Compare November 21, 2025 10:48

github-actions bot closed this Nov 22, 2025

Update add_meta_boxes hook documentation to more accurately reflect the proper types #10527

Update add_meta_boxes hook documentation to more accurately reflect the proper types #10527

Conversation

opr commented Nov 18, 2025

Uh oh!

github-actions bot commented Nov 18, 2025

Uh oh!

github-actions bot commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Nov 18, 2025

Test using WordPress Playground

Some things to be aware of

Uh oh!

nikunj8866 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nikunj8866 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

opr Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

opr Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Update `add_meta_boxes` hook documentation to more accurately reflect the proper types #10527

Update `add_meta_boxes` hook documentation to more accurately reflect the proper types #10527

github-actions bot commented Nov 18, 2025 •

edited

Loading

opr Nov 20, 2025 •

edited

Loading

opr Nov 21, 2025 •

edited

Loading