From a5e2908bbd3abb19a2137115c0a39ad645e971dd Mon Sep 17 00:00:00 2001 From: John Blackbourn Date: Tue, 19 Dec 2017 15:03:52 +0000 Subject: [PATCH] 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 --- wp-admin/includes/template.php | 8 +++++--- wp-includes/version.php | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index 9078a224fd..9791748ee0 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -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 * @@ -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) * make sure your menu slug conforms to the limits of sanitize_key() * otherwise the 'screen' menu may not correctly render on your page. - * @param string $context box context - * @param mixed $object gets passed to the box callback function as first parameter + * @param string $context The screen context for which to display meta boxes. + * @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 */ function do_meta_boxes( $screen, $context, $object ) { diff --git a/wp-includes/version.php b/wp-includes/version.php index f804903a61..bae4700f9d 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @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.