<!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>[46342] trunk/tests/phpunit/tests/multisite/network.php: Docs: Improve comments in `tests/multisite/network.php` per the documentation standards.</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/46342">46342</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/46342","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>2019-09-29 12:18:48 +0000 (Sun, 29 Sep 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'>Docs: Improve comments in `tests/multisite/network.php` per the documentation standards.
Props garrett-eclipse, jrf.
See <a href="https://core.trac.wordpress.org/ticket/48142">#48142</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsmultisitenetworkphp">trunk/tests/phpunit/tests/multisite/network.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsmultisitenetworkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/multisite/network.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite/network.php 2019-09-29 11:03:14 UTC (rev 46341)
+++ trunk/tests/phpunit/tests/multisite/network.php 2019-09-29 12:18:48 UTC (rev 46342)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,7 +152,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $site_count_start = get_blog_count();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $site_ids = self::factory()->blog->create_many( 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actual = (int) get_blog_count(); // count only updated when cron runs, so unchanged
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actual = (int) get_blog_count(); // Count only updated when cron runs, so should be unchanged.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $site_ids as $site_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> wpmu_delete_blog( $site_id, true );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -171,7 +171,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'enable_live_network_counts', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> $site_ids = self::factory()->blog->create_many( 1 );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actual = (int) get_blog_count(); // count only updated when cron runs, so unchanged
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $actual = (int) get_blog_count(); // Count only updated when cron runs, so should be unchanged.
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'enable_live_network_counts', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $site_ids as $site_id ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,16 +234,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 22917
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_enable_live_network_user_counts_filter() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // false for large networks by default
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // False for large networks by default.
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'enable_live_network_counts', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Refresh the cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Refresh the cache.
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_update_network_counts();
</span><span class="cx" style="display: block; padding: 0 10px"> $start_count = get_user_count();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wpmu_create_user( 'user', 'pass', 'email' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // No change, cache not refreshed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No change, cache not refreshed.
</ins><span class="cx" style="display: block; padding: 0 10px"> $count = get_user_count();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $start_count, $count );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -265,29 +265,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_active_network_plugins() {
</span><span class="cx" style="display: block; padding: 0 10px"> $path = 'hello.php';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // local activate, should be invisible for the network
- activate_plugin( $path ); // $network_wide = false
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Local activate, should be invisible for the network.
+ activate_plugin( $path ); // Enable the plugin for the current site.
</ins><span class="cx" style="display: block; padding: 0 10px"> $active_plugins = wp_get_active_network_plugins();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array(), $active_plugins );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deactivated_plugin', array( $this, '_helper_deactivate_hook' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // activate the plugin sitewide
- activate_plugin( $path, '', $network_wide = true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Activate the plugin sitewide.
+ activate_plugin( $path, '', $network_wide = true ); // Enable the plugin for all sites in the network.
</ins><span class="cx" style="display: block; padding: 0 10px"> $active_plugins = wp_get_active_network_plugins();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( WP_PLUGIN_DIR . '/hello.php' ), $active_plugins );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- //deactivate the plugin
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Deactivate the plugin.
</ins><span class="cx" style="display: block; padding: 0 10px"> deactivate_plugins( $path );
</span><span class="cx" style="display: block; padding: 0 10px"> $active_plugins = wp_get_active_network_plugins();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array(), $active_plugins );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 1, $this->plugin_hook_count ); // testing actions and silent mode
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 1, $this->plugin_hook_count ); // Testing actions and silent mode.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- activate_plugin( $path, '', $network_wide = true );
- deactivate_plugins( $path, true ); // silent
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ activate_plugin( $path, '', $network_wide = true ); // Enable the plugin for all sites in the network.
+ deactivate_plugins( $path, true ); // Silent mode.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 1, $this->plugin_hook_count ); // testing actions and silent mode
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 1, $this->plugin_hook_count ); // Testing actions and silent mode.
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -298,14 +298,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $mock = new MockAction();
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'activate_' . $path, array( $mock, 'action' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // should activate on the first try
- activate_plugin( $path, '', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Should activate on the first try.
+ activate_plugin( $path, '', true ); // Enable the plugin for all sites in the network.
</ins><span class="cx" style="display: block; padding: 0 10px"> $active_plugins = wp_get_active_network_plugins();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 1, $active_plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1, $mock->get_call_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">- // should do nothing on the second try
- activate_plugin( $path, '', true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Should do nothing on the second try.
+ activate_plugin( $path, '', true ); // Enable the plugin for all sites in the network.
</ins><span class="cx" style="display: block; padding: 0 10px"> $active_plugins = wp_get_active_network_plugins();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 1, $active_plugins );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1, $mock->get_call_count() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -328,18 +328,18 @@
</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"> function test_get_user_count() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Refresh the cache
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Refresh the cache.
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_update_network_counts();
</span><span class="cx" style="display: block; padding: 0 10px"> $start_count = get_user_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">- // Only false for large networks as of 3.7
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Only false for large networks as of 3.7.
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'enable_live_network_counts', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> self::factory()->user->create( array( 'role' => 'administrator' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $count = get_user_count(); // No change, cache not refreshed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = get_user_count(); // No change, cache not refreshed.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $start_count, $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">- wp_update_network_counts(); // Magic happens here
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_update_network_counts(); // Magic happens here.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $count = get_user_count();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $start_count + 1, $count );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -349,7 +349,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_wp_schedule_update_network_counts() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( wp_next_scheduled( 'update_network_counts' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // We can't use wp_schedule_update_network_counts() because WP_INSTALLING is set
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We can't use wp_schedule_update_network_counts() because WP_INSTALLING is set.
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_schedule_event( time(), 'twicedaily', 'update_network_counts' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertInternalType( 'int', wp_next_scheduled( 'update_network_counts' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -359,7 +359,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @expectedDeprecated get_dashboard_blog
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_get_dashboard_blog() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // if there is no dashboard blog set, current blog is used
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If there is no dashboard blog set, current blog is used.
</ins><span class="cx" style="display: block; padding: 0 10px"> $dashboard_blog = get_dashboard_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1, $dashboard_blog->blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -367,7 +367,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = self::factory()->blog->create( array( 'user_id' => $user_id ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertInternalType( 'int', $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // set the dashboard blog to another one
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Set the dashboard blog to another one.
</ins><span class="cx" style="display: block; padding: 0 10px"> update_site_option( 'dashboard_blog', $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $dashboard_blog = get_dashboard_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $blog_id, $dashboard_blog->blog_id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -647,12 +647,12 @@
</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">- * Gets the ID of the site with the highest ID
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets the ID of the site with the highest ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function _get_next_network_id() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- //create an extra network, just to make sure we know the ID of the following one
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Create an extra network, just to make sure we know the ID of the following one.
</ins><span class="cx" style="display: block; padding: 0 10px"> static::factory()->network->create();
</span><span class="cx" style="display: block; padding: 0 10px"> return (int) $wpdb->get_var( 'SELECT id FROM ' . $wpdb->site . ' ORDER BY id DESC LIMIT 1' ) + 1;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>