Docs: Add missing @since tags for WP_Post properties and methods.

Props keesiemeijer.
Fixes #41306.
Built from https://develop.svn.wordpress.org/trunk@41036


git-svn-id: http://core.svn.wordpress.org/trunk@40886 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2017-07-13 12:08:41 +00:00
parent 2ca21c444e
commit 3b9e61cdb1
2 changed files with 60 additions and 2 deletions

View File

@ -24,6 +24,8 @@ final class WP_Post {
/** /**
* Post ID. * Post ID.
* *
* @since 3.5.0
* @access public
* @var int * @var int
*/ */
public $ID; public $ID;
@ -33,6 +35,8 @@ final class WP_Post {
* *
* A numeric string, for compatibility reasons. * A numeric string, for compatibility reasons.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_author = 0; public $post_author = 0;
@ -40,6 +44,8 @@ final class WP_Post {
/** /**
* The post's local publication time. * The post's local publication time.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_date = '0000-00-00 00:00:00'; public $post_date = '0000-00-00 00:00:00';
@ -47,6 +53,8 @@ final class WP_Post {
/** /**
* The post's GMT publication time. * The post's GMT publication time.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_date_gmt = '0000-00-00 00:00:00'; public $post_date_gmt = '0000-00-00 00:00:00';
@ -54,6 +62,8 @@ final class WP_Post {
/** /**
* The post's content. * The post's content.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_content = ''; public $post_content = '';
@ -61,6 +71,8 @@ final class WP_Post {
/** /**
* The post's title. * The post's title.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_title = ''; public $post_title = '';
@ -68,6 +80,8 @@ final class WP_Post {
/** /**
* The post's excerpt. * The post's excerpt.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_excerpt = ''; public $post_excerpt = '';
@ -75,6 +89,8 @@ final class WP_Post {
/** /**
* The post's status. * The post's status.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_status = 'publish'; public $post_status = 'publish';
@ -82,6 +98,8 @@ final class WP_Post {
/** /**
* Whether comments are allowed. * Whether comments are allowed.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $comment_status = 'open'; public $comment_status = 'open';
@ -89,6 +107,8 @@ final class WP_Post {
/** /**
* Whether pings are allowed. * Whether pings are allowed.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $ping_status = 'open'; public $ping_status = 'open';
@ -96,6 +116,8 @@ final class WP_Post {
/** /**
* The post's password in plain text. * The post's password in plain text.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_password = ''; public $post_password = '';
@ -103,6 +125,8 @@ final class WP_Post {
/** /**
* The post's slug. * The post's slug.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_name = ''; public $post_name = '';
@ -110,6 +134,8 @@ final class WP_Post {
/** /**
* URLs queued to be pinged. * URLs queued to be pinged.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $to_ping = ''; public $to_ping = '';
@ -117,6 +143,8 @@ final class WP_Post {
/** /**
* URLs that have been pinged. * URLs that have been pinged.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $pinged = ''; public $pinged = '';
@ -124,6 +152,8 @@ final class WP_Post {
/** /**
* The post's local modified time. * The post's local modified time.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_modified = '0000-00-00 00:00:00'; public $post_modified = '0000-00-00 00:00:00';
@ -131,6 +161,8 @@ final class WP_Post {
/** /**
* The post's GMT modified time. * The post's GMT modified time.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_modified_gmt = '0000-00-00 00:00:00'; public $post_modified_gmt = '0000-00-00 00:00:00';
@ -138,7 +170,8 @@ final class WP_Post {
/** /**
* A utility DB field for post content. * A utility DB field for post content.
* *
* * @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_content_filtered = ''; public $post_content_filtered = '';
@ -146,6 +179,8 @@ final class WP_Post {
/** /**
* ID of a post's parent post. * ID of a post's parent post.
* *
* @since 3.5.0
* @access public
* @var int * @var int
*/ */
public $post_parent = 0; public $post_parent = 0;
@ -153,6 +188,8 @@ final class WP_Post {
/** /**
* The unique identifier for a post, not necessarily a URL, used as the feed GUID. * The unique identifier for a post, not necessarily a URL, used as the feed GUID.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $guid = ''; public $guid = '';
@ -160,6 +197,8 @@ final class WP_Post {
/** /**
* A field used for ordering posts. * A field used for ordering posts.
* *
* @since 3.5.0
* @access public
* @var int * @var int
*/ */
public $menu_order = 0; public $menu_order = 0;
@ -167,6 +206,8 @@ final class WP_Post {
/** /**
* The post's type, like post or page. * The post's type, like post or page.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_type = 'post'; public $post_type = 'post';
@ -174,6 +215,8 @@ final class WP_Post {
/** /**
* An attachment's mime type. * An attachment's mime type.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $post_mime_type = ''; public $post_mime_type = '';
@ -183,6 +226,8 @@ final class WP_Post {
* *
* A numeric string, for compatibility reasons. * A numeric string, for compatibility reasons.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $comment_count = 0; public $comment_count = 0;
@ -192,6 +237,8 @@ final class WP_Post {
* *
* Does not correspond to a DB field. * Does not correspond to a DB field.
* *
* @since 3.5.0
* @access public
* @var string * @var string
*/ */
public $filter; public $filter;
@ -199,6 +246,7 @@ final class WP_Post {
/** /**
* Retrieve WP_Post instance. * Retrieve WP_Post instance.
* *
* @since 3.5.0
* @static * @static
* @access public * @access public
* *
@ -235,6 +283,8 @@ final class WP_Post {
/** /**
* Constructor. * Constructor.
* *
* @since 3.5.0
*
* @param WP_Post|object $post Post object. * @param WP_Post|object $post Post object.
*/ */
public function __construct( $post ) { public function __construct( $post ) {
@ -245,6 +295,8 @@ final class WP_Post {
/** /**
* Isset-er. * Isset-er.
* *
* @since 3.5.0
*
* @param string $key Property to check if set. * @param string $key Property to check if set.
* @return bool * @return bool
*/ */
@ -267,6 +319,8 @@ final class WP_Post {
/** /**
* Getter. * Getter.
* *
* @since 3.5.0
*
* @param string $key Key to get. * @param string $key Key to get.
* @return mixed * @return mixed
*/ */
@ -310,6 +364,8 @@ final class WP_Post {
/** /**
* {@Missing Summary} * {@Missing Summary}
* *
* @since 3.5.0
*
* @param string $filter Filter. * @param string $filter Filter.
* @return self|array|bool|object|WP_Post * @return self|array|bool|object|WP_Post
*/ */
@ -326,6 +382,8 @@ final class WP_Post {
/** /**
* Convert object to array. * Convert object to array.
* *
* @since 3.5.0
*
* @return array Object as array. * @return array Object as array.
*/ */
public function to_array() { public function to_array() {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-41035'; $wp_version = '4.9-alpha-41036';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.