From 9e05dcc39b12183111935d6a9b76a6d3e87d324a Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 1 Dec 2013 17:32:10 +0000 Subject: [PATCH] Inline documentation for hooks in wp-includes/ms-blogs.php. Props miyauchi, kpdesign. Fixes #25596. Built from https://develop.svn.wordpress.org/trunk@26502 git-svn-id: http://core.svn.wordpress.org/trunk@26396 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/ms-blogs.php | 192 +++++++++++++++++++++++++++++++++------ 1 file changed, 164 insertions(+), 28 deletions(-) diff --git a/wp-includes/ms-blogs.php b/wp-includes/ms-blogs.php index 708814ebbe..8d05f10c69 100644 --- a/wp-includes/ms-blogs.php +++ b/wp-includes/ms-blogs.php @@ -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 ); } @@ -207,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' ); @@ -240,6 +253,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 ); } @@ -281,40 +301,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(); } @@ -373,7 +453,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 ); } /** @@ -489,10 +579,20 @@ 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; @@ -530,6 +630,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; @@ -553,6 +654,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'] ); @@ -591,6 +693,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' @@ -662,16 +765,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; }