Changeset 36725

Timestamp:

02/26/2016 09:15:45 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add some missing @param notations to various DocBlocks in wp-includes/ms-deprecated.php.

See #32246.

File:

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

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

@@ -123 +123 @@
  * @deprecated 3.0.0 Use get_user_by()
  * @see get_user_by()
+ *
+ * @param string $username Username.
  */
 function get_user_details( $username ) {
@@ -135 +137 @@
  * @deprecated 3.0.0 Use clean_post_cache()
  * @see clean_post_cache()
+ *
+ * @param int $post_id Post ID.
  */
 function clear_global_post_cache( $post_id ) {
@@ -174 +178 @@
  * @deprecated 3.0.0 Use wp_get_sites()
  * @see wp_get_sites()
+ *
+ * @param int    $start      Optional. Offset for retrieving the blog list. Default 0.
+ * @param int    $num        Optional. Number of blogs to list. Default 10.
+ * @param string $deprecated Unused.
  */
 function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) {
@@ -204 +212 @@
  * @deprecated 3.0.0
  *
+ * @param int  $num     Optional. Number of activate blogs to retrieve. Default 10.
+ * @param bool $display Optional. Whether or not to display the most active blogs list. Default true.
  * @return array List of "most active" sites.
  */
@@ -255 +265 @@
  * @see wp_redirect()
  *
- * @param string $url
+ * @param string $url Optional. Redirect URL. Default empty.
  */
 function wpmu_admin_do_redirect( $url = '' ) {
@@ -294 +304 @@
  * @see add_query_arg()
  *
- * @param string $url
+ * @param string $url Optional. Redirect URL. Default empty.
  * @return string
  */