<!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>[39887] trunk/src/wp-includes/ms-functions.php: Docs: Make `$meta` parameter description in multisite signup and registration functions more consistent.</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/39887">39887</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/39887","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-01-12 05:20:57 +0000 (Thu, 12 Jan 2017)</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: Make `$meta` parameter description in multisite signup and registration functions more consistent.
See <a href="https://core.trac.wordpress.org/ticket/38781">#38781</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 2017-01-12 04:56:28 UTC (rev 39886)
+++ trunk/src/wp-includes/ms-functions.php 2017-01-12 05:20:57 UTC (rev 39887)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -765,7 +765,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login The user's login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email The user's email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key The activation key created in wpmu_signup_blog()
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta By default, contains the requested privacy setting and lang_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wpmu_signup_blog_notification( $domain, $path, $title, $user_login, $user_email, $key, $meta = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -780,7 +780,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login User login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email User email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Activation key created in wpmu_signup_blog().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta By default, contains the requested privacy setting and lang_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! apply_filters( 'wpmu_signup_blog_notification', $domain, $path, $title, $user_login, $user_email, $key, $meta ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -817,7 +817,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login User login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email User email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Activation key created in wpmu_signup_blog().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta By default, contains the requested privacy setting and lang_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> apply_filters( 'wpmu_signup_blog_notification_email',
</span><span class="cx" style="display: block; padding: 0 10px"> __( "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="lines" style="display: block; padding: 0 10px; color: #888">@@ -841,7 +841,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login User login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email User email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Activation key created in wpmu_signup_blog().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta By default, contains the requested privacy setting and lang_id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> apply_filters( 'wpmu_signup_blog_notification_subject',
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: New site notification email subject. 1: Network name, 2: New site URL */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -878,7 +878,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login The user's login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email The user's email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key The activation key created in wpmu_signup_user()
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta By default, an empty array.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Optional. Signup meta data. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -890,7 +890,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login User login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email User email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Activation key created in wpmu_signup_user().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! apply_filters( 'wpmu_signup_user_notification', $user_login, $user_email, $key, $meta ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -916,7 +916,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login User login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email User email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Activation key created in wpmu_signup_user().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> apply_filters( 'wpmu_signup_user_notification_email',
</span><span class="cx" style="display: block; padding: 0 10px"> __( "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="lines" style="display: block; padding: 0 10px; color: #888">@@ -935,7 +935,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_login User login name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $user_email User email address.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $key Activation key created in wpmu_signup_user().
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> apply_filters( 'wpmu_signup_user_notification_subject',
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: New user notification email subject. 1: Network name, 2: New user login */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1041,7 +1041,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $password User password.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $signup_title Site title.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'wpmu_activate_blog', $blog_id, $user_id, $password, $signup->title, $meta );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1441,11 +1441,11 @@
</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="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $blog_id
- * @param int $user_id
- * @param string $password
- * @param string $title The new blog's title
- * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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 Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wpmu_welcome_notification( $blog_id, $user_id, $password, $title, $meta = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1462,7 +1462,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $password User password.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Site title.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! apply_filters( 'wpmu_welcome_notification', $blog_id, $user_id, $password, $title, $meta ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1510,7 +1510,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $password User password.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Site title.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. By default, contains the requested privacy setting and lang_id.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $welcome_email = apply_filters( 'update_welcome_email', $welcome_email, $blog_id, $user_id, $password, $title, $meta );
</span><span class="cx" style="display: block; padding: 0 10px"> $admin_email = get_site_option( 'admin_email' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1555,9 +1555,9 @@
</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="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $user_id
- * @param string $password
- * @param array $meta Optional. Not used in the default function, but is passed along to hooks for customization.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $user_id User ID.
+ * @param string $password User password.
+ * @param array $meta Optional. Signup meta data. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wpmu_welcome_user_notification( $user_id, $password, $meta = array() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1572,7 +1572,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $password User password.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! apply_filters( 'wpmu_welcome_user_notification', $user_id, $password, $meta ) )
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1593,7 +1593,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $welcome_email The message body of the account activation success email.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id User ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $password User password.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $meta Signup meta data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta Signup meta data. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $welcome_email = apply_filters( 'update_welcome_user_email', $welcome_email, $user_id, $password, $meta );
</span><span class="cx" style="display: block; padding: 0 10px"> $welcome_email = str_replace( 'SITE_NAME', $current_network->site_name, $welcome_email );
</span></span></pre>
</div>
</div>
</body>
</html>