From 562b65d8227ea0af3020042cf08997f451f53ba2 Mon Sep 17 00:00:00 2001 From: Andrew Nacin Date: Thu, 22 Aug 2013 15:57:31 +0000 Subject: [PATCH] PHPDoc for WP_Post properties. fixes #25092. git-svn-id: https://develop.svn.wordpress.org/trunk@25086 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/post.php | 46 ++++++++++++++++++++++++++++------------ 1 file changed, 33 insertions(+), 13 deletions(-) diff --git a/src/wp-includes/post.php b/src/wp-includes/post.php index 5eea14e3bb..2faeb086fe 100644 --- a/src/wp-includes/post.php +++ b/src/wp-includes/post.php @@ -424,160 +424,180 @@ function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) { final class WP_Post { /** + * Post ID. * * @var int */ public $ID; /** + * ID of post author. * - * @var int + * A numeric string, for compatibility reasons. + * + * @var string */ public $post_author = 0; /** + * The post's local publication time. * * @var string */ public $post_date = '0000-00-00 00:00:00'; /** + * The post's GMT publication time. * * @var string */ public $post_date_gmt = '0000-00-00 00:00:00'; /** + * The post's content. * * @var string */ public $post_content = ''; /** + * The post's title. * * @var string */ public $post_title = ''; /** + * The post's excerpt. * * @var string */ public $post_excerpt = ''; /** + * The post's status. * * @var string */ public $post_status = 'publish'; /** + * Whether comments are allowed. * * @var string */ public $comment_status = 'open'; /** + * Whether pings are allowed. * * @var string */ public $ping_status = 'open'; /** + * The post's password in plain text. * * @var string */ public $post_password = ''; /** + * The post's slug. * * @var string */ public $post_name = ''; /** + * URLs queued to be pinged. * * @var string */ public $to_ping = ''; /** + * URLs that have been pinged. * * @var string */ public $pinged = ''; /** + * The post's local modified time. * * @var string */ public $post_modified = '0000-00-00 00:00:00'; /** + * The post's GMT modified time. * * @var string */ public $post_modified_gmt = '0000-00-00 00:00:00'; /** + * A utility DB field for post content. + * * * @var string */ public $post_content_filtered = ''; /** + * ID of a post's parent post. * * @var int */ public $post_parent = 0; /** + * The unique identifier for a post, not necessarily a URL, used as the feed GUID. * * @var string */ public $guid = ''; /** + * A field used for ordering posts. * * @var int */ public $menu_order = 0; /** + * The post's type, like pot or page. * * @var string */ public $post_type = 'post'; /** + * An attachment's mime type. * * @var string */ public $post_mime_type = ''; /** + * Cached comment count. * - * @var int + * A numeric string, for compatibility reasons. + * + * @var string */ public $comment_count = 0; /** + * Stores the post object's sanitization level. + * + * Does not correspond to a DB field. * * @var string */ public $filter; - /** - * Private variable used by post formats to cache parsed content. - * - * @since 3.6.0 - * - * @var array - * @access private - */ - public $format_content; - - public static function get_instance( $post_id ) { global $wpdb;