Changeset 34911

Timestamp:

10/07/2015 04:33:52 PM (9 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-admin/includes/meta-boxes.php (modified) (2 diffs)

trunk/src/wp-admin/includes/meta-boxes.php

@@ -4 +4 @@
 
 /**
- * Display post submit form fields.
+ * Displays post submit form fields.
  *
  * @since 2.7.0
@@ -10 +10 @@
  * @global string $action
  *
- * @param object $post
- */
-function post_submit_meta_box($post, $args = array() ) {
+ * @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() ) {
     global $action;