Wordpress 4.6
[autoinstalls/wordpress.git] / wp-includes / ms-blogs.php
index 9108d59e38b21cfe1470208c68cf34a5a8f4ab66..ccafd047688de2830b867a17a7c10b8b53be0a5f 100644 (file)
@@ -235,7 +235,7 @@ function get_blog_details( $fields = null, $get_all = true ) {
        restore_current_blog();
 
        /**
        restore_current_blog();
 
        /**
-        * Filter a blog's details.
+        * Filters a blog's details.
         *
         * @since MU
         *
         *
         * @since MU
         *
@@ -447,6 +447,7 @@ function clean_blog_cache( $blog ) {
        $domain_path_key = md5( $blog->domain . $blog->path );
 
        wp_cache_delete( $blog_id, 'sites' );
        $domain_path_key = md5( $blog->domain . $blog->path );
 
        wp_cache_delete( $blog_id, 'sites' );
+       wp_cache_delete( $blog_id, 'site-details' );
        wp_cache_delete( $blog_id , 'blog-details' );
        wp_cache_delete( $blog_id . 'short' , 'blog-details' );
        wp_cache_delete(  $domain_path_key, 'blog-lookup' );
        wp_cache_delete( $blog_id , 'blog-details' );
        wp_cache_delete( $blog_id . 'short' , 'blog-details' );
        wp_cache_delete(  $domain_path_key, 'blog-lookup' );
@@ -454,6 +455,156 @@ function clean_blog_cache( $blog ) {
        wp_cache_delete( 'current_blog_' . $blog->domain . $blog->path, 'site-options' );
        wp_cache_delete( 'get_id_from_blogname_' . trim( $blog->path, '/' ), 'blog-details' );
        wp_cache_delete( $domain_path_key, 'blog-id-cache' );
        wp_cache_delete( 'current_blog_' . $blog->domain . $blog->path, 'site-options' );
        wp_cache_delete( 'get_id_from_blogname_' . trim( $blog->path, '/' ), 'blog-details' );
        wp_cache_delete( $domain_path_key, 'blog-id-cache' );
+
+       /**
+        * Fires immediately after a site has been removed from the object cache.
+        *
+        * @since 4.6.0
+        *
+        * @param int     $id              Blog ID.
+        * @param WP_Site $blog            Site object.
+        * @param string  $domain_path_key md5 hash of domain and path.
+        */
+       do_action( 'clean_site_cache', $blog_id, $blog, $domain_path_key );
+
+       wp_cache_set( 'last_changed', microtime(), 'sites' );
+}
+
+/**
+ * Retrieves site data given a site ID or site object.
+ *
+ * Site data will be cached and returned after being passed through a filter.
+ * If the provided site is empty, the current site global will be used.
+ *
+ * @since 4.6.0
+ *
+ * @param WP_Site|int|null $site Optional. Site to retrieve. Default is the current site.
+ * @return WP_Site|null The site object or null if not found.
+ */
+function get_site( $site = null ) {
+       if ( empty( $site ) ) {
+               $site = get_current_blog_id();
+       }
+
+       if ( $site instanceof WP_Site ) {
+               $_site = $site;
+       } elseif ( is_object( $site ) ) {
+               $_site = new WP_Site( $site );
+       } else {
+               $_site = WP_Site::get_instance( $site );
+       }
+
+       if ( ! $_site ) {
+               return null;
+       }
+
+       /**
+        * Fires after a site is retrieved.
+        *
+        * @since 4.6.0
+        *
+        * @param WP_Site $_site Site data.
+        */
+       $_site = apply_filters( 'get_site', $_site );
+
+       return $_site;
+}
+
+/**
+ * Adds any sites from the given ids to the cache that do not already exist in cache.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @see update_site_cache()
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $ids ID list.
+ */
+function _prime_site_caches( $ids ) {
+       global $wpdb;
+
+       $non_cached_ids = _get_non_cached_ids( $ids, 'sites' );
+       if ( ! empty( $non_cached_ids ) ) {
+               $fresh_sites = $wpdb->get_results( sprintf( "SELECT * FROM $wpdb->blogs WHERE blog_id IN (%s)", join( ",", array_map( 'intval', $non_cached_ids ) ) ) );
+
+               update_site_cache( $fresh_sites );
+       }
+}
+
+/**
+ * Updates sites in cache.
+ *
+ * @since 4.6.0
+ *
+ * @param array $sites Array of site objects.
+ */
+function update_site_cache( $sites ) {
+       if ( ! $sites ) {
+               return;
+       }
+
+       foreach ( $sites as $site ) {
+               wp_cache_add( $site->blog_id, $site, 'sites' );
+               wp_cache_add( $site->blog_id . 'short', $site, 'blog-details' );
+       }
+}
+
+/**
+ * Retrieves a list of sites matching requested arguments.
+ *
+ * @since 4.6.0
+ *
+ * @see WP_Site_Query::parse_query()
+ *
+ * @param string|array $args {
+ *     Optional. Array or query string of site query parameters. Default empty.
+ *
+ *     @type array        $site__in          Array of site IDs to include. Default empty.
+ *     @type array        $site__not_in      Array of site IDs to exclude. Default empty.
+ *     @type bool         $count             Whether to return a site count (true) or array of site objects.
+ *                                           Default false.
+ *     @type array        $date_query        Date query clauses to limit sites by. See WP_Date_Query.
+ *                                           Default null.
+ *     @type string       $fields            Site fields to return. Accepts 'ids' for site IDs only or empty
+ *                                           for all fields. Default empty.
+ *     @type int          $ID                A site ID to only return that site. Default empty.
+ *     @type int          $number            Maximum number of sites to retrieve. Default null (no limit).
+ *     @type int          $offset            Number of sites to offset the query. Used to build LIMIT clause.
+ *                                           Default 0.
+ *     @type bool         $no_found_rows     Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true.
+ *     @type string|array $orderby           Site status or array of statuses. Accepts 'id', 'domain', 'path',
+ *                                           'network_id', 'last_updated', 'registered', 'domain_length',
+ *                                           'path_length', 'site__in' and 'network__in'. Also accepts false,
+ *                                           an empty array, or 'none' to disable `ORDER BY` clause.
+ *                                           Default 'id'.
+ *     @type string       $order             How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
+ *     @type int          $network_id        Limit results to those affiliated with a given network ID.
+ *                                           Default current network ID.
+ *     @type array        $network__in       Array of network IDs to include affiliated sites for. Default empty.
+ *     @type array        $network__not_in   Array of network IDs to exclude affiliated sites for. Default empty.
+ *     @type string       $domain            Limit results to those affiliated with a given domain.
+ *                                           Default empty.
+ *     @type array        $domain__in        Array of domains to include affiliated sites for. Default empty.
+ *     @type array        $domain__not_in    Array of domains to exclude affiliated sites for. Default empty.
+ *     @type string       $path              Limit results to those affiliated with a given path.
+ *                                           Default empty.
+ *     @type array        $path__in          Array of paths to include affiliated sites for. Default empty.
+ *     @type array        $path__not_in      Array of paths to exclude affiliated sites for. Default empty.
+ *     @type int          $public            Limit results to public sites. Accepts '1' or '0'. Default empty.
+ *     @type int          $archived          Limit results to archived sites. Accepts '1' or '0'. Default empty.
+ *     @type int          $mature            Limit results to mature sites. Accepts '1' or '0'. Default empty.
+ *     @type int          $spam              Limit results to spam sites. Accepts '1' or '0'. Default empty.
+ *     @type int          $deleted           Limit results to deleted sites. Accepts '1' or '0'. Default empty.
+ *     @type string       $search            Search term(s) to retrieve matching sites for. Default empty.
+ *     @type bool         $update_site_cache Whether to prime the cache for found sites. Default false.
+ * }
+ * @return array List of sites.
+ */
+function get_sites( $args = array() ) {
+       $query = new WP_Site_Query();
+
+       return $query->query( $args );
 }
 
 /**
 }
 
 /**
@@ -487,7 +638,7 @@ function get_blog_option( $id, $option, $default = false ) {
        restore_current_blog();
 
        /**
        restore_current_blog();
 
        /**
-        * Filter a blog option value.
+        * Filters a blog option value.
         *
         * The dynamic portion of the hook name, `$option`, refers to the blog option name.
         *
         *
         * The dynamic portion of the hook name, `$option`, refers to the blog option name.
         *
@@ -574,7 +725,7 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) {
        $id = (int) $id;
 
        if ( null !== $deprecated  )
        $id = (int) $id;
 
        if ( null !== $deprecated  )
-               _deprecated_argument( __FUNCTION__, '3.1' );
+               _deprecated_argument( __FUNCTION__, '3.1.0' );
 
        if ( get_current_blog_id() == $id )
                return update_option( $option, $value );
 
        if ( get_current_blog_id() == $id )
                return update_option( $option, $value );
@@ -660,9 +811,9 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
                        if ( is_array( $global_groups ) ) {
                                wp_cache_add_global_groups( $global_groups );
                        } else {
                        if ( is_array( $global_groups ) ) {
                                wp_cache_add_global_groups( $global_groups );
                        } else {
-                               wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache', 'networks', 'sites' ) );
+                               wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache', 'networks', 'sites', 'site-details' ) );
                        }
                        }
-                       wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) );
+                       wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
                }
        }
 
                }
        }
 
@@ -731,9 +882,9 @@ function restore_current_blog() {
                        if ( is_array( $global_groups ) ) {
                                wp_cache_add_global_groups( $global_groups );
                        } else {
                        if ( is_array( $global_groups ) ) {
                                wp_cache_add_global_groups( $global_groups );
                        } else {
-                               wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache', 'networks', 'sites' ) );
+                               wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache', 'networks', 'sites', 'site-details' ) );
                        }
                        }
-                       wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) );
+                       wp_cache_add_non_persistent_groups( array( 'counts', 'plugins' ) );
                }
        }
 
                }
        }
 
@@ -808,7 +959,7 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
        global $wpdb;
 
        if ( null !== $deprecated  )
        global $wpdb;
 
        if ( null !== $deprecated  )
-               _deprecated_argument( __FUNCTION__, '3.1' );
+               _deprecated_argument( __FUNCTION__, '3.1.0' );
 
        if ( ! in_array( $pref, array( 'site_id', 'domain', 'path', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id') ) )
                return $value;
 
        if ( ! in_array( $pref, array( 'site_id', 'domain', 'path', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id') ) )
                return $value;
@@ -909,6 +1060,127 @@ function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) {
        return $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' AND last_updated != '0000-00-00 00:00:00' ORDER BY last_updated DESC limit %d, %d", $wpdb->siteid, $start, $quantity ) , ARRAY_A );
 }
 
        return $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' AND last_updated != '0000-00-00 00:00:00' ORDER BY last_updated DESC limit %d, %d", $wpdb->siteid, $start, $quantity ) , ARRAY_A );
 }
 
+/**
+ * Retrieves a list of networks.
+ *
+ * @since 4.6.0
+ *
+ * @param string|array $args Optional. Array or string of arguments. See WP_Network_Query::parse_query()
+ *                           for information on accepted arguments. Default empty array.
+ * @return int|array List of networks or number of found networks if `$count` argument is true.
+ */
+function get_networks( $args = array() ) {
+       $query = new WP_Network_Query();
+
+       return $query->query( $args );
+}
+
+/**
+ * Retrieves network data given a network ID or network object.
+ *
+ * Network data will be cached and returned after being passed through a filter.
+ * If the provided network is empty, the current network global will be used.
+ *
+ * @since 4.6.0
+ *
+ * @global WP_Network $current_site
+ *
+ * @param WP_Network|int|null $network Optional. Network to retrieve. Default is the current network.
+ * @return WP_Network|null The network object or null if not found.
+ */
+function get_network( $network = null ) {
+       global $current_site;
+       if ( empty( $network ) && isset( $current_site ) ) {
+               $network = $current_site;
+       }
+
+       if ( $network instanceof WP_Network ) {
+               $_network = $network;
+       } elseif ( is_object( $network ) ) {
+               $_network = new WP_Network( $network );
+       } else {
+               $_network = WP_Network::get_instance( $network );
+       }
+
+       if ( ! $_network ) {
+               return null;
+       }
+
+       /**
+        * Fires after a network is retrieved.
+        *
+        * @since 4.6.0
+        *
+        * @param WP_Network $_network Network data.
+        */
+       $_network = apply_filters( 'get_network', $_network );
+
+       return $_network;
+}
+
+/**
+ * Removes a network from the object cache.
+ *
+ * @since 4.6.0
+ *
+ * @param int|array $ids Network ID or an array of network IDs to remove from cache.
+ */
+function clean_network_cache( $ids ) {
+       foreach ( (array) $ids as $id ) {
+               wp_cache_delete( $id, 'networks' );
+
+               /**
+                * Fires immediately after a network has been removed from the object cache.
+                *
+                * @since 4.6.0
+                *
+                * @param int $id Network ID.
+                */
+               do_action( 'clean_network_cache', $id );
+       }
+
+       wp_cache_set( 'last_changed', microtime(), 'networks' );
+}
+
+/**
+ * Updates the network cache of given networks.
+ *
+ * Will add the networks in $networks to the cache. If network ID already exists
+ * in the network cache then it will not be updated. The network is added to the
+ * cache using the network group with the key using the ID of the networks.
+ *
+ * @since 4.6.0
+ *
+ * @param array $networks Array of network row objects.
+ */
+function update_network_cache( $networks ) {
+       foreach ( (array) $networks as $network ) {
+               wp_cache_add( $network->id, $network, 'networks' );
+       }
+}
+
+/**
+ * Adds any networks from the given IDs to the cache that do not already exist in cache.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @see update_network_cache()
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $network_ids Array of network IDs.
+ */
+function _prime_network_caches( $network_ids ) {
+       global $wpdb;
+
+       $non_cached_ids = _get_non_cached_ids( $network_ids, 'networks' );
+       if ( !empty( $non_cached_ids ) ) {
+               $fresh_networks = $wpdb->get_results( sprintf( "SELECT $wpdb->site.* FROM $wpdb->site WHERE id IN (%s)", join( ",", array_map( 'intval', $non_cached_ids ) ) ) );
+
+               update_network_cache( $fresh_networks );
+       }
+}
+
 /**
  * Handler for updating the blog date when a post is published or an already published post is changed.
  *
 /**
  * Handler for updating the blog date when a post is published or an already published post is changed.
  *