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

See #42505

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


git-svn-id: http://core.svn.wordpress.org/trunk@42243 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2017-12-19 15:03:52 +00:00
parent 081d92c3c9
commit a5e2908bbd
2 changed files with 6 additions and 4 deletions

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 ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.0-alpha-42411'; $wp_version = '5.0-alpha-42412';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.