Wordpress 4.6
[autoinstalls/wordpress.git] / wp-includes / ms-functions.php
index dfb25daa0c264c487356be5987530dd4f2e9bcaf..a253a61dac97f1ccd9b6020e217e9e64d67d0496 100644 (file)
@@ -115,7 +115,7 @@ function get_user_count() {
  */
 function get_blog_count( $network_id = 0 ) {
        if ( func_num_args() )
-               _deprecated_argument( __FUNCTION__, '3.1' );
+               _deprecated_argument( __FUNCTION__, '3.1.0' );
 
        return get_site_option( 'blog_count' );
 }
@@ -138,10 +138,9 @@ function get_blog_post( $blog_id, $post_id ) {
 }
 
 /**
- * Add a user to a blog.
+ * Adds a user to a blog.
  *
- * Use the 'add_user_to_blog' action to fire an event when
- * users are added to a blog.
+ * Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
  *
  * @since MU 1.0
  *
@@ -187,10 +186,10 @@ function add_user_to_blog( $blog_id, $user_id, $role ) {
 /**
  * Remove a user from a blog.
  *
- * Use the 'remove_user_from_blog' action to fire an event when
+ * Use the {@see 'remove_user_from_blog'} action to fire an event when
  * users are removed from a blog.
  *
- * Accepts an optional $reassign parameter, if you want to
+ * Accepts an optional `$reassign` parameter, if you want to
  * reassign the user's blog posts to another user upon removal.
  *
  * @since MU 1.0
@@ -305,8 +304,6 @@ function get_blog_permalink( $blog_id, $post_id ) {
  * @return int 0 if no blog found, otherwise the ID of the matching blog
  */
 function get_blog_id_from_url( $domain, $path = '/' ) {
-       global $wpdb;
-
        $domain = strtolower( $domain );
        $path = strtolower( $path );
        $id = wp_cache_get( md5( $domain . $path ), 'blog-id-cache' );
@@ -316,7 +313,13 @@ function get_blog_id_from_url( $domain, $path = '/' ) {
        elseif ( $id )
                return (int) $id;
 
-       $id = $wpdb->get_var( $wpdb->prepare( "SELECT blog_id FROM $wpdb->blogs WHERE domain = %s and path = %s /* get_blog_id_from_url */", $domain, $path ) );
+       $args = array(
+               'domain' => $domain,
+               'path' => $path,
+               'fields' => 'ids',
+       );
+       $result = get_sites( $args );
+       $id = array_shift( $result );
 
        if ( ! $id ) {
                wp_cache_set( md5( $domain . $path ), -1, 'blog-id-cache' );
@@ -374,7 +377,7 @@ function is_email_address_unsafe( $user_email ) {
        }
 
        /**
-        * Filter whether an email address is unsafe.
+        * Filters whether an email address is unsafe.
         *
         * @since 3.5.0
         *
@@ -497,7 +500,7 @@ function wpmu_validate_user_signup($user_name, $user_email) {
        $result = array('user_name' => $user_name, 'orig_username' => $orig_username, 'user_email' => $user_email, 'errors' => $errors);
 
        /**
-        * Filter the validated user registration details.
+        * Filters the validated user registration details.
         *
         * This does not allow you to override the username or email of the user during
         * registration. The values are solely used for validation and error handling.
@@ -527,7 +530,7 @@ function wpmu_validate_user_signup($user_name, $user_email) {
  * $user parameter to the function, where $user is the other user, is
  * effectively an override of this limitation.
  *
- * Filter 'wpmu_validate_blog_signup' if you want to modify
+ * Filter {@see 'wpmu_validate_blog_signup'} if you want to modify
  * the way that WordPress validates new site signups.
  *
  * @since MU
@@ -585,7 +588,7 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
                $errors->add('blogname', __('Sorry, site names must have letters too!'));
 
        /**
-        * Filter the new site name during registration.
+        * Filters the new site name during registration.
         *
         * The name is the site's subdomain or the site's subdirectory
         * path depending on the network settings.
@@ -631,7 +634,7 @@ function wpmu_validate_blog_signup( $blogname, $blog_title, $user = '' ) {
        $result = array('domain' => $mydomain, 'path' => $path, 'blogname' => $blogname, 'blog_title' => $blog_title, 'user' => $user, 'errors' => $errors);
 
        /**
-        * Filter site details and error messages following registration.
+        * Filters site details and error messages following registration.
         *
         * @since MU
         *
@@ -749,11 +752,11 @@ function wpmu_signup_user( $user, $user_email, $meta = array() ) {
  * This is the notification function used when site registration
  * is enabled.
  *
- * Filter 'wpmu_signup_blog_notification' to bypass this function or
+ * Filter {@see 'wpmu_signup_blog_notification'} to bypass this function or
  * replace it with your own notification behavior.
  *
- * Filter 'wpmu_signup_blog_notification_email' and
- * 'wpmu_signup_blog_notification_subject' to change the content
+ * Filter {@see 'wpmu_signup_blog_notification_email'} and
+ * {@see 'wpmu_signup_blog_notification_subject'} to change the content
  * and subject line of the email sent to newly registered users.
  *
  * @since MU
@@ -769,7 +772,7 @@ function wpmu_signup_user( $user, $user_email, $meta = array() ) {
  */
 function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_email, $key, $meta = array() ) {
        /**
-        * Filter whether to bypass the new site email notification.
+        * Filters whether to bypass the new site email notification.
         *
         * @since MU
         *
@@ -799,7 +802,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema
        $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
        $message = sprintf(
                /**
-                * Filter the message content of the new blog notification email.
+                * Filters the message content of the new blog notification email.
                 *
                 * Content should be formatted for transmission via wp_mail().
                 *
@@ -825,7 +828,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema
        // TODO: Don't hard code activation link.
        $subject = sprintf(
                /**
-                * Filter the subject of the new blog notification email.
+                * Filters the subject of the new blog notification email.
                 *
                 * @since MU
                 *
@@ -855,11 +858,11 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema
  * This is the notification function used when no new site has
  * been requested.
  *
- * Filter 'wpmu_signup_user_notification' to bypass this function or
+ * Filter {@see 'wpmu_signup_user_notification'} to bypass this function or
  * replace it with your own notification behavior.
  *
- * Filter 'wpmu_signup_user_notification_email' and
- * 'wpmu_signup_user_notification_subject' to change the content
+ * Filter {@see 'wpmu_signup_user_notification_email'} and
+ * {@see 'wpmu_signup_user_notification_subject'} to change the content
  * and subject line of the email sent to newly registered users.
  *
  * @since MU
@@ -872,7 +875,7 @@ function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_ema
  */
 function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) {
        /**
-        * Filter whether to bypass the email notification for new user sign-up.
+        * Filters whether to bypass the email notification for new user sign-up.
         *
         * @since MU
         *
@@ -892,7 +895,7 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array(
        $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
        $message = sprintf(
                /**
-                * Filter the content of the notification email for new user sign-up.
+                * Filters the content of the notification email for new user sign-up.
                 *
                 * Content should be formatted for transmission via wp_mail().
                 *
@@ -913,7 +916,7 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array(
        // TODO: Don't hard code activation link.
        $subject = sprintf(
                /**
-                * Filter the subject of the notification email of new user signup.
+                * Filters the subject of the notification email of new user signup.
                 *
                 * @since MU
                 *
@@ -937,7 +940,7 @@ function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array(
 /**
  * Activate a signup.
  *
- * Hook to 'wpmu_activate_user' or 'wpmu_activate_blog' for events
+ * Hook to {@see 'wpmu_activate_user'} or {@see 'wpmu_activate_blog'} for events
  * that should happen only when users or sites are self-created (since
  * those actions are not called when users and sites are created
  * by a Super Admin).
@@ -1032,9 +1035,9 @@ function wpmu_activate_signup($key) {
  * Create a user.
  *
  * This function runs when a user self-registers as well as when
- * a Super Admin creates a new user. Hook to 'wpmu_new_user' for events
+ * a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events
  * that should affect all new users, but only on Multisite (otherwise
- * use 'user_register').
+ * use {@see'user_register'}).
  *
  * @since MU
  *
@@ -1070,7 +1073,7 @@ function wpmu_create_user( $user_name, $password, $email ) {
  * Create a site.
  *
  * This function runs when a user self-registers a new site as well
- * as when a Super Admin creates a new site. Hook to 'wpmu_new_blog'
+ * as when a Super Admin creates a new site. Hook to {@see 'wpmu_new_blog'}
  * for events that should affect all new sites.
  *
  * On subdirectory installs, $domain is the same as the main site's
@@ -1148,13 +1151,15 @@ function wpmu_create_blog( $domain, $path, $title, $user_id, $meta = array(), $s
         */
        do_action( 'wpmu_new_blog', $blog_id, $user_id, $domain, $path, $site_id, $meta );
 
+       wp_cache_set( 'last_changed', microtime(), 'sites' );
+
        return $blog_id;
 }
 
 /**
  * Notifies the network admin that a new site has been activated.
  *
- * Filter 'newblog_notify_siteadmin' to change the content of
+ * Filter {@see 'newblog_notify_siteadmin'} to change the content of
  * the notification email.
  *
  * @since MU
@@ -1184,7 +1189,7 @@ Remote IP: %3$s
 
 Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
        /**
-        * Filter the message body of the new site activation email sent
+        * Filters the message body of the new site activation email sent
         * to the network administrator.
         *
         * @since MU
@@ -1200,7 +1205,7 @@ Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER[
 /**
  * Notifies the network admin that a new user has been activated.
  *
- * Filter 'newuser_notify_siteadmin' to change the content of
+ * Filter {@see 'newuser_notify_siteadmin'} to change the content of
  * the notification email.
  *
  * @since MU
@@ -1226,7 +1231,7 @@ Remote IP: %2$s
 Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
 
        /**
-        * Filter the message body of the new user activation email sent
+        * Filters the message body of the new user activation email sent
         * to the network administrator.
         *
         * @since MU
@@ -1255,12 +1260,18 @@ Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['RE
  * @return int
  */
 function domain_exists($domain, $path, $site_id = 1) {
-       global $wpdb;
        $path = trailingslashit( $path );
-       $result = $wpdb->get_var( $wpdb->prepare("SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s AND site_id = %d", $domain, $path, $site_id) );
+       $args = array(
+               'network_id' => $site_id,
+               'domain' => $domain,
+               'path' => $path,
+               'fields' => 'ids',
+       );
+       $result = get_sites( $args );
+       $result = array_shift( $result );
 
        /**
-        * Filter whether a blogname is taken.
+        * Filters whether a blogname is taken.
         *
         * @since 3.5.0
         *
@@ -1402,9 +1413,9 @@ function install_blog_defaults($blog_id, $user_id) {
 /**
  * Notify a user that their blog activation has been successful.
  *
- * Filter 'wpmu_welcome_notification' to disable or bypass.
+ * Filter {@see 'wpmu_welcome_notification'} to disable or bypass.
  *
- * Filter 'update_welcome_email' and 'update_welcome_subject' to
+ * Filter {@see 'update_welcome_email'} and {@see 'update_welcome_subject'} to
  * modify the content and subject line of the notification email.
  *
  * @since MU
@@ -1420,7 +1431,7 @@ function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta
        $current_site = get_current_site();
 
        /**
-        * Filter whether to bypass the welcome email after site activation.
+        * Filters whether to bypass the welcome email after site activation.
         *
         * Returning false disables the welcome email.
         *
@@ -1464,7 +1475,7 @@ We hope you enjoy your new site. Thanks!
        $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
 
        /**
-        * Filter the content of the welcome email after site activation.
+        * Filters the content of the welcome email after site activation.
         *
         * Content should be formatted for transmission via wp_mail().
         *
@@ -1491,7 +1502,7 @@ We hope you enjoy your new site. Thanks!
                $current_site->site_name = 'WordPress';
 
        /**
-        * Filter the subject of the welcome email after site activation.
+        * Filters the subject of the welcome email after site activation.
         *
         * @since MU
         *
@@ -1505,9 +1516,9 @@ We hope you enjoy your new site. Thanks!
 /**
  * Notify a user that their account activation has been successful.
  *
- * Filter 'wpmu_welcome_user_notification' to disable or bypass.
+ * Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.
  *
- * Filter 'update_welcome_user_email' and 'update_welcome_user_subject' to
+ * Filter {@see 'update_welcome_user_email'} and {@see 'update_welcome_user_subject'} to
  * modify the content and subject line of the notification email.
  *
  * @since MU
@@ -1521,7 +1532,7 @@ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() )
        $current_site = get_current_site();
 
        /**
-        * Filter whether to bypass the welcome email after user activation.
+        * Filters whether to bypass the welcome email after user activation.
         *
         * Returning false disables the welcome email.
         *
@@ -1569,7 +1580,7 @@ function wpmu_welcome_user_notification( $user_id, $password, $meta = array() )
                $current_site->site_name = 'WordPress';
 
        /**
-        * Filter the subject of the welcome email after user activation.
+        * Filters the subject of the welcome email after user activation.
         *
         * @since MU
         *
@@ -1924,7 +1935,7 @@ function signup_nonce_check( $result ) {
  */
 function maybe_redirect_404() {
        /**
-        * Filter the redirect URL for 404s on the main site.
+        * Filters the redirect URL for 404s on the main site.
         *
         * The filter is only evaluated if the NOBLOGREDIRECT constant is defined.
         *
@@ -1998,10 +2009,10 @@ function add_existing_user_to_blog( $details = false ) {
 }
 
 /**
- * Add a newly created user to the appropriate blog
+ * Adds a newly created user to the appropriate blog
  *
  * To add a user in general, use add_user_to_blog(). This function
- * is specifically hooked into the wpmu_activate_user action.
+ * is specifically hooked into the {@see 'wpmu_activate_user'} action.
  *
  * @since MU
  * @see add_user_to_blog()
@@ -2200,7 +2211,7 @@ function wp_update_network_counts() {
 /**
  * Update the count of sites for the current network.
  *
- * If enabled through the 'enable_live_network_counts' filter, update the sites count
+ * If enabled through the {@see 'enable_live_network_counts'} filter, update the sites count
  * on a network when a site is created or its status is updated.
  *
  * @since 3.7.0
@@ -2209,7 +2220,7 @@ function wp_maybe_update_network_site_counts() {
        $is_small_network = ! wp_is_large_network( 'sites' );
 
        /**
-        * Filter whether to update network site or user counts when a new site is created.
+        * Filters whether to update network site or user counts when a new site is created.
         *
         * @since 3.7.0
         *
@@ -2227,7 +2238,7 @@ function wp_maybe_update_network_site_counts() {
 /**
  * Update the network-wide users count.
  *
- * If enabled through the 'enable_live_network_counts' filter, update the users count
+ * If enabled through the {@see 'enable_live_network_counts'} filter, update the users count
  * on a network when a user is created or its status is updated.
  *
  * @since 3.7.0
@@ -2252,7 +2263,14 @@ function wp_maybe_update_network_user_counts() {
 function wp_update_network_site_counts() {
        global $wpdb;
 
-       $count = $wpdb->get_var( $wpdb->prepare("SELECT COUNT(blog_id) as c FROM $wpdb->blogs WHERE site_id = %d AND spam = '0' AND deleted = '0' and archived = '0'", $wpdb->siteid) );
+       $count = get_sites( array(
+               'network_id' => $wpdb->siteid,
+               'spam'       => 0,
+               'deleted'    => 0,
+               'archived'   => 0,
+               'count'      => true,
+       ) );
+
        update_site_option( 'blog_count', $count );
 }
 
@@ -2279,7 +2297,7 @@ function wp_update_network_user_counts() {
  */
 function get_space_used() {
        /**
-        * Filter the amount of storage space used by the current site.
+        * Filters the amount of storage space used by the current site.
         *
         * @since 3.5.0
         *
@@ -2311,7 +2329,7 @@ function get_space_allowed() {
                $space_allowed = 100;
 
        /**
-        * Filter the upload quota for the current site.
+        * Filters the upload quota for the current site.
         *
         * @since 3.7.0
         *
@@ -2377,7 +2395,7 @@ function upload_size_limit_filter( $size ) {
  * Whether or not we have a large network.
  *
  * The default criteria for a large network is either more than 10,000 users or more than 10,000 sites.
- * Plugins can alter this criteria using the 'wp_is_large_network' filter.
+ * Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.
  *
  * @since 3.3.0
  * @param string $using 'sites or 'users'. Default is 'sites'.
@@ -2387,7 +2405,7 @@ function wp_is_large_network( $using = 'sites' ) {
        if ( 'users' == $using ) {
                $count = get_user_count();
                /**
-                * Filter whether the network is considered large.
+                * Filters whether the network is considered large.
                 *
                 * @since 3.3.0
                 *
@@ -2403,85 +2421,6 @@ function wp_is_large_network( $using = 'sites' ) {
        return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count );
 }
 
-
-/**
- * Return an array of sites for a network or networks.
- *
- * @since 3.7.0
- *
- * @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;
-
-       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 );
-
-       $query = "SELECT * FROM $wpdb->blogs WHERE 1=1 ";
-
-       if ( isset( $args['network_id'] ) && ( is_array( $args['network_id'] ) || is_numeric( $args['network_id'] ) ) ) {
-               $network_ids = implode( ',', wp_parse_id_list( $args['network_id'] ) );
-               $query .= "AND site_id IN ($network_ids) ";
-       }
-
-       if ( isset( $args['public'] ) )
-               $query .= $wpdb->prepare( "AND public = %d ", $args['public'] );
-
-       if ( isset( $args['archived'] ) )
-               $query .= $wpdb->prepare( "AND archived = %d ", $args['archived'] );
-
-       if ( isset( $args['mature'] ) )
-               $query .= $wpdb->prepare( "AND mature = %d ", $args['mature'] );
-
-       if ( isset( $args['spam'] ) )
-               $query .= $wpdb->prepare( "AND spam = %d ", $args['spam'] );
-
-       if ( isset( $args['deleted'] ) )
-               $query .= $wpdb->prepare( "AND deleted = %d ", $args['deleted'] );
-
-       if ( isset( $args['limit'] ) && $args['limit'] ) {
-               if ( isset( $args['offset'] ) && $args['offset'] )
-                       $query .= $wpdb->prepare( "LIMIT %d , %d ", $args['offset'], $args['limit'] );
-               else
-                       $query .= $wpdb->prepare( "LIMIT %d ", $args['limit'] );
-       }
-
-       $site_results = $wpdb->get_results( $query, ARRAY_A );
-
-       return $site_results;
-}
-
 /**
  * Retrieves a list of reserved site on a sub-directory Multisite install.
  *
@@ -2496,7 +2435,7 @@ function get_subdirectory_reserved_names() {
        );
 
        /**
-        * Filter reserved site names on a sub-directory Multisite install.
+        * Filters reserved site names on a sub-directory Multisite install.
         *
         * @since 3.0.0
         * @since 4.4.0 'wp-admin', 'wp-content', 'wp-includes', 'wp-json', and 'embed' were added