Make WordPress Core

Changeset 31486


Ignore:
Timestamp:
02/22/2015 12:55:46 AM (9 years ago)
Author:
DrewAPicture
Message:

Clarify and complete default argument documentation for wp_insert_post().

Props atimmer, SergeyBiryukov.
Fixes #31359.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/post.php

    r31461 r31486  
    30583058 *     @type int    $ID                    The post ID. If equal to something other than 0,
    30593059 *                                         the post with that ID will be updated. Default 0.
     3060 *     @type int    $post_author           The ID of the user who added the post. Default is
     3061 *                                         the current user ID.
     3062 *     @type string $post_date             The date of the post. Default is the current time.
     3063 *     @type string $post_date_gmt         The date of the post in the GMT timezone. Default is
     3064 *                                         the value of `$post_date`.
     3065 *     @type mixed  $post_content          The post content. Default empty.
     3066 *     @type string $post_content_filtered The filtered post content. Default empty.
     3067 *     @type string $post_title            The post title. Default empty.
     3068 *     @type string $post_excerpt          The post excerpt. Default empty.
    30603069 *     @type string $post_status           The post status. Default 'draft'.
    30613070 *     @type string $post_type             The post type. Default 'post'.
    3062  *     @type int    $post_author           The ID of the user who added the post. Default is
    3063  *                                         the current user ID.
    3064  *     @type bool   $ping_status           Whether the post can accept pings. Default is the
    3065  *                                         value of 'default_ping_status' option.
     3071 *     @type string $comment_status        Whether the post can accept comments. Accepts 'open' or 'closed'.
     3072 *                                         Default is the value of 'default_comment_status' option.
     3073 *     @type string $ping_status           Whether the post can accept pings. Accepts 'open' or 'closed'.
     3074 *                                         Default is the value of 'default_ping_status' option.
     3075 *     @type string $post_password         The password to access the post. Default empty.
     3076 *     @type string $post_name             The post name. Default is the sanitized post title.
     3077 *     @type string $to_ping               Space or carriage return-separated list of URLs to ping.
     3078 *                                         Default empty.
     3079 *     @type string $pinged                Space or carriage return-separated list of URLs that have
     3080 *                                         been pinged. Default empty.
     3081 *     @type string $post_modified         The date when the post was last modified. Default is
     3082 *                                         the current time.
     3083 *     @type string $post_modified_gmt     The date when the post was last modified in the GMT
     3084 *                                         timezone. Default is the current time.
    30663085 *     @type int    $post_parent           Set this for the post it belongs to, if any. Default 0.
    3067  *     @type int    $menu_order            The order it is displayed. Default 0.
    3068  *     @type string $to_ping               Space or carriage return-separated list of URLs to ping.
    3069  *                                         Default empty string.
    3070  *     @type string $pinged                Space or carriage return-separated list of URLs that have
    3071  *                                         been pinged. Default empty string.
    3072  *     @type string $post_password         The password to access the post. Default empty string.
    3073  *     @type string $guid'                 Global Unique ID for referencing the post.
    3074  *     @type string $post_content_filtered The filtered post content. Default empty string.
    3075  *     @type string $post_excerpt          The post excerpt. Default empty string.
     3086 *     @type int    $menu_order            The order the post should be displayed in. Default 0.
     3087 *     @type string $post_mime_type        The mime type of the post. Default empty.
     3088 *     @type string $guid'                 Global Unique ID for referencing the post. Default empty.
    30763089 * }
    30773090 * @param bool  $wp_error Optional. Whether to allow return of WP_Error on failure. Default false.
Note: See TracChangeset for help on using the changeset viewer.