WordPress.org

Make WordPress Core

Changeset 34952


Ignore:
Timestamp:
10/08/2015 07:12:25 PM (4 years ago)
Author:
DrewAPicture
Message:

Docs: Normalize documentation spacing in the DocBlocks for add_meta_box() and remove_meta_box() following [34951].

Fixes #15000.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/template-functions.php

    r34951 r34952  
    855855 * @global array $wp_meta_boxes
    856856 *
    857  * @param string           $id            String for use in the 'id' attribute of tags.
    858  * @param string           $title         Title of the meta box.
    859  * @param callable         $callback      Function that fills the box with the desired content.
    860  *                                        The function should echo its output.
    861  * @param string|array|WP_Screen $screen  Optional. The screen or screens on which to show the box
    862  *                                        (such as a post type, 'link', or 'comment'). Accepts a single
    863  *                                        screen ID, WP_Screen object, or array of screen IDs. Default
    864  *                                        is the current screen.
    865  * @param string           $context       Optional. The context within the screen where the boxes
    866  *                                        should display. Available contexts vary from screen to
    867  *                                        screen. Post edit screen contexts include 'normal', 'side',
    868  *                                        and 'advanced'. Comments screen contexts include 'normal'
    869  *                                        and 'side'. Menus meta boxes (accordion sections) all use
    870  *                                        the 'side' context. Global default is 'advanced'.
    871  * @param string           $priority      Optional. The priority within the context where the boxes
    872  *                                        should show ('high', 'low'). Default 'default'.
    873  * @param array            $callback_args Optional. Data that should be set as the $args property
    874  *                                        of the box array (which is the second parameter passed
    875  *                                        to your callback). Default null.
     857 * @param string                 $id            Meta box ID (used in the 'id' attribute for the meta box).
     858 * @param string                 $title         Title of the meta box.
     859 * @param callable               $callback      Function that fills the box with the desired content.
     860 *                                              The function should echo its output.
     861 * @param string|array|WP_Screen $screen        Optional. The screen or screens on which to show the box
     862 *                                              (such as a post type, 'link', or 'comment'). Accepts a single
     863 *                                              screen ID, WP_Screen object, or array of screen IDs. Default
     864 *                                              is the current screen.
     865 * @param string                 $context       Optional. The context within the screen where the boxes
     866 *                                              should display. Available contexts vary from screen to
     867 *                                              screen. Post edit screen contexts include 'normal', 'side',
     868 *                                              and 'advanced'. Comments screen contexts include 'normal'
     869 *                                              and 'side'. Menus meta boxes (accordion sections) all use
     870 *                                              the 'side' context. Global default is 'advanced'.
     871 * @param string                 $priority      Optional. The priority within the context where the boxes
     872 *                                              should show ('high', 'low'). Default 'default'.
     873 * @param array                  $callback_args Optional. Data that should be set as the $args property
     874 *                                              of the box array (which is the second parameter passed
     875 *                                              to your callback). Default null.
    876876 */
    877877function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advanced', $priority = 'default', $callback_args = null ) {
     
    10311031 * @global array $wp_meta_boxes
    10321032 *
    1033  * @param string        $id      String for use in the 'id' attribute of tags.
    1034  * @param string|array|WP_Screen $screen The screen or screens on which the meta box is shown (such as a
    1035  *                                       post type, 'link', or 'comment'). Accepts a single screen ID,
    1036  *                                       WP_Screen object, or array of screen IDs.
    1037  * @param string        $context The context within the page where the boxes should show ('normal', 'advanced').
     1033 * @param string                 $id      Meta box ID (used in the 'id' attribute for the meta box).
     1034 * @param string|array|WP_Screen $screen  The screen or screens on which the meta box is shown (such as a
     1035 *                                        post type, 'link', or 'comment'). Accepts a single screen ID,
     1036 *                                        WP_Screen object, or array of screen IDs.
     1037 * @param string                 $context Optional. The context within the screen where the boxes
     1038 *                                        should display. Available contexts vary from screen to
     1039 *                                        screen. Post edit screen contexts include 'normal', 'side',
     1040 *                                        and 'advanced'. Comments screen contexts include 'normal'
     1041 *                                        and 'side'. Menus meta boxes (accordion sections) all use
     1042 *                                        the 'side' context. Global default is 'advanced'.
    10381043 */
    10391044function remove_meta_box( $id, $screen, $context ) {
Note: See TracChangeset for help on using the changeset viewer.