Docs: Improve documentation for `post_submit_meta_box()`, which serves as the display callback for the 'Publish' meta box.

* `$post` is now correctly defined as being of the `WP_Post` type
* Adds a hash notation for the `$args` array
* Other minor fixes.

Props drebbitsweb.
Fixes #34171.


git-svn-id: https://develop.svn.wordpress.org/trunk@34911 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-10-07 16:33:52 +00:00
parent 61280672d2
commit 9a704fa0b8
1 changed files with 11 additions and 3 deletions

View File

@ -3,15 +3,23 @@
// -- Post related Meta Boxes
/**
* Display post submit form fields.
* Displays post submit form fields.
*
* @since 2.7.0
*
* @global string $action
*
* @param object $post
* @param WP_Post $post Current post object.
* @param array $args {
* Array of arguments for building the post submit meta box.
*
* @type string $id Meta box ID.
* @type string $title Meta box title.
* @type callable $callback Meta box display callback.
* @type array $args Extra meta box arguments.
* }
*/
function post_submit_meta_box($post, $args = array() ) {
function post_submit_meta_box( $post, $args = array() ) {
global $action;
$post_type = $post->post_type;