From 15f3acfbf5053be181511d579e3e5db80124aad8 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 26 Feb 2016 09:15:45 +0000 Subject: [PATCH] Docs: Add some missing `@param` notations to various DocBlocks in wp-includes/ms-deprecated.php. See #32246. git-svn-id: https://develop.svn.wordpress.org/trunk@36725 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/ms-deprecated.php | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/src/wp-includes/ms-deprecated.php b/src/wp-includes/ms-deprecated.php index 33b544ff7d..19224d78d7 100644 --- a/src/wp-includes/ms-deprecated.php +++ b/src/wp-includes/ms-deprecated.php @@ -122,6 +122,8 @@ endif; * @since MU * @deprecated 3.0.0 Use get_user_by() * @see get_user_by() + * + * @param string $username Username. */ function get_user_details( $username ) { _deprecated_function( __FUNCTION__, '3.0', 'get_user_by()' ); @@ -134,6 +136,8 @@ function get_user_details( $username ) { * @since MU * @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 ) { _deprecated_function( __FUNCTION__, '3.0', 'clean_post_cache()' ); @@ -173,6 +177,10 @@ function validate_email( $email, $check_domain = true) { * @since MU * @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 = '' ) { _deprecated_function( __FUNCTION__, '3.0', 'wp_get_sites()' ); @@ -203,6 +211,8 @@ function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) { * @since MU * @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. */ function get_most_active_blogs( $num = 10, $display = true ) { @@ -254,7 +264,7 @@ function get_most_active_blogs( $num = 10, $display = true ) { * @deprecated 3.3.0 Use wp_redirect() * @see wp_redirect() * - * @param string $url + * @param string $url Optional. Redirect URL. Default empty. */ function wpmu_admin_do_redirect( $url = '' ) { _deprecated_function( __FUNCTION__, '3.3' ); @@ -293,7 +303,7 @@ function wpmu_admin_do_redirect( $url = '' ) { * @deprecated 3.3.0 Use add_query_arg() * @see add_query_arg() * - * @param string $url + * @param string $url Optional. Redirect URL. Default empty. * @return string */ function wpmu_admin_redirect_add_updated_param( $url = '' ) {