sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36725 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-02-26 09:15:45 +00:00
parent 39af9db8a5
commit 15f3acfbf5
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/wp-includes/ms-deprecated.php
View File

@ -122,6 +122,8 @@ endif;
* @since MU * @since MU
* @deprecated 3.0.0 Use get_user_by() * @deprecated 3.0.0 Use get_user_by()
* @see get_user_by() * @see get_user_by()
*
* @param string $username Username.
*/ */
function get_user_details( $username ) { function get_user_details( $username ) {
_deprecated_function( __FUNCTION__, '3.0', 'get_user_by()' ); _deprecated_function( __FUNCTION__, '3.0', 'get_user_by()' );
@ -134,6 +136,8 @@ function get_user_details( $username ) {
* @since MU * @since MU
* @deprecated 3.0.0 Use clean_post_cache() * @deprecated 3.0.0 Use clean_post_cache()
* @see clean_post_cache() * @see clean_post_cache()
*
* @param int $post_id Post ID.
*/ */
function clear_global_post_cache( $post_id ) { function clear_global_post_cache( $post_id ) {
_deprecated_function( __FUNCTION__, '3.0', 'clean_post_cache()' ); _deprecated_function( __FUNCTION__, '3.0', 'clean_post_cache()' );
@ -173,6 +177,10 @@ function validate_email( $email, $check_domain = true) {
* @since MU * @since MU
* @deprecated 3.0.0 Use wp_get_sites() * @deprecated 3.0.0 Use wp_get_sites()
* @see 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 = '' ) { function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) {
_deprecated_function( __FUNCTION__, '3.0', 'wp_get_sites()' ); _deprecated_function( __FUNCTION__, '3.0', 'wp_get_sites()' );
@ -203,6 +211,8 @@ function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) {
* @since MU * @since MU
* @deprecated 3.0.0 * @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. * @return array List of "most active" sites.
*/ */
function get_most_active_blogs( $num = 10, $display = true ) { 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() * @deprecated 3.3.0 Use wp_redirect()
* @see wp_redirect() * @see wp_redirect()
* *
* @param string $url * @param string $url Optional. Redirect URL. Default empty.
*/ */
function wpmu_admin_do_redirect( $url = '' ) { function wpmu_admin_do_redirect( $url = '' ) {
_deprecated_function( __FUNCTION__, '3.3' ); _deprecated_function( __FUNCTION__, '3.3' );
@ -293,7 +303,7 @@ function wpmu_admin_do_redirect( $url = '' ) {
* @deprecated 3.3.0 Use add_query_arg() * @deprecated 3.3.0 Use add_query_arg()
* @see add_query_arg() * @see add_query_arg()
* *
* @param string $url * @param string $url Optional. Redirect URL. Default empty.
* @return string * @return string
*/ */
function wpmu_admin_redirect_add_updated_param( $url = '' ) { function wpmu_admin_redirect_add_updated_param( $url = '' ) {