From e215ca23f42179abb4e519fe72ec72f7541a852d Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Thu, 8 Oct 2015 19:12:25 +0000 Subject: [PATCH] Docs: Normalize documentation spacing in the DocBlocks for `add_meta_box()` and `remove_meta_box()` following [34951]. Fixes #15000. git-svn-id: https://develop.svn.wordpress.org/trunk@34952 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/template-functions.php | 53 +++++++++++--------- 1 file changed, 29 insertions(+), 24 deletions(-) diff --git a/src/wp-admin/includes/template-functions.php b/src/wp-admin/includes/template-functions.php index 88b07df0f3..81e8534c6c 100644 --- a/src/wp-admin/includes/template-functions.php +++ b/src/wp-admin/includes/template-functions.php @@ -854,25 +854,25 @@ function wp_import_upload_form( $action ) { * * @global array $wp_meta_boxes * - * @param string $id String for use in the 'id' attribute of tags. - * @param string $title Title of the meta box. - * @param callable $callback Function that fills the box with the desired content. - * The function should echo its output. - * @param string|array|WP_Screen $screen Optional. The screen or screens on which to show the box - * (such as a post type, 'link', or 'comment'). Accepts a single - * screen ID, WP_Screen object, or array of screen IDs. Default - * is the current screen. - * @param string $context Optional. The context within the screen where the boxes - * should display. Available contexts vary from screen to - * screen. Post edit screen contexts include 'normal', 'side', - * and 'advanced'. Comments screen contexts include 'normal' - * and 'side'. Menus meta boxes (accordion sections) all use - * the 'side' context. Global default is 'advanced'. - * @param string $priority Optional. The priority within the context where the boxes - * should show ('high', 'low'). Default 'default'. - * @param array $callback_args Optional. Data that should be set as the $args property - * of the box array (which is the second parameter passed - * to your callback). Default null. + * @param string $id Meta box ID (used in the 'id' attribute for the meta box). + * @param string $title Title of the meta box. + * @param callable $callback Function that fills the box with the desired content. + * The function should echo its output. + * @param string|array|WP_Screen $screen Optional. The screen or screens on which to show the box + * (such as a post type, 'link', or 'comment'). Accepts a single + * screen ID, WP_Screen object, or array of screen IDs. Default + * is the current screen. + * @param string $context Optional. The context within the screen where the boxes + * should display. Available contexts vary from screen to + * screen. Post edit screen contexts include 'normal', 'side', + * and 'advanced'. Comments screen contexts include 'normal' + * and 'side'. Menus meta boxes (accordion sections) all use + * the 'side' context. Global default is 'advanced'. + * @param string $priority Optional. The priority within the context where the boxes + * should show ('high', 'low'). Default 'default'. + * @param array $callback_args Optional. Data that should be set as the $args property + * of the box array (which is the second parameter passed + * to your callback). Default null. */ function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advanced', $priority = 'default', $callback_args = null ) { global $wp_meta_boxes; @@ -1030,11 +1030,16 @@ function do_meta_boxes( $screen, $context, $object ) { * * @global array $wp_meta_boxes * - * @param string $id String for use in the 'id' attribute of tags. - * @param string|array|WP_Screen $screen The screen or screens on which the meta box is shown (such as a - * post type, 'link', or 'comment'). Accepts a single screen ID, - * WP_Screen object, or array of screen IDs. - * @param string $context The context within the page where the boxes should show ('normal', 'advanced'). + * @param string $id Meta box ID (used in the 'id' attribute for the meta box). + * @param string|array|WP_Screen $screen The screen or screens on which the meta box is shown (such as a + * post type, 'link', or 'comment'). Accepts a single screen ID, + * WP_Screen object, or array of screen IDs. + * @param string $context Optional. The context within the screen where the boxes + * should display. Available contexts vary from screen to + * screen. Post edit screen contexts include 'normal', 'side', + * and 'advanced'. Comments screen contexts include 'normal' + * and 'side'. Menus meta boxes (accordion sections) all use + * the 'side' context. Global default is 'advanced'. */ function remove_meta_box( $id, $screen, $context ) { global $wp_meta_boxes;