sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve the function and parameter descriptions for do_meta_boxes().

Browse Source 
See #42505


git-svn-id: https://develop.svn.wordpress.org/trunk@42412 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2017-12-19 15:02:36 +00:00
parent bc35d72a63
commit 2a9f696710
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/wp-admin/includes/template.php
View File

@ -1057,7 +1057,7 @@ function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advan
} }
/** /**
* Meta-Box template function * Displays the meta boxes which are registered against the given screen and context.
* *
* @since 2.5.0 * @since 2.5.0
* *
@ -1069,8 +1069,10 @@ function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advan
* add_submenu_page() to create a new screen (and hence screen_id) * add_submenu_page() to create a new screen (and hence screen_id)
* make sure your menu slug conforms to the limits of sanitize_key() * make sure your menu slug conforms to the limits of sanitize_key()
* otherwise the 'screen' menu may not correctly render on your page. * otherwise the 'screen' menu may not correctly render on your page.
* @param string $context box context * @param string $context The screen context for which to display meta boxes.
* @param mixed $object gets passed to the box callback function as first parameter * @param mixed $object Gets passed to the first parameter of the meta box callback function.
* Often this is the object that's the focus of the current screen, for
* example a `WP_Post` or `WP_Comment` object.
* @return int number of meta_boxes * @return int number of meta_boxes
*/ */
function do_meta_boxes( $screen, $context, $object ) { function do_meta_boxes( $screen, $context, $object ) {