]> scripts.mit.edu Git - autoinstalls/wordpress.git/blobdiff - wp-includes/ms-blogs.php
WordPress 4.0
[autoinstalls/wordpress.git] / wp-includes / ms-blogs.php
index 95ddedb7f11a5050eaa1acf9e5f08269e1ae3f57..e7016565357498dedac0ed25f9f2a56ae1c9bdd4 100644 (file)
@@ -17,7 +17,13 @@ function wpmu_update_blogs_date() {
        global $wpdb;
 
        update_blog_details( $wpdb->blogid, array('last_updated' => current_time('mysql', true)) );
-
+       /**
+        * Fires after the blog details are updated.
+        *
+        * @since MU
+        *
+        * @param int $blog_id Blog ID.
+        */
        do_action( 'wpmu_blog_updated', $wpdb->blogid );
 }
 
@@ -55,32 +61,6 @@ function get_blogaddress_by_name( $blogname ) {
        return esc_url( $url . '/' );
 }
 
-/**
- * Get a full blog URL, given a domain and a path.
- *
- * @since MU
- *
- * @param string $domain
- * @param string $path
- * @return string
- */
-function get_blogaddress_by_domain( $domain, $path ) {
-       if ( is_subdomain_install() ) {
-               $url = "http://" . $domain.$path;
-       } else {
-               if ( $domain != $_SERVER['HTTP_HOST'] ) {
-                       $blogname = substr( $domain, 0, strpos( $domain, '.' ) );
-                       $url = 'http://' . substr( $domain, strpos( $domain, '.' ) + 1 ) . $path;
-                       // we're not installing the main blog
-                       if ( $blogname != 'www.' )
-                               $url .= $blogname . '/';
-               } else { // main blog
-                       $url = 'http://' . $domain . $path;
-               }
-       }
-       return esc_url( $url );
-}
-
 /**
  * Given a blog's (subdomain or directory) slug, retrieve its id.
  *
@@ -90,8 +70,9 @@ function get_blogaddress_by_domain( $domain, $path ) {
  * @return int A blog id
  */
 function get_id_from_blogname( $slug ) {
-       global $wpdb, $current_site;
+       global $wpdb;
 
+       $current_site = get_current_site();
        $slug = trim( $slug, '/' );
 
        $blog_id = wp_cache_get( 'get_id_from_blogname_' . $slug, 'blog-details' );
@@ -232,6 +213,13 @@ function get_blog_details( $fields = null, $get_all = true ) {
        $details->post_count    = get_option( 'post_count' );
        restore_current_blog();
 
+       /**
+        * Filter a blog's details.
+        *
+        * @since MU
+        *
+        * @param object $details The blog details.
+        */
        $details = apply_filters( 'blog_details', $details );
 
        wp_cache_set( $blog_id . $all, $details, 'blog-details' );
@@ -247,10 +235,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
@@ -265,6 +257,13 @@ function refresh_blog_details( $blog_id ) {
 
        clean_blog_cache( $details );
 
+       /**
+        * Fires after the blog details cache is cleared.
+        *
+        * @since 3.4.0
+        *
+        * @param int $blog_id Blog ID.
+        */
        do_action( 'refresh_blog_details', $blog_id );
 }
 
@@ -306,40 +305,100 @@ function update_blog_details( $blog_id, $details = array() ) {
                return false;
 
        // If spam status changed, issue actions.
-       if ( $details[ 'spam' ] != $current_details[ 'spam' ] ) {
-               if ( $details[ 'spam' ] == 1 )
+       if ( $details['spam'] != $current_details['spam'] ) {
+               if ( $details['spam'] == 1 ) {
+                       /**
+                        * Fires when the blog status is changed to 'spam'.
+                        *
+                        * @since MU
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'make_spam_blog', $blog_id );
-               else
+               } else {
+                       /**
+                        * Fires when the blog status is changed to 'ham'.
+                        *
+                        * @since MU
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'make_ham_blog', $blog_id );
+               }
        }
 
        // If mature status changed, issue actions.
-       if ( $details[ 'mature' ] != $current_details[ 'mature' ] ) {
-               if ( $details[ 'mature' ] == 1 )
+       if ( $details['mature'] != $current_details['mature'] ) {
+               if ( $details['mature'] == 1 ) {
+                       /**
+                        * Fires when the blog status is changed to 'mature'.
+                        *
+                        * @since 3.1.0
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'mature_blog', $blog_id );
-               else
+               } else {
+                       /**
+                        * Fires when the blog status is changed to 'unmature'.
+                        *
+                        * @since 3.1.0
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'unmature_blog', $blog_id );
+               }
        }
 
        // If archived status changed, issue actions.
-       if ( $details[ 'archived' ] != $current_details[ 'archived' ] ) {
-               if ( $details[ 'archived' ] == 1 )
+       if ( $details['archived'] != $current_details['archived'] ) {
+               if ( $details['archived'] == 1 ) {
+                       /**
+                        * Fires when the blog status is changed to 'archived'.
+                        *
+                        * @since MU
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'archive_blog', $blog_id );
-               else
+               } else {
+                       /**
+                        * Fires when the blog status is changed to 'unarchived'.
+                        *
+                        * @since MU
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'unarchive_blog', $blog_id );
+               }
        }
 
        // If deleted status changed, issue actions.
-       if ( $details[ 'deleted' ] != $current_details[ 'deleted' ] ) {
-               if ( $details[ 'deleted' ] == 1 )
+       if ( $details['deleted'] != $current_details['deleted'] ) {
+               if ( $details['deleted'] == 1 ) {
+                       /**
+                        * Fires when the blog status is changed to 'deleted'.
+                        *
+                        * @since 3.5.0
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'make_delete_blog', $blog_id );
-               else
+               } else {
+                       /**
+                        * Fires when the blog status is changed to 'undeleted'.
+                        *
+                        * @since 3.5.0
+                        *
+                        * @param int $blog_id Blog ID.
+                        */
                        do_action( 'make_undelete_blog', $blog_id );
+               }
        }
 
-       if ( isset( $details[ 'public' ] ) ) {
+       if ( isset( $details['public'] ) ) {
                switch_to_blog( $blog_id );
-               update_option( 'blog_public', $details[ 'public' ] );
+               update_option( 'blog_public', $details['public'] );
                restore_current_blog();
        }
 
@@ -398,7 +457,17 @@ function get_blog_option( $id, $option, $default = false ) {
        $value = get_option( $option, $default );
        restore_current_blog();
 
-       return apply_filters( 'blog_option_' . $option, $value, $id );
+       /**
+        * Filter a blog option value.
+        *
+        * The dynamic portion of the hook name, $option, refers to the blog option name.
+        *
+        * @since 3.5.0
+        *
+        * @param string  $value The option value.
+        * @param int     $id    Blog ID.
+        */
+       return apply_filters( "blog_option_{$option}", $value, $id );
 }
 
 /**
@@ -504,7 +573,7 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) {
  *
  * @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 bool Always returns True.
  */
 function switch_to_blog( $new_blog, $deprecated = null ) {
        global $wpdb, $wp_roles;
@@ -514,17 +583,27 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
 
        $GLOBALS['_wp_switched_stack'][] = $GLOBALS['blog_id'];
 
-       /* If we're switching to the same blog id that we're on,
-       * set the right vars, do the associated actions, but skip
-       * the extra unnecessary work */
+       /*
+        * If we're switching to the same blog id that we're on,
+        * set the right vars, do the associated actions, but skip
+        * the extra unnecessary work
+        */
        if ( $new_blog == $GLOBALS['blog_id'] ) {
+               /**
+                * Fires when the blog is switched.
+                *
+                * @since MU
+                *
+                * @param int $new_blog New blog ID.
+                * @param int $new_blog Blog ID.
+                */
                do_action( 'switch_blog', $new_blog, $new_blog );
                $GLOBALS['switched'] = true;
                return true;
        }
 
        $wpdb->set_blog_id( $new_blog );
-       $GLOBALS['table_prefix'] = $wpdb->prefix;
+       $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
        $prev_blog_id = $GLOBALS['blog_id'];
        $GLOBALS['blog_id'] = $new_blog;
 
@@ -555,6 +634,7 @@ function switch_to_blog( $new_blog, $deprecated = null ) {
                $current_user->for_blog( $new_blog );
        }
 
+       /** This filter is documented in wp-includes/ms-blogs.php */
        do_action( 'switch_blog', $new_blog, $prev_blog_id );
        $GLOBALS['switched'] = true;
 
@@ -578,6 +658,7 @@ function restore_current_blog() {
        $blog = array_pop( $GLOBALS['_wp_switched_stack'] );
 
        if ( $GLOBALS['blog_id'] == $blog ) {
+               /** This filter is documented in wp-includes/ms-blogs.php */
                do_action( 'switch_blog', $blog, $blog );
                // If we still have items in the switched stack, consider ourselves still 'switched'
                $GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] );
@@ -587,7 +668,7 @@ function restore_current_blog() {
        $wpdb->set_blog_id( $blog );
        $prev_blog_id = $GLOBALS['blog_id'];
        $GLOBALS['blog_id'] = $blog;
-       $GLOBALS['table_prefix'] = $wpdb->prefix;
+       $GLOBALS['table_prefix'] = $wpdb->get_blog_prefix();
 
        if ( function_exists( 'wp_cache_switch_to_blog' ) ) {
                wp_cache_switch_to_blog( $blog );
@@ -616,6 +697,7 @@ function restore_current_blog() {
                $current_user->for_blog( $blog );
        }
 
+       /** This filter is documented in wp-includes/ms-blogs.php */
        do_action( 'switch_blog', $blog, $prev_blog_id );
 
        // If we still have items in the switched stack, consider ourselves still 'switched'
@@ -687,16 +769,49 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
 
        refresh_blog_details( $blog_id );
 
-       if ( 'spam' == $pref )
-               ( $value == 1 ) ? do_action( 'make_spam_blog', $blog_id ) :     do_action( 'make_ham_blog', $blog_id );
-       elseif ( 'mature' == $pref )
-               ( $value == 1 ) ? do_action( 'mature_blog', $blog_id ) : do_action( 'unmature_blog', $blog_id );
-       elseif ( 'archived' == $pref )
-               ( $value == 1 ) ? do_action( 'archive_blog', $blog_id ) : do_action( 'unarchive_blog', $blog_id );
-       elseif ( 'deleted' == $pref )
-               ( $value == 1 ) ? do_action( 'make_delete_blog', $blog_id ) : do_action( 'make_undelete_blog', $blog_id );
-       elseif ( 'public' == $pref )
+       if ( 'spam' == $pref ) {
+               if ( $value == 1 ) {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'make_spam_blog', $blog_id );
+               } else {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'make_ham_blog', $blog_id );
+               }
+       } elseif ( 'mature' == $pref ) {
+               if ( $value == 1 ) {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'mature_blog', $blog_id );
+               } else {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'unmature_blog', $blog_id );
+               }
+       } elseif ( 'archived' == $pref ) {
+               if ( $value == 1 ) {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'archive_blog', $blog_id );
+               } else {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'unarchive_blog', $blog_id );
+               }
+       } elseif ( 'deleted' == $pref ) {
+               if ( $value == 1 ) {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'make_delete_blog', $blog_id );
+               } else {
+                       /** This filter is documented in wp-includes/ms-blogs.php */
+                       do_action( 'make_undelete_blog', $blog_id );
+               }
+       } elseif ( 'public' == $pref ) {
+               /**
+                * Fires after the current blog's 'public' setting is updated.
+                *
+                * @since MU
+                *
+                * @param int    $blog_id Blog ID.
+                * @param string $value   The value of blog status.
+                */
                do_action( 'update_blog_public', $blog_id, $value ); // Moved here from update_blog_public().
+       }
 
        return $value;
 }
@@ -750,11 +865,13 @@ function get_last_updated( $deprecated = '', $start = 0, $quantity = 40 ) {
  */
 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.
 
@@ -772,12 +889,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();
+}
+