WordPress 4.4.2
[autoinstalls/wordpress.git] / wp-includes / ms-blogs.php
index 8d05f10c69c067654ea460f13c1c60b6fb2b3695..0701f17fde037703deb84160d703f9a9a69b3f8d 100644 (file)
@@ -12,6 +12,8 @@
  * Update the last_updated field for the current blog.
  *
  * @since MU
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
  */
 function wpmu_update_blogs_date() {
        global $wpdb;
@@ -33,11 +35,19 @@ function wpmu_update_blogs_date() {
  * @since MU
  *
  * @param int $blog_id Blog ID
- * @return string
+ * @return string Full URL of the blog if found. Empty string if not.
  */
 function get_blogaddress_by_id( $blog_id ) {
-       $bloginfo = get_blog_details( (int) $blog_id, false ); // only get bare details!
-       return esc_url( 'http://' . $bloginfo->domain . $bloginfo->path );
+       $bloginfo = get_blog_details( (int) $blog_id );
+
+       if ( empty( $bloginfo ) ) {
+               return '';
+       }
+
+       $scheme = parse_url( $bloginfo->home, PHP_URL_SCHEME );
+       $scheme = empty( $scheme ) ? 'http' : $scheme;
+
+       return esc_url( $scheme . '://' . $bloginfo->domain . $bloginfo->path );
 }
 
 /**
@@ -66,6 +76,8 @@ function get_blogaddress_by_name( $blogname ) {
  *
  * @since MU
  *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
  * @param string $slug
  * @return int A blog id
  */
@@ -97,9 +109,13 @@ function get_id_from_blogname( $slug ) {
  *
  * @since MU
  *
- * @param int|string|array $fields A blog ID, a blog slug, or an array of fields to query against. Optional. If not specified the current blog ID is used.
- * @param bool $get_all Whether to retrieve all details or only the details in the blogs table. Default is true.
- * @return object Blog details.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int|string|array $fields  Optional. A blog ID, a blog slug, or an array of fields to query against.
+ *                                  If not specified the current blog ID is used.
+ * @param bool             $get_all Whether to retrieve all details or only the details in the blogs table.
+ *                                  Default is true.
+ * @return object|false Blog details on success. False on failure.
  */
 function get_blog_details( $fields = null, $get_all = true ) {
        global $wpdb;
@@ -208,9 +224,10 @@ function get_blog_details( $fields = null, $get_all = true ) {
        }
 
        switch_to_blog( $blog_id );
-       $details->blogname              = get_option( 'blogname' );
-       $details->siteurl               = get_option( 'siteurl' );
-       $details->post_count    = get_option( 'post_count' );
+       $details->blogname   = get_option( 'blogname' );
+       $details->siteurl    = get_option( 'siteurl' );
+       $details->post_count = get_option( 'post_count' );
+       $details->home       = get_option( 'home' );
        restore_current_blog();
 
        /**
@@ -235,10 +252,14 @@ function get_blog_details( $fields = null, $get_all = true ) {
  *
  * @since MU
  *
- * @param int $blog_id Blog ID
+ * @param int $blog_id Optional. Blog ID. Defaults to current blog.
  */
-function refresh_blog_details( $blog_id ) {
+function refresh_blog_details( $blog_id = 0 ) {
        $blog_id = (int) $blog_id;
+       if ( ! $blog_id ) {
+               $blog_id = get_current_blog_id();
+       }
+
        $details = get_blog_details( $blog_id, false );
        if ( ! $details ) {
                // Make sure clean_blog_cache() gets the blog ID
@@ -268,7 +289,9 @@ function refresh_blog_details( $blog_id ) {
  *
  * @since MU
  *
- * @param int $blog_id Blog ID
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int   $blog_id Blog ID
  * @param array $details Array of details keyed by blogs table field names.
  * @return bool True if update succeeds, false otherwise.
  */
@@ -292,8 +315,13 @@ function update_blog_details( $blog_id, $details = array() ) {
 
        $update_details = array();
        $fields = array( 'site_id', 'domain', 'path', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id');
-       foreach ( array_intersect( array_keys( $details ), $fields ) as $field )
-               $update_details[$field] = $details[$field];
+       foreach ( array_intersect( array_keys( $details ), $fields ) as $field ) {
+               if ( 'path' === $field ) {
+                       $details[ $field ] = trailingslashit( '/' . trim( $details[ $field ], '/' ) );
+               }
+
+               $update_details[ $field ] = $details[ $field ];
+       }
 
        $result = $wpdb->update( $wpdb->blogs, $update_details, array('blog_id' => $blog_id) );
 
@@ -435,9 +463,9 @@ function clean_blog_cache( $blog ) {
  *
  * @since MU
  *
- * @param int $id A blog ID. Can be null to refer to the current blog.
- * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
- * @param mixed $default Optional. Default value to return if the option does not exist.
+ * @param int    $id      A blog ID. Can be null to refer to the current blog.
+ * @param string $option  Name of option to retrieve. Expected to not be SQL-escaped.
+ * @param mixed  $default Optional. Default value to return if the option does not exist.
  * @return mixed Value set for the option.
  */
 function get_blog_option( $id, $option, $default = false ) {
@@ -456,7 +484,7 @@ function get_blog_option( $id, $option, $default = false ) {
        /**
         * Filter 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.
         *
         * @since 3.5.0
         *
@@ -480,9 +508,9 @@ function get_blog_option( $id, $option, $default = false ) {
  *
  * @since MU
  *
- * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param int    $id     A blog ID. Can be null to refer to the current blog.
  * @param string $option Name of option to add. Expected to not be SQL-escaped.
- * @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
+ * @param mixed  $value  Optional. Option value, can be anything. Expected to not be SQL-escaped.
  * @return bool False if option was not added and true if option was added.
  */
 function add_blog_option( $id, $option, $value ) {
@@ -506,7 +534,7 @@ function add_blog_option( $id, $option, $value ) {
  *
  * @since MU
  *
- * @param int $id A blog ID. Can be null to refer to the current blog.
+ * @param int    $id     A blog ID. Can be null to refer to the current blog.
  * @param string $option Name of option to remove. Expected to not be SQL-escaped.
  * @return bool True, if option is successfully deleted. False on failure.
  */
@@ -531,9 +559,9 @@ function delete_blog_option( $id, $option ) {
  *
  * @since MU
  *
- * @param int $id The blog id
+ * @param int    $id     The blog id
  * @param string $option The option key
- * @param mixed $value The option value
+ * @param mixed  $value  The option value
  * @return bool True on success, false on failure.
  */
 function update_blog_option( $id, $option, $value, $deprecated = null ) {
@@ -567,12 +595,19 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) {
  * @see restore_current_blog()
  * @since MU
  *
- * @param int $new_blog The id of the blog you want to switch to. Default: current blog
+ * @global wpdb            $wpdb
+ * @global int             $blog_id
+ * @global array           $_wp_switched_stack
+ * @global bool            $switched
+ * @global string          $table_prefix
+ * @global WP_Object_Cache $wp_object_cache
+ *
+ * @param int  $new_blog   The id of the blog you want to switch to. Default: current blog
  * @param bool $deprecated Deprecated argument
- * @return bool True on success, false if the validation failed
+ * @return true Always returns True.
  */
 function switch_to_blog( $new_blog, $deprecated = null ) {
-       global $wpdb, $wp_roles;
+       global $wpdb;
 
        if ( empty( $new_blog ) )
                $new_blog = $GLOBALS['blog_id'];
@@ -616,16 +651,17 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
                wp_cache_init();
 
                if ( function_exists( 'wp_cache_add_global_groups' ) ) {
-                       if ( is_array( $global_groups ) )
+                       if ( is_array( $global_groups ) ) {
                                wp_cache_add_global_groups( $global_groups );
-                       else
-                               wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', ' blog-id-cache' ) );
+                       } 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' ) );
+                       }
                        wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) );
                }
        }
 
        if ( did_action( 'init' ) ) {
-               $wp_roles->reinit();
+               wp_roles()->reinit();
                $current_user = wp_get_current_user();
                $current_user->for_blog( $new_blog );
        }
@@ -643,10 +679,17 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
  * @see switch_to_blog()
  * @since MU
  *
+ * @global wpdb            $wpdb
+ * @global array           $_wp_switched_stack
+ * @global int             $blog_id
+ * @global bool            $switched
+ * @global string          $table_prefix
+ * @global WP_Object_Cache $wp_object_cache
+ *
  * @return bool True on success, false if we're already on the current blog
  */
 function restore_current_blog() {
-       global $wpdb, $wp_roles;
+       global $wpdb;
 
        if ( empty( $GLOBALS['_wp_switched_stack'] ) )
                return false;
@@ -679,16 +722,17 @@ function restore_current_blog() {
                wp_cache_init();
 
                if ( function_exists( 'wp_cache_add_global_groups' ) ) {
-                       if ( is_array( $global_groups ) )
+                       if ( is_array( $global_groups ) ) {
                                wp_cache_add_global_groups( $global_groups );
-                       else
-                               wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', ' blog-id-cache' ) );
+                       } 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' ) );
+                       }
                        wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) );
                }
        }
 
        if ( did_action( 'init' ) ) {
-               $wp_roles->reinit();
+               wp_roles()->reinit();
                $current_user = wp_get_current_user();
                $current_user->for_blog( $blog );
        }
@@ -707,6 +751,8 @@ function restore_current_blog() {
  *
  * @since 3.5.0
  *
+ * @global array $_wp_switched_stack
+ *
  * @return bool True if switched, false otherwise.
  */
 function ms_is_switched() {
@@ -730,7 +776,7 @@ function is_archived( $id ) {
  *
  * @since MU
  *
- * @param int $id The blog id
+ * @param int    $id       The blog id
  * @param string $archived The new status
  * @return string $archived
  */
@@ -744,10 +790,13 @@ function update_archived( $id, $archived ) {
  *
  * @since MU
  *
- * @param int $blog_id BLog ID
- * @param string $pref A field name
- * @param string $value Value for $pref
- * @return string $value
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int    $blog_id BLog ID
+ * @param string $pref    A field name
+ * @param string $value   Value for $pref
+ * @param null   $deprecated
+ * @return string|false $value
  */
 function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
        global $wpdb;
@@ -817,9 +866,11 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
  *
  * @since MU
  *
- * @param int $id The blog id
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int    $id   The blog id
  * @param string $pref A field name
- * @return bool $value
+ * @return bool|string|null $value
  */
 function get_blog_status( $id, $pref ) {
        global $wpdb;
@@ -836,9 +887,11 @@ function get_blog_status( $id, $pref ) {
  *
  * @since MU
  *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
  * @param mixed $deprecated Not used
- * @param int $start The offset
- * @param int $quantity The maximum number of blogs to retrieve. Default is 40.
+ * @param int   $start      The offset
+ * @param int   $quantity   The maximum number of blogs to retrieve. Default is 40.
  * @return array The list of blogs
  */
 function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) {
@@ -857,15 +910,17 @@ function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) {
  *
  * @param string $new_status The new post status
  * @param string $old_status The old post status
- * @param object $post Post object
+ * @param object $post       Post object
  */
 function _update_blog_date_on_post_publish( $new_status, $old_status, $post ) {
        $post_type_obj = get_post_type_object( $post->post_type );
-       if ( ! $post_type_obj->public )
+       if ( ! $post_type_obj || ! $post_type_obj->public ) {
                return;
+       }
 
-       if ( 'publish' != $new_status && 'publish' != $old_status )
+       if ( 'publish' != $new_status && 'publish' != $old_status ) {
                return;
+       }
 
        // Post was freshly published, published post was saved, or published post was unpublished.
 
@@ -883,12 +938,51 @@ function _update_blog_date_on_post_delete( $post_id ) {
        $post = get_post( $post_id );
 
        $post_type_obj = get_post_type_object( $post->post_type );
-       if ( ! $post_type_obj->public )
+       if ( ! $post_type_obj || ! $post_type_obj->public ) {
                return;
+       }
 
-       if ( 'publish' != $post->post_status )
+       if ( 'publish' != $post->post_status ) {
                return;
+       }
 
        wpmu_update_blogs_date();
 }
 
+/**
+ * Handler for updating the blog posts count date when a post is deleted.
+ *
+ * @since 4.0.0
+ *
+ * @param int $post_id Post ID.
+ */
+function _update_posts_count_on_delete( $post_id ) {
+       $post = get_post( $post_id );
+
+       if ( ! $post || 'publish' !== $post->post_status ) {
+               return;
+       }
+
+       update_posts_count();
+}
+
+/**
+ * Handler for updating the blog posts count date when a post status changes.
+ *
+ * @since 4.0.0
+ *
+ * @param string $new_status The status the post is changing to.
+ * @param string $old_status The status the post is changing from.
+ */
+function _update_posts_count_on_transition_post_status( $new_status, $old_status ) {
+       if ( $new_status === $old_status ) {
+               return;
+       }
+
+       if ( 'publish' !== $new_status && 'publish' !== $old_status ) {
+               return;
+       }
+
+       update_posts_count();
+}
+