Docs: Add missing `@since` and properly mark the optional `$type` parameter as such in the DocBlock for the deprecated `get_others_unpublished_posts()` function.

Introduced in [5707].

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36071 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-12-23 06:57:12 +00:00
parent b489587419
commit d4ea8d9f62
1 changed files with 6 additions and 4 deletions

View File

@ -658,16 +658,18 @@ class WP_User_Search {
endif;
/**
* Retrieve editable posts from other users.
* Retrieves editable posts from other users.
*
* @since 2.3.0
* @deprecated 3.1.0 Use get_posts()
* @see get_posts()
*
* @param int $user_id User ID to not retrieve posts from.
* @param string $type Optional, defaults to 'any'. Post type to retrieve, can be 'draft' or 'pending'.
* @param int $user_id User ID to not retrieve posts from.
* @param string $type Optional. Post type to retrieve. Accepts 'draft', 'pending' or 'any' (all).
* Default 'any'.
* @return array List of posts from others.
*/
function get_others_unpublished_posts($user_id, $type='any') {
function get_others_unpublished_posts( $user_id, $type = 'any' ) {
_deprecated_function( __FUNCTION__, '3.1' );
global $wpdb;