WordPress.org

Make WordPress Core

Changeset 34911


Ignore:
Timestamp:
10/07/2015 04:33:52 PM (5 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/meta-boxes.php

    r34895 r34911  
    44
    55/**
    6  * Display post submit form fields.
     6 * Displays post submit form fields.
    77 *
    88 * @since 2.7.0
     
    1010 * @global string $action
    1111 *
    12  * @param object $post
    13  */
    14 function post_submit_meta_box($post, $args = array() ) {
     12 * @param WP_Post  $post Current post object.
     13 * @param array    $args {
     14 *     Array of arguments for building the post submit meta box.
     15 *
     16 *     @type string   $id       Meta box ID.
     17 *     @type string   $title    Meta box title.
     18 *     @type callable $callback Meta box display callback.
     19 *     @type array    $args     Extra meta box arguments.
     20 * }
     21 */
     22function post_submit_meta_box( $post, $args = array() ) {
    1523    global $action;
    1624
Note: See TracChangeset for help on using the changeset viewer.