X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/03f2fa83c13c1b532284205fa7efcab9b8b2c41f..refs/tags/wordpress-4.6.1-scripts:/wp-includes/ms-deprecated.php diff --git a/wp-includes/ms-deprecated.php b/wp-includes/ms-deprecated.php index e9ab99a7..7e43fccd 100644 --- a/wp-includes/ms-deprecated.php +++ b/wp-includes/ms-deprecated.php @@ -24,7 +24,7 @@ * @return int Current site ID. */ function get_dashboard_blog() { - _deprecated_function( __FUNCTION__, '3.1' ); + _deprecated_function( __FUNCTION__, '3.1.0' ); if ( $blog = get_site_option( 'dashboard_blog' ) ) return get_blog_details( $blog ); @@ -37,9 +37,11 @@ function get_dashboard_blog() { * @since MU * @deprecated 3.0.0 Use wp_generate_password() * @see wp_generate_password() + * + * @param int $len Optional. The length of password to generate. Default 8. */ function generate_random_password( $len = 8 ) { - _deprecated_function( __FUNCTION__, '3.0', 'wp_generate_password()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'wp_generate_password()' ); return wp_generate_password( $len ); } @@ -55,9 +57,11 @@ function generate_random_password( $len = 8 ) { * @since MU * @deprecated 3.0.0 Use is_super_admin() * @see is_super_admin() + * + * @param string $user_login Optional. Username for the user to check. Default empty. */ function is_site_admin( $user_login = '' ) { - _deprecated_function( __FUNCTION__, '3.0', 'is_super_admin()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'is_super_admin()' ); if ( empty( $user_login ) ) { $user_id = get_current_user_id(); @@ -82,7 +86,7 @@ if ( !function_exists( 'graceful_fail' ) ) : * @see wp_die() */ function graceful_fail( $message ) { - _deprecated_function( __FUNCTION__, '3.0', 'wp_die()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'wp_die()' ); $message = apply_filters( 'graceful_fail', $message ); $message_template = apply_filters( 'graceful_fail_template', ' @@ -118,9 +122,11 @@ 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()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'get_user_by()' ); return get_user_by('login', $username); } @@ -130,9 +136,11 @@ 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()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'clean_post_cache()' ); } /** @@ -143,7 +151,7 @@ function clear_global_post_cache( $post_id ) { * @see is_main_site() */ function is_main_blog() { - _deprecated_function( __FUNCTION__, '3.0', 'is_main_site()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'is_main_site()' ); return is_main_site(); } @@ -153,9 +161,13 @@ function is_main_blog() { * @since MU * @deprecated 3.0.0 Use is_email() * @see is_email() + * + * @param string $email Email address to verify. + * @param bool $check_domain Deprecated. + * @return string|bool Either false or the valid email address. */ function validate_email( $email, $check_domain = true) { - _deprecated_function( __FUNCTION__, '3.0', 'is_email()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'is_email()' ); return is_email( $email, $check_domain ); } @@ -165,9 +177,13 @@ 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()' ); + _deprecated_function( __FUNCTION__, '3.0.0', 'wp_get_sites()' ); global $wpdb; $blogs = $wpdb->get_results( $wpdb->prepare("SELECT blog_id, domain, path FROM $wpdb->blogs WHERE site_id = %d AND public = '1' AND archived = '0' AND mature = '0' AND spam = '0' AND deleted = '0' ORDER BY registered DESC", $wpdb->siteid), ARRAY_A ); @@ -195,10 +211,12 @@ 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 ) { - _deprecated_function( __FUNCTION__, '3.0' ); + _deprecated_function( __FUNCTION__, '3.0.0' ); $blogs = get_blog_list( 0, 'all', false ); // $blog_id -> $details if ( is_array( $blogs ) ) { @@ -246,10 +264,10 @@ 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' ); + _deprecated_function( __FUNCTION__, '3.3.0' ); $ref = ''; if ( isset( $_GET['ref'] ) ) @@ -285,11 +303,11 @@ 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 = '' ) { - _deprecated_function( __FUNCTION__, '3.3' ); + _deprecated_function( __FUNCTION__, '3.3.0' ); if ( strpos( $url, 'updated=true' ) === false ) { if ( strpos( $url, '?' ) === false ) @@ -314,7 +332,7 @@ function wpmu_admin_redirect_add_updated_param( $url = '' ) { * @return int */ function get_user_id_from_string( $string ) { - _deprecated_function( __FUNCTION__, '3.6', 'get_user_by()' ); + _deprecated_function( __FUNCTION__, '3.6.0', 'get_user_by()' ); if ( is_email( $string ) ) $user = get_user_by( 'email', $string ); @@ -339,7 +357,7 @@ function get_user_id_from_string( $string ) { * @return string */ function get_blogaddress_by_domain( $domain, $path ) { - _deprecated_function( __FUNCTION__, '3.7' ); + _deprecated_function( __FUNCTION__, '3.7.0' ); if ( is_subdomain_install() ) { $url = "http://" . $domain.$path; @@ -370,7 +388,7 @@ function get_blogaddress_by_domain( $domain, $path ) { * @return string|int The ID of the newly created blog */ function create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 ) { - _deprecated_function( __FUNCTION__, '4.4' ); + _deprecated_function( __FUNCTION__, '4.4.0' ); if ( empty($path) ) $path = '/'; @@ -406,7 +424,7 @@ function create_empty_blog( $domain, $path, $weblog_title, $site_id = 1 ) { * @return array|false The network admins */ function get_admin_users_for_domain( $sitedomain = '', $path = '' ) { - _deprecated_function( __FUNCTION__, '4.4' ); + _deprecated_function( __FUNCTION__, '4.4.0' ); global $wpdb; @@ -420,3 +438,77 @@ function get_admin_users_for_domain( $sitedomain = '', $path = '' ) { return false; } + +/** + * Return an array of sites for a network or networks. + * + * @since 3.7.0 + * @deprecated 4.6.0 + * @see get_sites() + * + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param array $args { + * Array of default arguments. Optional. + * + * @type int|array $network_id A network ID or array of network IDs. Set to null to retrieve sites + * from all networks. Defaults to current network ID. + * @type int $public Retrieve public or non-public sites. Default null, for any. + * @type int $archived Retrieve archived or non-archived sites. Default null, for any. + * @type int $mature Retrieve mature or non-mature sites. Default null, for any. + * @type int $spam Retrieve spam or non-spam sites. Default null, for any. + * @type int $deleted Retrieve deleted or non-deleted sites. Default null, for any. + * @type int $limit Number of sites to limit the query to. Default 100. + * @type int $offset Exclude the first x sites. Used in combination with the $limit parameter. Default 0. + * } + * @return array An empty array if the install is considered "large" via wp_is_large_network(). Otherwise, + * an associative array of site data arrays, each containing the site (network) ID, blog ID, + * site domain and path, dates registered and modified, and the language ID. Also, boolean + * values for whether the site is public, archived, mature, spam, and/or deleted. + */ +function wp_get_sites( $args = array() ) { + global $wpdb; + + _deprecated_function( __FUNCTION__, '4.6.0', 'get_sites()' ); + + if ( wp_is_large_network() ) + return array(); + + $defaults = array( + 'network_id' => $wpdb->siteid, + 'public' => null, + 'archived' => null, + 'mature' => null, + 'spam' => null, + 'deleted' => null, + 'limit' => 100, + 'offset' => 0, + ); + + $args = wp_parse_args( $args, $defaults ); + + // Backwards compatibility + if( is_array( $args['network_id'] ) ){ + $args['network__in'] = $args['network_id']; + $args['network_id'] = null; + } + + if( is_numeric( $args['limit'] ) ){ + $args['number'] = $args['limit']; + $args['limit'] = null; + } + + // Make sure count is disabled. + $args['count'] = false; + + $_sites = get_sites( $args ); + + $results = array(); + + foreach ( $_sites as $_site ) { + $_site = get_site( $_site ); + $results[] = $_site->to_array(); + } + + return $results; +}