Changeset 33674

Timestamp:

08/20/2015 10:14:44 PM (9 years ago)

Author:

DrewAPicture

Message:

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

Props Alphawolf for the initial patch.
Props DrewAPicture.

See #28806.

File:

• trunk/src/wp-includes/pluggable-deprecated.php (modified) (8 diffs)

trunk/src/wp-includes/pluggable-deprecated.php

@@ -23 +23 @@
  *
  * @since 2.0.1
- * @see wp_set_current_user() An alias of wp_set_current_user()
- * @deprecated 3.0.0
- * @deprecated Use wp_set_current_user()
+ * @deprecated 3.0.0 Use wp_set_current_user()
+ * @see wp_set_current_user()
  *
  * @param int|null $id User ID.
@@ -42 +41 @@
  *
  * @since 0.71
- * @deprecated 3.3.0
- * @deprecated Use get_user_by('login')
+ * @deprecated 3.3.0 Use get_user_by()
+ * @see get_user_by()
  *
  * @param string $user_login User's username
@@ -59 +58 @@
  *
  * @since 2.5.0
- * @deprecated 3.3.0
- * @deprecated Use get_user_by('email')
+ * @deprecated 3.3.0 Use get_user_by()
+ * @see get_user_by()
  *
  * @param string $email User's email address
@@ -76 +75 @@
  *
  * @since 1.5.0
- * @deprecated 2.5.0
- * @deprecated Use wp_set_auth_cookie()
+ * @deprecated 2.5.0 Use wp_set_auth_cookie()
  * @see wp_set_auth_cookie()
  *
@@ -101 +99 @@
  *
  * @since 1.5.0
- * @deprecated 2.5.0
- * @deprecated Use wp_clear_auth_cookie()
+ * @deprecated 2.5.0 Use wp_clear_auth_cookie()
  * @see wp_clear_auth_cookie()
  */
@@ -122 +119 @@
  * @since 2.0.3
  * @deprecated 2.5.0
- * @deprecated No alternative
  *
  * @return bool Always returns false
@@ -146 +142 @@
  *
  * @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
  *
@@ -178 +176 @@
  * @since 2.2.0
  * @deprecated 3.5.0
+ *
  * @link https://wordpress.org/plugins/atom-publishing-protocol/
  */