Improve parameter documentation of add_meta_box().

props philiparthurmoore, DrewAPicture.
fixes #26698.


git-svn-id: https://develop.svn.wordpress.org/trunk@27132 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Andrew Nacin 2014-02-08 00:54:19 +00:00
parent 522670cef2
commit 3266997d99

View File

@ -804,11 +804,21 @@ function wp_import_upload_form( $action ) {
*
* @param string $id String for use in the 'id' attribute of tags.
* @param string $title Title of the meta box.
* @param string $callback Function that fills the box with the desired content. The function should echo its output.
* @param string|object $screen Optional. The screen on which to show the box (post, page, link). Defaults to current screen.
* @param string $context Optional. The context within the page where the boxes should show ('normal', 'advanced').
* @param string $priority Optional. The priority within the context where the boxes should show ('high', 'low').
* @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).
* @param callback $callback Function that fills the box with the desired content.
* The function should echo its output.
* @param string|WP_Screen $screen Optional. The screen on which to show the box (like a post
* type, 'link', or 'comment'). 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;