Skip to content

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

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

Closed
opr wants to merge 7 commits into from
Closed

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

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b0134e9
Update hook document to more accurately reflect the proper types
opr Nov 18, 2025
223bed7
Update hook documentation for add_meta_boxes_{}
opr Nov 18, 2025
eb4c11d
Update spacing
opr Nov 19, 2025
068c9b4
Fix spacing
opr Nov 19, 2025
29e2289
Update hook variable names to be more generic
opr Nov 20, 2025
ee6dc0b
Update hook docs for add_meta_boxes
opr Nov 21, 2025
ca5aad9
Update hook docs for `do_meta_boxes` too
opr Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/wp-admin/includes/meta-boxes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1677,25 +1677,31 @@ function register_and_do_post_meta_boxes( $post ) {
*
* @since 3.0.0
*
* @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',
Copy link
Copy Markdown
Member

@westonruter westonruter Nov 19, 2025

Choose a reason for hiding this comment

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

What about $object_type?

Copy link
Copy Markdown
Author

@opr opr Nov 20, 2025

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Author

@opr opr Nov 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

@westonruter westonruter Nov 20, 2025

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Author

@opr opr Nov 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks, I also applied similar changes to do_meta_boxes in ca5aad9

* custom post types, 'comment', or 'link'.
Copy link
Copy Markdown

@nikunj8866 nikunj8866 Nov 19, 2025

Choose a reason for hiding this comment

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

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!

Copy link
Copy Markdown
Author

@opr opr Nov 19, 2025

Choose a reason for hiding this comment

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

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

* @param WP_Post|WP_Comment|object $post The post, comment, or link object. Type varies depending on
* `$post_type`.
*/
do_action( 'add_meta_boxes', $post_type, $post );

/**
* Fires after all built-in meta boxes have been added, contextually for the given post type.
*
* The dynamic portion of the hook name, `$post_type`, refers to the post type of the post.
* The dynamic portion of the hook name, `$post_type`, refers to the post type of the post,
* or the object type (comment, link).
*
* Possible hook names include:
*
* - `add_meta_boxes_post`
* - `add_meta_boxes_page`
* - `add_meta_boxes_attachment`
* - `add_meta_boxes_comment`
* - `add_meta_boxes_link`
*
* @since 3.0.0
*
* @param WP_Post $post Post object.
* @param WP_Post|WP_Comment|object $post The post, comment, or link object. Type varies depending on
* the hook name.
*/
do_action( "add_meta_boxes_{$post_type}", $post );

Expand Down
Loading