From c3cb2ab03bb05827223fecf3ef2eb585adf58474 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 22 Feb 2015 00:55:46 +0000 Subject: [PATCH] Clarify and complete default argument documentation for `wp_insert_post()`. Props atimmer, SergeyBiryukov. Fixes #31359. git-svn-id: https://develop.svn.wordpress.org/trunk@31486 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/post.php | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index dd53326853..bedf2bf439 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -3057,22 +3057,35 @@ function wp_get_recent_posts( $args = array(), $output = ARRAY_A ) { * * @type int $ID The post ID. If equal to something other than 0, * the post with that ID will be updated. Default 0. - * @type string $post_status The post status. Default 'draft'. - * @type string $post_type The post type. Default 'post'. * @type int $post_author The ID of the user who added the post. Default is * the current user ID. - * @type bool $ping_status Whether the post can accept pings. Default is the - * value of 'default_ping_status' option. - * @type int $post_parent Set this for the post it belongs to, if any. Default 0. - * @type int $menu_order The order it is displayed. Default 0. + * @type string $post_date The date of the post. Default is the current time. + * @type string $post_date_gmt The date of the post in the GMT timezone. Default is + * the value of `$post_date`. + * @type mixed $post_content The post content. Default empty. + * @type string $post_content_filtered The filtered post content. Default empty. + * @type string $post_title The post title. Default empty. + * @type string $post_excerpt The post excerpt. Default empty. + * @type string $post_status The post status. Default 'draft'. + * @type string $post_type The post type. Default 'post'. + * @type string $comment_status Whether the post can accept comments. Accepts 'open' or 'closed'. + * Default is the value of 'default_comment_status' option. + * @type string $ping_status Whether the post can accept pings. Accepts 'open' or 'closed'. + * Default is the value of 'default_ping_status' option. + * @type string $post_password The password to access the post. Default empty. + * @type string $post_name The post name. Default is the sanitized post title. * @type string $to_ping Space or carriage return-separated list of URLs to ping. - * Default empty string. + * Default empty. * @type string $pinged Space or carriage return-separated list of URLs that have - * been pinged. Default empty string. - * @type string $post_password The password to access the post. Default empty string. - * @type string $guid' Global Unique ID for referencing the post. - * @type string $post_content_filtered The filtered post content. Default empty string. - * @type string $post_excerpt The post excerpt. Default empty string. + * been pinged. Default empty. + * @type string $post_modified The date when the post was last modified. Default is + * the current time. + * @type string $post_modified_gmt The date when the post was last modified in the GMT + * timezone. Default is the current time. + * @type int $post_parent Set this for the post it belongs to, if any. Default 0. + * @type int $menu_order The order the post should be displayed in. Default 0. + * @type string $post_mime_type The mime type of the post. Default empty. + * @type string $guid' Global Unique ID for referencing the post. Default empty. * } * @param bool $wp_error Optional. Whether to allow return of WP_Error on failure. Default false. * @return int|WP_Error The post ID on success. The value 0 or WP_Error on failure.