Changeset 33676

Timestamp:

08/20/2015 10:35:30 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Standardize @deprecated tag formatting and add missing summaries to deprecated functions in wp-includes/ms-deprecated.php.

Props Alphawolf for the initial patch.
Props DrewAPicture

See #28806.

File:

• trunk/src/wp-includes/ms-deprecated.php (modified) (13 diffs)

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

@@ -19 +19 @@
  *
  * @since MU
- * @deprecated 3.1.0
+ * @deprecated 3.1.0 Use get_blog_details()
  * @see get_blog_details()
- * @return int
+ *
+ * @return int Current site ID.
  */
 function get_dashboard_blog() {
@@ -32 +33 @@
 
 /**
- * @since MU
- * @deprecated 3.0.0
- * @deprecated Use wp_generate_password()
+ * Generates a random password.
+ *
+ * @since MU
+ * @deprecated 3.0.0 Use wp_generate_password()
  * @see wp_generate_password()
  */
@@ -52 +54 @@
  *
  * @since MU
- * @deprecated 3.0.0
- * @deprecated Use is_super_admin()
+ * @deprecated 3.0.0 Use is_super_admin()
  * @see is_super_admin()
- * @see is_multisite()
- *
  */
 function is_site_admin( $user_login = '' ) {
@@ -77 +76 @@
 if ( !function_exists( 'graceful_fail' ) ) :
 /**
- * @since MU
- * @deprecated 3.0.0
- * @deprecated Use wp_die()
+ * Deprecated functionality to gracefully fail.
+ *
+ * @since MU
+ * @deprecated 3.0.0 Use wp_die()
  * @see wp_die()
  */
@@ -114 +114 @@
 
 /**
- * @since MU
- * @deprecated 3.0.0
- * @deprecated Use get_user_by()
+ * Deprecated functionality to retrieve user information.
+ *
+ * @since MU
+ * @deprecated 3.0.0 Use get_user_by()
  * @see get_user_by()
  */
@@ -125 +126 @@
 
 /**
- * @since MU
- * @deprecated 3.0.0
- * @deprecated Use clean_post_cache()
+ * Deprecated functionality to clear the global post cache.
+ *
+ * @since MU
+ * @deprecated 3.0.0 Use clean_post_cache()
  * @see clean_post_cache()
  */
@@ -135 +137 @@
 
 /**
- * @since MU
- * @deprecated 3.0.0
- * @deprecated Use is_main_site()
+ * Deprecated functionality to determin if the current site is the main site.
+ *
+ * @since MU
+ * @deprecated 3.0.0 Use is_main_site()
  * @see is_main_site()
  */
@@ -146 +149 @@
 
 /**
- * @since MU
- * @deprecated 3.0.0
- * @deprecated Use is_email()
+ * Deprecated functionality to validate an email address.
+ *
+ * @since MU
+ * @deprecated 3.0.0 Use is_email()
  * @see is_email()
  */
@@ -157 +161 @@
 
 /**
- * @since MU
- * @deprecated 3.0.0
- * @deprecated No alternative available. For performance reasons this function is not recommended.
+ * Deprecated functionality to retrieve a list of all sites.
+ *
+ * @since MU
+ * @deprecated 3.0.0 Use wp_get_sites()
+ * @see wp_get_sites()
  */
 function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) {
@@ -185 +191 @@
 
 /**
+ * Deprecated functionality to retrieve a list of the most active sites.
+ *
  * @since MU
  * @deprecated 3.0.0
- * @deprecated No alternative available. For performance reasons this function is not recommended.
+ *
+ * @return array List of "most active" sites.
  */
 function get_most_active_blogs( $num = 10, $display = true ) {
@@ -235 +244 @@
  *
  * @since MU
- * @deprecated 3.3.0
- * @deprecated Use wp_redirect()
+ * @deprecated 3.3.0 Use wp_redirect()
+ * @see wp_redirect()
  *
  * @param string $url
@@ -274 +283 @@
  *
  * @since MU
- * @deprecated 3.3.0
- * @deprecated Use add_query_arg()
+ * @deprecated 3.3.0 Use add_query_arg()
+ * @see add_query_arg()
  *
  * @param string $url
@@ -299 +308 @@
  *
  * @since MU
- * @deprecated 3.6.0
- * @deprecated Use get_user_by()
+ * @deprecated 3.6.0 Use get_user_by()
+ * @see get_user_by()
  *
  * @param string $string Either an email address or a login.