<!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>[26538] trunk/src/wp-includes/ms-functions.php: Inline documentation for hooks in wp-includes/ms-functions.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/26538">26538</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-12-02 20:44:28 +0000 (Mon, 02 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/ms-functions.php.
Props ShinichiN, ericlewis, rzen.
Fixes <a href="http://core.trac.wordpress.org/ticket/25598">#25598</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmsfunctionsphp">trunk/src/wp-includes/ms-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/ms-functions.php (26537 => 26538)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/ms-functions.php 2013-12-02 19:59:40 UTC (rev 26537)
+++ trunk/src/wp-includes/ms-functions.php 2013-12-02 20:44:28 UTC (rev 26538)
</span><span class="lines">@@ -194,7 +194,16 @@
</span><span class="cx">
</span><span class="cx"> $user->set_role($role);
</span><span class="cx">
</span><del>- do_action('add_user_to_blog', $user_id, $role, $blog_id);
</del><ins>+ /**
+ * Fires immediately after a user is added to a site.
+ *
+ * @since MU
+ *
+ * @param int $user_id User ID.
+ * @param string $role User role.
+ * @param int $blog_id Blog ID.
+ */
+ do_action( 'add_user_to_blog', $user_id, $role, $blog_id );
</ins><span class="cx"> wp_cache_delete( $user_id, 'users' );
</span><span class="cx"> restore_current_blog();
</span><span class="cx"> return true;
</span><span class="lines">@@ -220,7 +229,15 @@
</span><span class="cx"> global $wpdb;
</span><span class="cx"> switch_to_blog($blog_id);
</span><span class="cx"> $user_id = (int) $user_id;
</span><del>- do_action('remove_user_from_blog', $user_id, $blog_id);
</del><ins>+ /**
+ * Fires before a user is removed from a site.
+ *
+ * @since MU
+ *
+ * @param int $user_id User ID.
+ * @param int $blog_id Blog ID.
+ */
+ do_action( 'remove_user_from_blog', $user_id, $blog_id );
</ins><span class="cx">
</span><span class="cx"> // If being removed from the primary blog, set a new primary if the user is assigned
</span><span class="cx"> // to multiple blogs.
</span><span class="lines">@@ -401,6 +418,14 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Filter whether an email address is unsafe.
+ *
+ * @since 3.5.0
+ *
+ * @param bool $is_email_address_unsafe Whether the email address is "unsafe". Default false.
+ * @param string $user_email User email address.
+ */
</ins><span class="cx"> return apply_filters( 'is_email_address_unsafe', $is_email_address_unsafe, $user_email );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -510,7 +535,24 @@
</span><span class="cx">
</span><span class="cx"> $result = array('user_name' => $user_name, 'orig_username' => $orig_username, 'user_email' => $user_email, 'errors' => $errors);
</span><span class="cx">
</span><del>- return apply_filters('wpmu_validate_user_signup', $result);
</del><ins>+ /**
+ * Filter the validated user registration details.
+ *
+ * This does not allow you to override the username or email of the user during
+ * registration. The values are solely used for validation and error handling.
+ *
+ * @since MU
+ *
+ * @param array $result {
+ * The array of user name, email and the error messages.
+ *
+ * @type string $user_name Sanitized and unique username.
+ * @type string $orig_username Original username.
+ * @type string $user_email User email address.
+ * @type WP_Error $errors WP_Error object containing any errors found.
+ * }
+ */
+ return apply_filters( 'wpmu_validate_user_signup', $result );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -551,9 +593,23 @@
</span><span class="cx"> add_site_option( 'illegal_names', $illegal_names );
</span><span class="cx"> }
</span><span class="cx">
</span><del>- // On sub dir installs, Some names are so illegal, only a filter can spring them from jail
- if (! is_subdomain_install() )
- $illegal_names = array_merge($illegal_names, apply_filters( 'subdirectory_reserved_names', array( 'page', 'comments', 'blog', 'files', 'feed' ) ) );
</del><ins>+ /*
+ * On sub dir installs, some names are so illegal, only a filter can
+ * spring them from jail.
+ */
+ if ( ! is_subdomain_install() ) {
+ $illegal_names = array_merge(
+ $illegal_names,
+ /**
+ * Filter reserved site names on a sub-directory Multisite install.
+ *
+ * @since 3.0.0
+ *
+ * @param array $subdirectory_reserved_names Array of reserved names.
+ */
+ apply_filters( 'subdirectory_reserved_names', array( 'page', 'comments', 'blog', 'files', 'feed' ) )
+ );
+ }
</ins><span class="cx">
</span><span class="cx"> if ( empty( $blogname ) )
</span><span class="cx"> $errors->add('blogname', __( 'Please enter a site name.' ) );
</span><span class="lines">@@ -578,6 +634,16 @@
</span><span class="cx"> if ( preg_match( '/^[0-9]*$/', $blogname ) )
</span><span class="cx"> $errors->add('blogname', __('Sorry, site names must have letters too!'));
</span><span class="cx">
</span><ins>+ /**
+ * Filter the new site name during registration.
+ *
+ * The name is the site's subdomain or the site's subdirectory
+ * path depending on the network settings.
+ *
+ * @since MU
+ *
+ * @param string $blogname Site name.
+ */
</ins><span class="cx"> $blogname = apply_filters( 'newblogname', $blogname );
</span><span class="cx">
</span><span class="cx"> $blog_title = wp_unslash( $blog_title );
</span><span class="lines">@@ -613,7 +679,24 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> $result = array('domain' => $mydomain, 'path' => $path, 'blogname' => $blogname, 'blog_title' => $blog_title, 'user' => $user, 'errors' => $errors);
</span><del>- return apply_filters('wpmu_validate_blog_signup', $result);
</del><ins>+
+ /**
+ * Filter site details and error messages following registration.
+ *
+ * @since MU
+ *
+ * @param array $result {
+ * Array of domain, path, blog name, blog title, user and error messages.
+ *
+ * @type string $domain Domain for the site.
+ * @type string $path Path for the site. Used in subdirectory installs.
+ * @type string $blogname The unique site name (slug).
+ * @type string $blog_title Blog title.
+ * @type string $user User email address.
+ * @type WP_Error $errors WP_Error containing any errors found.
+ * }
+ */
+ return apply_filters( 'wpmu_validate_blog_signup', $result );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -710,8 +793,22 @@
</span><span class="cx"> * @return bool
</span><span class="cx"> */
</span><span class="cx"> function wpmu_signup_blog_notification( $domain, $path, $title, $user, $user_email, $key, $meta = array() ) {
</span><del>- if ( !apply_filters('wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta) )
</del><ins>+ /**
+ * Filter whether to bypass the new site email notification.
+ *
+ * @since MU
+ *
+ * @param string|bool $domain Site domain.
+ * @param string $path Site path.
+ * @param string $title Site title.
+ * @param string $user User login name.
+ * @param string $user_email User email address.
+ * @param string $key Activation key created in wpmu_signup_blog().
+ * @param array $meta By default, contains the requested privacy setting and lang_id.
+ */
+ if ( ! apply_filters( 'wpmu_signup_blog_notification', $domain, $path, $title, $user, $user_email, $key, $meta ) ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx">
</span><span class="cx"> // Send email with activation link.
</span><span class="cx"> if ( !is_subdomain_install() || get_current_site()->id != 1 )
</span><span class="lines">@@ -726,6 +823,22 @@
</span><span class="cx"> $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
</span><span class="cx"> $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
</span><span class="cx"> $message = sprintf(
</span><ins>+ /**
+ * Filter the message content of the new blog notification email.
+ *
+ * Content should be formatted for transmission via wp_mail().
+ *
+ * @since MU
+ *
+ * @param string $content Content of the notification email.
+ * @param string $domain Site domain.
+ * @param string $path Site path.
+ * @param string $title Site title.
+ * @param string $user User login name.
+ * @param string $user_email User email address.
+ * @param string $key Activation key created in wpmu_signup_blog().
+ * @param array $meta By default, contains the requested privacy setting and lang_id.
+ */
</ins><span class="cx"> apply_filters( 'wpmu_signup_blog_notification_email',
</span><span class="cx"> __( "To activate your blog, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login.\n\nAfter you activate, you can visit your site here:\n\n%s" ),
</span><span class="cx"> $domain, $path, $title, $user, $user_email, $key, $meta
</span><span class="lines">@@ -736,6 +849,20 @@
</span><span class="cx"> );
</span><span class="cx"> // TODO: Don't hard code activation link.
</span><span class="cx"> $subject = sprintf(
</span><ins>+ /**
+ * Filter the subject of the new blog notification email.
+ *
+ * @since MU
+ *
+ * @param string $subject Subject of the notification email.
+ * @param string $domain Site domain.
+ * @param string $path Site path.
+ * @param string $title Site title.
+ * @param string $user User login name.
+ * @param string $user_email User email address.
+ * @param string $key Activation key created in wpmu_signup_blog().
+ * @param array $meta By default, contains the requested privacy setting and lang_id.
+ */
</ins><span class="cx"> apply_filters( 'wpmu_signup_blog_notification_subject',
</span><span class="cx"> __( '[%1$s] Activate %2$s' ),
</span><span class="cx"> $domain, $path, $title, $user, $user_email, $key, $meta
</span><span class="lines">@@ -769,7 +896,17 @@
</span><span class="cx"> * @return bool
</span><span class="cx"> */
</span><span class="cx"> function wpmu_signup_user_notification( $user, $user_email, $key, $meta = array() ) {
</span><del>- if ( !apply_filters('wpmu_signup_user_notification', $user, $user_email, $key, $meta) )
</del><ins>+ /**
+ * Filter whether to bypass the email notification for new user sign-up.
+ *
+ * @since MU
+ *
+ * @param string $user User login name.
+ * @param string $user_email User email address.
+ * @param string $key Activation key created in wpmu_signup_user().
+ * @param array $meta Signup meta data.
+ */
+ if ( ! apply_filters( 'wpmu_signup_user_notification', $user, $user_email, $key, $meta ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> // Send email with activation link.
</span><span class="lines">@@ -779,6 +916,19 @@
</span><span class="cx"> $from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
</span><span class="cx"> $message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
</span><span class="cx"> $message = sprintf(
</span><ins>+ /**
+ * Filter the content of the notification email for new user sign-up.
+ *
+ * Content should be formatted for transmission via wp_mail().
+ *
+ * @since MU
+ *
+ * @param string $content Content of the notification email.
+ * @param string $user User login name.
+ * @param string $user_email User email address.
+ * @param string $key Activation key created in wpmu_signup_user().
+ * @param array $meta Signup meta data.
+ */
</ins><span class="cx"> apply_filters( 'wpmu_signup_user_notification_email',
</span><span class="cx"> __( "To activate your user, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login." ),
</span><span class="cx"> $user, $user_email, $key, $meta
</span><span class="lines">@@ -787,6 +937,17 @@
</span><span class="cx"> );
</span><span class="cx"> // TODO: Don't hard code activation link.
</span><span class="cx"> $subject = sprintf(
</span><ins>+ /**
+ * Filter the subject of the notification email of new user signup.
+ *
+ * @since MU
+ *
+ * @param string $subject Subject of the notification email.
+ * @param string $user User login name.
+ * @param string $user_email User email address.
+ * @param string $key Activation key created in wpmu_signup_user().
+ * @param array $meta Signup meta data.
+ */
</ins><span class="cx"> apply_filters( 'wpmu_signup_user_notification_subject',
</span><span class="cx"> __( '[%1$s] Activate %2$s' ),
</span><span class="cx"> $user, $user_email, $key, $meta
</span><span class="lines">@@ -854,6 +1015,15 @@
</span><span class="cx"> return new WP_Error( 'user_already_exists', __( 'That username is already activated.' ), $signup);
</span><span class="cx">
</span><span class="cx"> wpmu_welcome_user_notification( $user_id, $password, $meta );
</span><ins>+ /**
+ * Fires immediately after a new user is activated.
+ *
+ * @since MU
+ *
+ * @param int $user_id User ID.
+ * @param int $password User password.
+ * @param array $meta Signup meta data.
+ */
</ins><span class="cx"> do_action( 'wpmu_activate_user', $user_id, $password, $meta );
</span><span class="cx"> return array( 'user_id' => $user_id, 'password' => $password, 'meta' => $meta );
</span><span class="cx"> }
</span><span class="lines">@@ -873,7 +1043,18 @@
</span><span class="cx">
</span><span class="cx"> $wpdb->update( $wpdb->signups, array('active' => 1, 'activated' => $now), array('activation_key' => $key) );
</span><span class="cx"> wpmu_welcome_notification($blog_id, $user_id, $password, $signup->title, $meta);
</span><del>- do_action('wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta);
</del><ins>+ /**
+ * Fires immediately after a site is activated.
+ *
+ * @since MU
+ *
+ * @param int $blog_id Blog ID.
+ * @param int $user_id User ID.
+ * @param int $password User password.
+ * @param string $signup_title Site title.
+ * @param array $meta Signup meta data.
+ */
+ do_action( 'wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta );
</ins><span class="cx">
</span><span class="cx"> return array('blog_id' => $blog_id, 'user_id' => $user_id, 'password' => $password, 'title' => $signup->title, 'meta' => $meta);
</span><span class="cx"> }
</span><span class="lines">@@ -905,6 +1086,13 @@
</span><span class="cx"> delete_user_option( $user_id, 'capabilities' );
</span><span class="cx"> delete_user_option( $user_id, 'user_level' );
</span><span class="cx">
</span><ins>+ /**
+ * Fires immediately after a new user is created.
+ *
+ * @since MU
+ *
+ * @param int $user_id User ID.
+ */
</ins><span class="cx"> do_action( 'wpmu_new_user', $user_id );
</span><span class="cx">
</span><span class="cx"> return $user_id;
</span><span class="lines">@@ -981,6 +1169,18 @@
</span><span class="cx"> update_user_meta( $user_id, 'primary_blog', $blog_id );
</span><span class="cx">
</span><span class="cx"> restore_current_blog();
</span><ins>+ /**
+ * Fires immediately after a new site is created.
+ *
+ * @since MU
+ *
+ * @param int $blog_id Blog ID.
+ * @param int $user_id User ID.
+ * @param string $domain Site domain.
+ * @param string $path Site path.
+ * @param int $site_id Site ID. Only relevant on multi-network installs.
+ * @param array $meta Meta data. Used to set initial site options.
+ */
</ins><span class="cx"> do_action( 'wpmu_new_blog', $blog_id, $user_id, $domain, $path, $site_id, $meta );
</span><span class="cx">
</span><span class="cx"> return $blog_id;
</span><span class="lines">@@ -1017,6 +1217,14 @@
</span><span class="cx"> Remote IP: %3$s
</span><span class="cx">
</span><span class="cx"> Disable these notifications: %4$s' ), $blogname, $siteurl, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
</span><ins>+ /**
+ * Filter the message body of the new site activation email sent
+ * to the network administrator.
+ *
+ * @since MU
+ *
+ * @param string $msg Email body.
+ */
</ins><span class="cx"> $msg = apply_filters( 'newblog_notify_siteadmin', $msg );
</span><span class="cx">
</span><span class="cx"> wp_mail( $email, sprintf( __( 'New Site Registration: %s' ), $siteurl ), $msg );
</span><span class="lines">@@ -1052,6 +1260,15 @@
</span><span class="cx">
</span><span class="cx"> Disable these notifications: %3$s'), $user->user_login, wp_unslash( $_SERVER['REMOTE_ADDR'] ), $options_site_url);
</span><span class="cx">
</span><ins>+ /**
+ * Filter the message body of the new user activation email sent
+ * to the network administrator.
+ *
+ * @since MU
+ *
+ * @param string $msg Email body.
+ * @param WP_User $user WP_User instance of the new user.
+ */
</ins><span class="cx"> $msg = apply_filters( 'newuser_notify_siteadmin', $msg, $user );
</span><span class="cx"> wp_mail( $email, sprintf(__('New User Registration: %s'), $user->user_login), $msg );
</span><span class="cx"> return true;
</span><span class="lines">@@ -1073,6 +1290,16 @@
</span><span class="cx"> function domain_exists($domain, $path, $site_id = 1) {
</span><span class="cx"> global $wpdb;
</span><span class="cx"> $result = $wpdb->get_var( $wpdb->prepare("SELECT blog_id FROM $wpdb->blogs WHERE domain = %s AND path = %s AND site_id = %d", $domain, $path, $site_id) );
</span><ins>+ /**
+ * Filter whether a blogname is taken.
+ *
+ * @since 3.5.0
+ *
+ * @param int|null $result The blog_id if the blogname exists, null otherwise.
+ * @param string $domain Domain to be checked.
+ * @param string $path Path to be checked.
+ * @param int $site_id Site ID. Relevant only on multi-network installs.
+ */
</ins><span class="cx"> return apply_filters( 'domain_exists', $result, $domain, $path, $site_id );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1206,7 +1433,20 @@
</span><span class="cx"> function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) {
</span><span class="cx"> $current_site = get_current_site();
</span><span class="cx">
</span><del>- if ( !apply_filters('wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta) )
</del><ins>+ /**
+ * Filter whether to bypass the welcome email after site activation.
+ *
+ * Returning false disables the welcome email.
+ *
+ * @since MU
+ *
+ * @param int|bool $blog_id Blog ID.
+ * @param int $user_id User ID.
+ * @param string $password User password.
+ * @param string $title Site title.
+ * @param array $meta Signup meta data.
+ */
+ if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> $welcome_email = get_site_option( 'welcome_email' );
</span><span class="lines">@@ -1234,7 +1474,21 @@
</span><span class="cx"> $welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );
</span><span class="cx"> $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
</span><span class="cx">
</span><del>- $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta);
</del><ins>+ /**
+ * Filter the content of the welcome email after site activation.
+ *
+ * Content should be formatted for transmission via wp_mail().
+ *
+ * @since MU
+ *
+ * @param string $welcome_email Message body of the email.
+ * @param int $blog_id Blog ID.
+ * @param int $user_id User ID.
+ * @param string $password User password.
+ * @param string $title Site title.
+ * @param array $meta Signup meta data.
+ */
+ $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta );
</ins><span class="cx"> $admin_email = get_site_option( 'admin_email' );
</span><span class="cx">
</span><span class="cx"> if ( $admin_email == '' )
</span><span class="lines">@@ -1247,7 +1501,14 @@
</span><span class="cx"> if ( empty( $current_site->site_name ) )
</span><span class="cx"> $current_site->site_name = 'WordPress';
</span><span class="cx">
</span><del>- $subject = apply_filters( 'update_welcome_subject', sprintf(__('New %1$s Site: %2$s'), $current_site->site_name, wp_unslash( $title ) ) );
</del><ins>+ /**
+ * Filter the subject of the welcome email after site activation.
+ *
+ * @since MU
+ *
+ * @param string $subject Subject of the email.
+ */
+ $subject = apply_filters( 'update_welcome_subject', sprintf( __( 'New %1$s Site: %2$s' ), $current_site->site_name, wp_unslash( $title ) ) );
</ins><span class="cx"> wp_mail($user->user_email, $subject, $message, $message_headers);
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="lines">@@ -1270,14 +1531,37 @@
</span><span class="cx"> function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) {
</span><span class="cx"> $current_site = get_current_site();
</span><span class="cx">
</span><del>- if ( !apply_filters('wpmu_welcome_user_notification', $user_id, $password, $meta) )
</del><ins>+ /**
+ * Filter whether to bypass the welcome email after user activation.
+ *
+ * Returning false disables the welcome email.
+ *
+ * @since MU
+ *
+ * @param int $user_id User ID.
+ * @param string $password User password.
+ * @param array $meta Signup meta data.
+ */
+ if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) )
</ins><span class="cx"> return false;
</span><span class="cx">
</span><span class="cx"> $welcome_email = get_site_option( 'welcome_user_email' );
</span><span class="cx">
</span><span class="cx"> $user = get_userdata( $user_id );
</span><span class="cx">
</span><del>- $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta);
</del><ins>+ /**
+ * Filter the content of the welcome email after user activation.
+ *
+ * Content should be formatted for transmission via wp_mail().
+ *
+ * @since MU
+ *
+ * @param type $welcome_email The message body of the account activation success email.
+ * @param int $user_id User ID.
+ * @param string $password User password.
+ * @param array $meta Signup meta data.
+ */
+ $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );
</ins><span class="cx"> $welcome_email = str_replace( 'SITE_NAME', $current_site->site_name, $welcome_email );
</span><span class="cx"> $welcome_email = str_replace( 'USERNAME', $user->user_login, $welcome_email );
</span><span class="cx"> $welcome_email = str_replace( 'PASSWORD', $password, $welcome_email );
</span><span class="lines">@@ -1295,7 +1579,14 @@
</span><span class="cx"> if ( empty( $current_site->site_name ) )
</span><span class="cx"> $current_site->site_name = 'WordPress';
</span><span class="cx">
</span><del>- $subject = apply_filters( 'update_welcome_user_subject', sprintf(__('New %1$s User: %2$s'), $current_site->site_name, $user->user_login) );
</del><ins>+ /**
+ * Filter the subject of the welcome email after user activation.
+ *
+ * @since MU
+ *
+ * @param string $subject Subject of the email.
+ */
+ $subject = apply_filters( 'update_welcome_user_subject', sprintf( __( 'New %1$s User: %2$s' ), $current_site->site_name, $user->user_login) );
</ins><span class="cx"> wp_mail($user->user_email, $subject, $message, $message_headers);
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="lines">@@ -1617,6 +1908,15 @@
</span><span class="cx"> * @since MU
</span><span class="cx"> */
</span><span class="cx"> function maybe_redirect_404() {
</span><ins>+ /**
+ * Filter the redirect URL for 404s on the main site.
+ *
+ * The filter is only evaluated if the NOBLOGREDIRECT constant is defined.
+ *
+ * @since 3.0.0
+ *
+ * @param string $no_blog_redirect The redirect URL defined in NOBLOGREDIRECT.
+ */
</ins><span class="cx"> if ( is_main_site() && is_404() && defined( 'NOBLOGREDIRECT' ) && ( $destination = apply_filters( 'blog_redirect_404', NOBLOGREDIRECT ) ) ) {
</span><span class="cx"> if ( $destination == '%siteurl%' )
</span><span class="cx"> $destination = network_home_url();
</span><span class="lines">@@ -1668,7 +1968,15 @@
</span><span class="cx">
</span><span class="cx"> if ( is_array( $details ) ) {
</span><span class="cx"> $result = add_user_to_blog( $blog_id, $details[ 'user_id' ], $details[ 'role' ] );
</span><del>- do_action( 'added_existing_user', $details[ 'user_id' ], $result );
</del><ins>+ /**
+ * Fires immediately after an existing user is added to a site.
+ *
+ * @since MU
+ *
+ * @param int $user_id User ID.
+ * @param mixed $result True on success or a WP_Error object if the user doesn't exist.
+ */
+ do_action( 'added_existing_user', $details['user_id'], $result );
</ins><span class="cx"> }
</span><span class="cx"> return $result;
</span><span class="cx"> }
</span><span class="lines">@@ -1893,11 +2201,13 @@
</span><span class="cx"> $is_small_network = ! wp_is_large_network( 'sites' );
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filter the decision to update network user and site counts in real time.
</del><ins>+ * Filter whether to update network site or user counts when a new site is created.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.7.0
</span><span class="cx"> *
</span><del>- * @param bool $small_network Based on wp_is_large_network( $context ).
</del><ins>+ * @see wp_is_large_network()
+ *
+ * @param bool $small_network Whether the network is considered small.
</ins><span class="cx"> * @param string $context Context. Either 'users' or 'sites'.
</span><span class="cx"> */
</span><span class="cx"> if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'sites' ) )
</span><span class="lines">@@ -1919,14 +2229,7 @@
</span><span class="cx"> function wp_maybe_update_network_user_counts() {
</span><span class="cx"> $is_small_network = ! wp_is_large_network( 'users' );
</span><span class="cx">
</span><del>- /**
- * Filter the decision to update network user and site counts in real time.
- *
- * @since 3.7.0
- *
- * @param bool $small_network Based on wp_is_large_network( $context ).
- * @param string $context Context. Either 'users' or 'sites'.
- */
</del><ins>+ /** This filter is documented in wp-includes/ms-functions.php */
</ins><span class="cx"> if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) )
</span><span class="cx"> return;
</span><span class="cx">
</span><span class="lines">@@ -1965,7 +2268,13 @@
</span><span class="cx"> * @return int Used space in megabytes
</span><span class="cx"> */
</span><span class="cx"> function get_space_used() {
</span><del>- // Allow for an alternative way of tracking storage space used
</del><ins>+ /**
+ * Filter the amount of storage space used by the current site.
+ *
+ * @since 3.5.0
+ *
+ * @param int|bool $space_used The amount of used space, in megabytes. Default false.
+ */
</ins><span class="cx"> $space_used = apply_filters( 'pre_get_space_used', false );
</span><span class="cx"> if ( false === $space_used ) {
</span><span class="cx"> $upload_dir = wp_upload_dir();
</span><span class="lines">@@ -1991,6 +2300,13 @@
</span><span class="cx"> if ( empty( $space_allowed ) || ! is_numeric( $space_allowed ) )
</span><span class="cx"> $space_allowed = 100;
</span><span class="cx">
</span><ins>+ /**
+ * Filter the upload quota for the current site.
+ *
+ * @since 3.7.0
+ *
+ * @param int $space_allowed Upload quota in megabytes for the current blog.
+ */
</ins><span class="cx"> return apply_filters( 'get_space_allowed', $space_allowed );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -2053,10 +2369,20 @@
</span><span class="cx"> function wp_is_large_network( $using = 'sites' ) {
</span><span class="cx"> if ( 'users' == $using ) {
</span><span class="cx"> $count = get_user_count();
</span><ins>+ /**
+ * Filter whether the network is considered large.
+ *
+ * @since 3.3.0
+ *
+ * @param bool $is_large_network Whether the network has more than 10000 users or sites.
+ * @param string $component The component to count. Accepts 'users', or 'sites'.
+ * @param int $count The count of items for the component.
+ */
</ins><span class="cx"> return apply_filters( 'wp_is_large_network', $count > 10000, 'users', $count );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> $count = get_blog_count();
</span><ins>+ /** This filter is documented in wp-includes/ms-functions.php */
</ins><span class="cx"> return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>