<!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>[44807] branches/5.1/tests/phpunit/tests/multisite/site.php: Multisite: Ensure `wpmu_new_blog` hook receives expected data in `$meta`.</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 { white-space: pre-line; 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/44807">44807</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/44807","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jeremyfelt</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-03-07 04:36:36 +0000 (Thu, 07 Mar 2019)</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'>Multisite: Ensure `wpmu_new_blog` hook receives expected data in `$meta`.
Restores `public`, `archived`, `mature`, `spam`, `deleted`, `lang_id`, and `WPLANG` to the `$meta` data passed to `wpmu_new_blog`. This hook was deprecated in 5.1.0, but code using it still relies on this data.
Props davidbinda, pbiron.
Merges <a href="https://core.trac.wordpress.org/changeset/44805">[44805]</a> and <a href="https://core.trac.wordpress.org/changeset/44806">[44806]</a> to the 5.1 branch.
Fixes <a href="https://core.trac.wordpress.org/ticket/46351">#46351</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches51srcwpincludesmssitephp">branches/5.1/src/wp-includes/ms-site.php</a></li>
<li><a href="#branches51testsphpunittestsmultisitesitephp">branches/5.1/tests/phpunit/tests/multisite/site.php</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches51">branches/5.1/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/5.1
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/5.1 2019-03-07 03:45:26 UTC (rev 44806)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/5.1 2019-03-07 04:36:36 UTC (rev 44807)
</ins><a id="branches51"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/5.1</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/4.9:43557,43622
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/5.0:43681-43682,43684-43688,43719-43720,43723,43726-43727,43729-43731,43734-43744,43747,43751-43754,43758,43760-43765,43767-43770,43772,43774-43781,43783,43785,43790-43806,43808-43821,43825,43828,43830-43834,43836-43843,43846-43863,43867-43889,43891-43894,43897-43905,43908-43909,43911-43929,43931-43942,43946-43947,43949-43956,43959-43964,43967-43969,43988,43994,44014,44017,44047,44183,44185,44187-44206,44208-44213,44231-44232,44235,44248,44284,44287-44288
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:44744,44747-44749,44760,44762,44768-44769,44788,44794,44797,44799,44801
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:44744,44747-44749,44760,44762,44768-44769,44788,44794,44797,44799,44801,44805-44806
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches51srcwpincludesmssitephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.1/src/wp-includes/ms-site.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.1/src/wp-includes/ms-site.php 2019-03-07 03:45:26 UTC (rev 44806)
+++ branches/5.1/src/wp-includes/ms-site.php 2019-03-07 04:36:36 UTC (rev 44807)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,18 +52,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'lang_id' => 0,
</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">- // Extract the passed arguments that may be relevant for site initialization.
- $args = array_diff_key( $data, $defaults );
- if ( isset( $args['site_id'] ) ) {
- unset( $args['site_id'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prepared_data = wp_prepare_site_data( $data, $defaults );
+ if ( is_wp_error( $prepared_data ) ) {
+ return $prepared_data;
</ins><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">- $data = wp_prepare_site_data( $data, $defaults );
- if ( is_wp_error( $data ) ) {
- return $data;
- }
-
- if ( false === $wpdb->insert( $wpdb->blogs, $data ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false === $wpdb->insert( $wpdb->blogs, $prepared_data ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'db_insert_error', __( 'Could not insert site into the database.' ), $wpdb->last_error );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,6 +78,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'wp_insert_site', $new_site );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Extract the passed arguments that may be relevant for site initialization.
+ $args = array_diff_key( $data, $defaults );
+ if ( isset( $args['site_id'] ) ) {
+ unset( $args['site_id'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires when a site's initialization routine should be executed.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,6 +99,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user_id = ! empty( $args['user_id'] ) ? $args['user_id'] : 0;
</span><span class="cx" style="display: block; padding: 0 10px"> $meta = ! empty( $args['options'] ) ? $args['options'] : array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // WPLANG was passed with `$meta` to the `wpmu_new_blog` hook prior to 5.1.0.
+ if ( ! array_key_exists( 'WPLANG', $meta ) ) {
+ $meta['WPLANG'] = get_network_option( $new_site->network_id, 'WPLANG' );
+ }
+
+ // Rebuild the data expected by the `wpmu_new_blog` hook prior to 5.1.0 using whitelisted keys.
+ // The `$site_data_whitelist` matches the one used in `wpmu_create_blog()`.
+ $site_data_whitelist = array( 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
+ $meta = array_merge( array_intersect_key( $data, array_flip( $site_data_whitelist ) ), $meta );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately after a new site is created.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="branches51testsphpunittestsmultisitesitephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.1/tests/phpunit/tests/multisite/site.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.1/tests/phpunit/tests/multisite/site.php 2019-03-07 03:45:26 UTC (rev 44806)
+++ branches/5.1/tests/phpunit/tests/multisite/site.php 2019-03-07 04:36:36 UTC (rev 44807)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,6 +12,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $suppress = false;
</span><span class="cx" style="display: block; padding: 0 10px"> protected $site_status_hooks = array();
</span><span class="cx" style="display: block; padding: 0 10px"> protected $wp_initialize_site_args = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $wp_initialize_site_meta = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> protected static $network_ids;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $site_ids;
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $uninitialized_site_id;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2348,6 +2349,83 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Set siteurl
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'siteurl', 'http://testsite1.example.org/test' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Tests whether all expected meta are provided in deprecated `wpmu_new_blog` action.
+ *
+ * @dataProvider data_wpmu_new_blog_action_backward_commpatible
+ *
+ * @ticket 46351
+ */
+ public function test_wpmu_new_blog_action_backward_compatible( $meta, $expected_meta ) {
+ // We are testing deprecated hook. Register it to expected deprecated notices.
+ $this->setExpectedDeprecated( 'wpmu_new_blog' );
+ add_action( 'wpmu_new_blog', array( $this, 'wpmu_new_blog_callback' ), 10, 6 );
+
+ wpmu_create_blog( 'testsite1.example.org', '/new-blog/', 'New Blog', get_current_user_id(), $meta, 1 );
+
+ $this->assertEquals( $expected_meta, $this->wp_initialize_site_meta );
+
+ $this->wp_initialize_site_meta = array();
+ }
+
+ /**
+ * Capture the $meta value passed to the wpmu_new_blog action and compare it.
+ */
+ public function wpmu_new_blog_callback( $blog_id, $user_id, $domain, $path, $network_id, $meta ) {
+ $this->wp_initialize_site_meta = $meta;
+ }
+
+ public function data_wpmu_new_blog_action_backward_commpatible() {
+ return array(
+ 'default values' => array(
+ array(),
+ array(
+ 'public' => 0, // `public` is one of the defaults metas in `wpmu_create_blog' function prior WordPress 5.1.0
+ 'WPLANG' => 'en_US', // WPLANG is another default meta in `wpmu_create_blog` function prior WordPress 5.1.0.
+ ),
+ ),
+ 'public site' => array(
+ array(
+ 'public' => 1,
+ ),
+ array(
+ 'public' => 1,
+ 'WPLANG' => 'en_US',
+ ),
+ ),
+ 'all whitelisted' => array(
+ array(
+ 'public' => -1,
+ 'archived' => 0,
+ 'mature' => 0,
+ 'spam' => 0,
+ 'deleted' => 0,
+ 'lang_id' => 11,
+
+ ),
+ array(
+ 'public' => -1,
+ 'WPLANG' => 'en_US',
+ 'archived' => 0,
+ 'mature' => 0,
+ 'spam' => 0,
+ 'deleted' => 0,
+ 'lang_id' => 11,
+ ),
+ ),
+ 'extra meta key' => array(
+ array(
+ 'foo' => 'bar',
+ ),
+ array(
+ 'public' => 0,
+ 'WPLANG' => 'en_US',
+ 'foo' => 'bar',
+ ),
+ ),
+ );
+ }
</ins><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"> endif;
</span></span></pre>
</div>
</div>
</body>
</html>