<!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>[37540] trunk/src/wp-includes/ms-functions.php: Docs: Apply inline `@see` tags to hooks referenced in DocBlocks 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/37540">37540</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/37540","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-23 18:55:17 +0000 (Mon, 23 May 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Apply inline `@see` tags to hooks referenced in DocBlocks in wp-includes/ms-functions.php.
Applying these specially-crafted `@see` tags allows the Code Reference parser to recognize and link these elements as actions and filters.
See <a href="https://core.trac.wordpress.org/ticket/36921">#36921</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 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/ms-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-functions.php 2016-05-23 18:53:05 UTC (rev 37539)
+++ trunk/src/wp-includes/ms-functions.php 2016-05-23 18:55:17 UTC (rev 37540)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,10 +138,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add a user to a blog.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds a user to a blog.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Use the 'add_user_to_blog' action to fire an event when
- * users are added to a blog.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Use the {@see 'add_user_to_blog'} action to fire an event when users are added to a blog.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU 1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -187,10 +186,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Remove a user from a blog.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Use the 'remove_user_from_blog' action to fire an event when
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Use the {@see 'remove_user_from_blog'} action to fire an event when
</ins><span class="cx" style="display: block; padding: 0 10px"> * users are removed from a blog.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Accepts an optional $reassign parameter, if you want to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Accepts an optional `$reassign` parameter, if you want to
</ins><span class="cx" style="display: block; padding: 0 10px"> * reassign the user's blog posts to another user upon removal.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU 1.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -527,7 +526,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * $user parameter to the function, where $user is the other user, is
</span><span class="cx" style="display: block; padding: 0 10px"> * effectively an override of this limitation.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'wpmu_validate_blog_signup' if you want to modify
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'wpmu_validate_blog_signup'} if you want to modify
</ins><span class="cx" style="display: block; padding: 0 10px"> * the way that WordPress validates new site signups.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -749,11 +748,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * This is the notification function used when site registration
</span><span class="cx" style="display: block; padding: 0 10px"> * is enabled.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'wpmu_signup_blog_notification' to bypass this function or
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'wpmu_signup_blog_notification'} to bypass this function or
</ins><span class="cx" style="display: block; padding: 0 10px"> * replace it with your own notification behavior.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'wpmu_signup_blog_notification_email' and
- * 'wpmu_signup_blog_notification_subject' to change the content
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'wpmu_signup_blog_notification_email'} and
+ * {@see 'wpmu_signup_blog_notification_subject'} to change the content
</ins><span class="cx" style="display: block; padding: 0 10px"> * and subject line of the email sent to newly registered users.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -855,11 +854,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * This is the notification function used when no new site has
</span><span class="cx" style="display: block; padding: 0 10px"> * been requested.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'wpmu_signup_user_notification' to bypass this function or
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'wpmu_signup_user_notification'} to bypass this function or
</ins><span class="cx" style="display: block; padding: 0 10px"> * replace it with your own notification behavior.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'wpmu_signup_user_notification_email' and
- * 'wpmu_signup_user_notification_subject' to change the content
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'wpmu_signup_user_notification_email'} and
+ * {@see 'wpmu_signup_user_notification_subject'} to change the content
</ins><span class="cx" style="display: block; padding: 0 10px"> * and subject line of the email sent to newly registered users.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -937,7 +936,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Activate a signup.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Hook to 'wpmu_activate_user' or 'wpmu_activate_blog' for events
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Hook to {@see 'wpmu_activate_user'} or {@see 'wpmu_activate_blog'} for events
</ins><span class="cx" style="display: block; padding: 0 10px"> * that should happen only when users or sites are self-created (since
</span><span class="cx" style="display: block; padding: 0 10px"> * those actions are not called when users and sites are created
</span><span class="cx" style="display: block; padding: 0 10px"> * by a Super Admin).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1032,9 +1031,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Create a user.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This function runs when a user self-registers as well as when
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * a Super Admin creates a new user. Hook to 'wpmu_new_user' for events
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * a Super Admin creates a new user. Hook to {@see 'wpmu_new_user'} for events
</ins><span class="cx" style="display: block; padding: 0 10px"> * that should affect all new users, but only on Multisite (otherwise
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * use 'user_register').
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * use {@see'user_register'}).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1070,7 +1069,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Create a site.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This function runs when a user self-registers a new site as well
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * as when a Super Admin creates a new site. Hook to 'wpmu_new_blog'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * as when a Super Admin creates a new site. Hook to {@see 'wpmu_new_blog'}
</ins><span class="cx" style="display: block; padding: 0 10px"> * for events that should affect all new sites.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * On subdirectory installs, $domain is the same as the main site's
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1154,7 +1153,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Notifies the network admin that a new site has been activated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'newblog_notify_siteadmin' to change the content of
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'newblog_notify_siteadmin'} to change the content of
</ins><span class="cx" style="display: block; padding: 0 10px"> * the notification email.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1200,7 +1199,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Notifies the network admin that a new user has been activated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'newuser_notify_siteadmin' to change the content of
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'newuser_notify_siteadmin'} to change the content of
</ins><span class="cx" style="display: block; padding: 0 10px"> * the notification email.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1402,9 +1401,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Notify a user that their blog activation has been successful.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'wpmu_welcome_notification' to disable or bypass.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'wpmu_welcome_notification'} to disable or bypass.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'update_welcome_email' and 'update_welcome_subject' to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'update_welcome_email'} and {@see 'update_welcome_subject'} to
</ins><span class="cx" style="display: block; padding: 0 10px"> * modify the content and subject line of the notification email.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1505,9 +1504,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Notify a user that their account activation has been successful.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'wpmu_welcome_user_notification' to disable or bypass.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'wpmu_welcome_user_notification'} to disable or bypass.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter 'update_welcome_user_email' and 'update_welcome_user_subject' to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter {@see 'update_welcome_user_email'} and {@see 'update_welcome_user_subject'} to
</ins><span class="cx" style="display: block; padding: 0 10px"> * modify the content and subject line of the notification email.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1998,10 +1997,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add a newly created user to the appropriate blog
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds a newly created user to the appropriate blog
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * To add a user in general, use add_user_to_blog(). This function
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * is specifically hooked into the wpmu_activate_user action.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * is specifically hooked into the {@see 'wpmu_activate_user'} action.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="cx" style="display: block; padding: 0 10px"> * @see add_user_to_blog()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2200,7 +2199,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Update the count of sites for the current network.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If enabled through the 'enable_live_network_counts' filter, update the sites count
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If enabled through the {@see 'enable_live_network_counts'} filter, update the sites count
</ins><span class="cx" style="display: block; padding: 0 10px"> * on a network when a site is created or its status is updated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2227,7 +2226,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Update the network-wide users count.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If enabled through the 'enable_live_network_counts' filter, update the users count
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If enabled through the {@see 'enable_live_network_counts'} filter, update the users count
</ins><span class="cx" style="display: block; padding: 0 10px"> * on a network when a user is created or its status is updated.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.7.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2377,7 +2376,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Whether or not we have a large network.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The default criteria for a large network is either more than 10,000 users or more than 10,000 sites.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Plugins can alter this criteria using the 'wp_is_large_network' filter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $using 'sites or 'users'. Default is 'sites'.
</span></span></pre>
</div>
</div>
</body>
</html>