<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[26502] trunk/src/wp-includes/ms-blogs.php: Inline documentation for hooks in wp-includes/ms-blogs.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/26502">26502</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-12-01 17:31:49 +0000 (Sun, 01 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/ms-blogs.php.
Props miyauchi, kpdesign.
Fixes <a href="http://core.trac.wordpress.org/ticket/25596">#25596</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmsblogsphp">trunk/src/wp-includes/ms-blogs.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmsblogsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/ms-blogs.php (26501 => 26502)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/ms-blogs.php 2013-12-01 17:23:05 UTC (rev 26501)
+++ trunk/src/wp-includes/ms-blogs.php 2013-12-01 17:31:49 UTC (rev 26502)
</span><span class="lines">@@ -17,7 +17,13 @@
</span><span class="cx"> global $wpdb;
</span><span class="cx">
</span><span class="cx"> update_blog_details( $wpdb->blogid, array('last_updated' => current_time('mysql', true)) );
</span><del>-
</del><ins>+ /**
+ * Fires after the blog details are updated.
+ *
+ * @since MU
+ *
+ * @param int $blog_id Blog ID.
+ */
</ins><span class="cx"> do_action( 'wpmu_blog_updated', $wpdb->blogid );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -207,6 +213,13 @@
</span><span class="cx"> $details->post_count = get_option( 'post_count' );
</span><span class="cx"> restore_current_blog();
</span><span class="cx">
</span><ins>+ /**
+ * Filter a blog's details.
+ *
+ * @since MU
+ *
+ * @param object $details The blog details.
+ */
</ins><span class="cx"> $details = apply_filters( 'blog_details', $details );
</span><span class="cx">
</span><span class="cx"> wp_cache_set( $blog_id . $all, $details, 'blog-details' );
</span><span class="lines">@@ -240,6 +253,13 @@
</span><span class="cx">
</span><span class="cx"> clean_blog_cache( $details );
</span><span class="cx">
</span><ins>+ /**
+ * Fires after the blog details cache is cleared.
+ *
+ * @since 3.4.0
+ *
+ * @param int $blog_id Blog ID.
+ */
</ins><span class="cx"> do_action( 'refresh_blog_details', $blog_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -281,40 +301,100 @@
</span><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> // If spam status changed, issue actions.
</span><del>- if ( $details[ 'spam' ] != $current_details[ 'spam' ] ) {
- if ( $details[ 'spam' ] == 1 )
</del><ins>+ 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.
+ */
</ins><span class="cx"> do_action( 'make_spam_blog', $blog_id );
</span><del>- else
</del><ins>+ } else {
+ /**
+ * Fires when the blog status is changed to 'ham'.
+ *
+ * @since MU
+ *
+ * @param int $blog_id Blog ID.
+ */
</ins><span class="cx"> do_action( 'make_ham_blog', $blog_id );
</span><ins>+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // If mature status changed, issue actions.
</span><del>- if ( $details[ 'mature' ] != $current_details[ 'mature' ] ) {
- if ( $details[ 'mature' ] == 1 )
</del><ins>+ 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.
+ */
</ins><span class="cx"> do_action( 'mature_blog', $blog_id );
</span><del>- else
</del><ins>+ } else {
+ /**
+ * Fires when the blog status is changed to 'unmature'.
+ *
+ * @since 3.1.0
+ *
+ * @param int $blog_id Blog ID.
+ */
</ins><span class="cx"> do_action( 'unmature_blog', $blog_id );
</span><ins>+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // If archived status changed, issue actions.
</span><del>- if ( $details[ 'archived' ] != $current_details[ 'archived' ] ) {
- if ( $details[ 'archived' ] == 1 )
</del><ins>+ 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.
+ */
</ins><span class="cx"> do_action( 'archive_blog', $blog_id );
</span><del>- else
</del><ins>+ } else {
+ /**
+ * Fires when the blog status is changed to 'unarchived'.
+ *
+ * @since MU
+ *
+ * @param int $blog_id Blog ID.
+ */
</ins><span class="cx"> do_action( 'unarchive_blog', $blog_id );
</span><ins>+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> // If deleted status changed, issue actions.
</span><del>- if ( $details[ 'deleted' ] != $current_details[ 'deleted' ] ) {
- if ( $details[ 'deleted' ] == 1 )
</del><ins>+ 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.
+ */
</ins><span class="cx"> do_action( 'make_delete_blog', $blog_id );
</span><del>- else
</del><ins>+ } else {
+ /**
+ * Fires when the blog status is changed to 'undeleted'.
+ *
+ * @since 3.5.0
+ *
+ * @param int $blog_id Blog ID.
+ */
</ins><span class="cx"> do_action( 'make_undelete_blog', $blog_id );
</span><ins>+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- if ( isset( $details[ 'public' ] ) ) {
</del><ins>+ if ( isset( $details['public'] ) ) {
</ins><span class="cx"> switch_to_blog( $blog_id );
</span><del>- update_option( 'blog_public', $details[ 'public' ] );
</del><ins>+ update_option( 'blog_public', $details['public'] );
</ins><span class="cx"> restore_current_blog();
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -373,7 +453,17 @@
</span><span class="cx"> $value = get_option( $option, $default );
</span><span class="cx"> restore_current_blog();
</span><span class="cx">
</span><del>- return apply_filters( 'blog_option_' . $option, $value, $id );
</del><ins>+ /**
+ * 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 );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -489,10 +579,20 @@
</span><span class="cx">
</span><span class="cx"> $GLOBALS['_wp_switched_stack'][] = $GLOBALS['blog_id'];
</span><span class="cx">
</span><del>- /* 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 */
</del><ins>+ /*
+ * 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
+ */
</ins><span class="cx"> if ( $new_blog == $GLOBALS['blog_id'] ) {
</span><ins>+ /**
+ * Fires when the blog is switched.
+ *
+ * @since MU
+ *
+ * @param int $new_blog New blog ID.
+ * @param int $new_blog Blog ID.
+ */
</ins><span class="cx"> do_action( 'switch_blog', $new_blog, $new_blog );
</span><span class="cx"> $GLOBALS['switched'] = true;
</span><span class="cx"> return true;
</span><span class="lines">@@ -530,6 +630,7 @@
</span><span class="cx"> $current_user->for_blog( $new_blog );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/ms-blogs.php */
</ins><span class="cx"> do_action( 'switch_blog', $new_blog, $prev_blog_id );
</span><span class="cx"> $GLOBALS['switched'] = true;
</span><span class="cx">
</span><span class="lines">@@ -553,6 +654,7 @@
</span><span class="cx"> $blog = array_pop( $GLOBALS['_wp_switched_stack'] );
</span><span class="cx">
</span><span class="cx"> if ( $GLOBALS['blog_id'] == $blog ) {
</span><ins>+ /** This filter is documented in wp-includes/ms-blogs.php */
</ins><span class="cx"> do_action( 'switch_blog', $blog, $blog );
</span><span class="cx"> // If we still have items in the switched stack, consider ourselves still 'switched'
</span><span class="cx"> $GLOBALS['switched'] = ! empty( $GLOBALS['_wp_switched_stack'] );
</span><span class="lines">@@ -591,6 +693,7 @@
</span><span class="cx"> $current_user->for_blog( $blog );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/ms-blogs.php */
</ins><span class="cx"> do_action( 'switch_blog', $blog, $prev_blog_id );
</span><span class="cx">
</span><span class="cx"> // If we still have items in the switched stack, consider ourselves still 'switched'
</span><span class="lines">@@ -662,16 +765,49 @@
</span><span class="cx">
</span><span class="cx"> refresh_blog_details( $blog_id );
</span><span class="cx">
</span><del>- 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 )
</del><ins>+ 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.
+ */
</ins><span class="cx"> do_action( 'update_blog_public', $blog_id, $value ); // Moved here from update_blog_public().
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> return $value;
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>