Docs: Standardize `@deprecated` tag formatting for deprecated functions in wp-includes/pluggable-deprecated.php.

Props Alphawolf for the initial patch.
Props DrewAPicture.

See #28806.

Built from https://develop.svn.wordpress.org/trunk@33674


git-svn-id: http://core.svn.wordpress.org/trunk@33641 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-08-20 22:15:25 +00:00
parent e9f1e69b23
commit b2dcf3d1f4
2 changed files with 13 additions and 14 deletions

View File

@ -22,9 +22,8 @@ if ( !function_exists('set_current_user') ) :
* Set $id to null and specify a name if you do not know a user's ID. * Set $id to null and specify a name if you do not know a user's ID.
* *
* @since 2.0.1 * @since 2.0.1
* @see wp_set_current_user() An alias of wp_set_current_user() * @deprecated 3.0.0 Use wp_set_current_user()
* @deprecated 3.0.0 * @see wp_set_current_user()
* @deprecated Use wp_set_current_user()
* *
* @param int|null $id User ID. * @param int|null $id User ID.
* @param string $name Optional. The user's username * @param string $name Optional. The user's username
@ -41,8 +40,8 @@ if ( !function_exists('get_userdatabylogin') ) :
* Retrieve user info by login name. * Retrieve user info by login name.
* *
* @since 0.71 * @since 0.71
* @deprecated 3.3.0 * @deprecated 3.3.0 Use get_user_by()
* @deprecated Use get_user_by('login') * @see get_user_by()
* *
* @param string $user_login User's username * @param string $user_login User's username
* @return bool|object False on failure, User DB row object * @return bool|object False on failure, User DB row object
@ -58,8 +57,8 @@ if ( !function_exists('get_user_by_email') ) :
* Retrieve user info by email. * Retrieve user info by email.
* *
* @since 2.5.0 * @since 2.5.0
* @deprecated 3.3.0 * @deprecated 3.3.0 Use get_user_by()
* @deprecated Use get_user_by('email') * @see get_user_by()
* *
* @param string $email User's email address * @param string $email User's email address
* @return bool|object False on failure, User DB row object * @return bool|object False on failure, User DB row object
@ -75,8 +74,7 @@ if ( !function_exists('wp_setcookie') ) :
* Sets a cookie for a user who just logged in. This function is deprecated. * Sets a cookie for a user who just logged in. This function is deprecated.
* *
* @since 1.5.0 * @since 1.5.0
* @deprecated 2.5.0 * @deprecated 2.5.0 Use wp_set_auth_cookie()
* @deprecated Use wp_set_auth_cookie()
* @see wp_set_auth_cookie() * @see wp_set_auth_cookie()
* *
* @param string $username The user's username * @param string $username The user's username
@ -100,8 +98,7 @@ if ( !function_exists('wp_clearcookie') ) :
* Clears the authentication cookie, logging the user out. This function is deprecated. * Clears the authentication cookie, logging the user out. This function is deprecated.
* *
* @since 1.5.0 * @since 1.5.0
* @deprecated 2.5.0 * @deprecated 2.5.0 Use wp_clear_auth_cookie()
* @deprecated Use wp_clear_auth_cookie()
* @see wp_clear_auth_cookie() * @see wp_clear_auth_cookie()
*/ */
function wp_clearcookie() { function wp_clearcookie() {
@ -121,7 +118,6 @@ if ( !function_exists('wp_get_cookie_login') ):
* *
* @since 2.0.3 * @since 2.0.3
* @deprecated 2.5.0 * @deprecated 2.5.0
* @deprecated No alternative
* *
* @return bool Always returns false * @return bool Always returns false
*/ */
@ -145,7 +141,9 @@ if ( !function_exists('wp_login') ) :
* failure can utilize it later. * failure can utilize it later.
* *
* @since 1.2.2 * @since 1.2.2
* @deprecated Use wp_signon() * @deprecated 2.5.0 Use wp_signon()
* @see wp_signon()
*
* @global string $error Error when false is returned * @global string $error Error when false is returned
* *
* @param string $username User's username * @param string $username User's username
@ -177,6 +175,7 @@ endif;
* *
* @since 2.2.0 * @since 2.2.0
* @deprecated 3.5.0 * @deprecated 3.5.0
*
* @link https://wordpress.org/plugins/atom-publishing-protocol/ * @link https://wordpress.org/plugins/atom-publishing-protocol/
*/ */
if ( ! class_exists( 'wp_atom_server' ) ) { if ( ! class_exists( 'wp_atom_server' ) ) {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-33673'; $wp_version = '4.4-alpha-33674';
/** /**
* 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.