<!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>[40590] trunk: Multisite: Add `$network_id` parameter to `wp_is_large_network()`.</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/40590">40590</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/40590","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-05-09 15:50:04 +0000 (Tue, 09 May 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'>Multisite: Add `$network_id` parameter to `wp_is_large_network()`.
Now that `get_blog_count()` and `get_user_count()` both support passing a `$network_id` parameter (see <a href="https://core.trac.wordpress.org/changeset/40370">[40370]</a> and <a href="https://core.trac.wordpress.org/changeset/40371">[40371]</a>), similar functionality is now available for `wp_is_large_network()`. In addition, the filter `wp_is_large_network` now accepts the network ID as its fourth parameter.
This changeset furthermore introduces unit tests for the `wp_is_large_network()` function and its filter.
Fixes <a href="https://core.trac.wordpress.org/ticket/40489">#40489</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmsfunctionsphp">trunk/src/wp-includes/ms-functions.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitenetworkphp">trunk/tests/phpunit/tests/multisite/network.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-05-09 14:58:39 UTC (rev 40589)
+++ trunk/src/wp-includes/ms-functions.php 2017-05-09 15:50:04 UTC (rev 40590)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2490,27 +2490,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Plugins can alter this criteria using the {@see 'wp_is_large_network'} filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $using 'sites or 'users'. Default is 'sites'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.8.0 The $network_id parameter has been added.
+ *
+ * @param string $using 'sites or 'users'. Default is 'sites'.
+ * @param int|null $network_id ID of the network. Default is the current network.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the network meets the criteria for large. False otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_is_large_network( $using = 'sites' ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_is_large_network( $using = 'sites', $network_id = null ) {
+ $network_id = (int) $network_id;
+ if ( ! $network_id ) {
+ $network_id = get_current_network_id();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'users' == $using ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $count = get_user_count();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = get_user_count( $network_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether the network is considered large.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.8.0 The $network_id parameter has been added.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $is_large_network Whether the network has more than 10000 users or sites.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $component The component to count. Accepts 'users', or 'sites'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $count The count of items for the component.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $network_id The ID of the network being checked.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'wp_is_large_network', $count > 10000, 'users', $count );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'wp_is_large_network', $count > 10000, 'users', $count, $network_id );
</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">- $count = get_blog_count();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $count = get_blog_count( $network_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/ms-functions.php */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return apply_filters( 'wp_is_large_network', $count > 10000, 'sites', $count, $network_id );
</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></pre></div>
<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 2017-05-09 14:58:39 UTC (rev 40589)
+++ trunk/tests/phpunit/tests/multisite/network.php 2017-05-09 15:50:04 UTC (rev 40590)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -470,6 +470,121 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $site_count > 0 && $user_count > 0 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 40489
+ * @dataProvider data_wp_is_large_network
+ */
+ public function test_wp_is_large_network( $using, $count, $expected, $different_network ) {
+ $network_id = $different_network ? self::$different_network_id : null;
+ $network_option = 'users' === $using ? 'user_count' : 'blog_count';
+
+ update_network_option( $network_id, $network_option, $count );
+
+ $result = wp_is_large_network( $using, $network_id );
+ if ( $expected ) {
+ $this->assertTrue( $result );
+ } else {
+ $this->assertFalse( $result );
+ }
+ }
+
+ public function data_wp_is_large_network() {
+ return array(
+ array( 'sites', 10000, false, false ),
+ array( 'sites', 10001, true, false ),
+ array( 'users', 10000, false, false ),
+ array( 'users', 10001, true, false ),
+ array( 'sites', 10000, false, true ),
+ array( 'sites', 10001, true, true ),
+ array( 'users', 10000, false, true ),
+ array( 'users', 10001, true, true ),
+ );
+ }
+
+ /**
+ * @ticket 40489
+ * @dataProvider data_wp_is_large_network_filtered_by_component
+ */
+ public function test_wp_is_large_network_filtered_by_component( $using, $count, $expected, $different_network ) {
+ $network_id = $different_network ? self::$different_network_id : null;
+ $network_option = 'users' === $using ? 'user_count' : 'blog_count';
+
+ update_network_option( $network_id, $network_option, $count );
+
+ add_filter( 'wp_is_large_network', array( $this, 'filter_wp_is_large_network_for_users' ), 10, 3 );
+ $result = wp_is_large_network( $using, $network_id );
+ remove_filter( 'wp_is_large_network', array( $this, 'filter_wp_is_large_network_for_users' ), 10 );
+
+ if ( $expected ) {
+ $this->assertTrue( $result );
+ } else {
+ $this->assertFalse( $result );
+ }
+ }
+
+ public function data_wp_is_large_network_filtered_by_component() {
+ return array(
+ array( 'sites', 10000, false, false ),
+ array( 'sites', 10001, true, false ),
+ array( 'users', 1000, false, false ),
+ array( 'users', 1001, true, false ),
+ array( 'sites', 10000, false, true ),
+ array( 'sites', 10001, true, true ),
+ array( 'users', 1000, false, true ),
+ array( 'users', 1001, true, true ),
+ );
+ }
+
+ public function filter_wp_is_large_network_for_users( $is_large_network, $using, $count ) {
+ if ( 'users' === $using ) {
+ return $count > 1000;
+ }
+
+ return $is_large_network;
+ }
+
+ /**
+ * @ticket 40489
+ * @dataProvider data_wp_is_large_network_filtered_by_network
+ */
+ public function test_wp_is_large_network_filtered_by_network( $using, $count, $expected, $different_network ) {
+ $network_id = $different_network ? self::$different_network_id : null;
+ $network_option = 'users' === $using ? 'user_count' : 'blog_count';
+
+ update_network_option( $network_id, $network_option, $count );
+
+ add_filter( 'wp_is_large_network', array( $this, 'filter_wp_is_large_network_on_different_network' ), 10, 4 );
+ $result = wp_is_large_network( $using, $network_id );
+ remove_filter( 'wp_is_large_network', array( $this, 'filter_wp_is_large_network_on_different_network' ), 10 );
+
+ if ( $expected ) {
+ $this->assertTrue( $result );
+ } else {
+ $this->assertFalse( $result );
+ }
+ }
+
+ public function data_wp_is_large_network_filtered_by_network() {
+ return array(
+ array( 'sites', 10000, false, false ),
+ array( 'sites', 10001, true, false ),
+ array( 'users', 10000, false, false ),
+ array( 'users', 10001, true, false ),
+ array( 'sites', 1000, false, true ),
+ array( 'sites', 1001, true, true ),
+ array( 'users', 1000, false, true ),
+ array( 'users', 1001, true, true ),
+ );
+ }
+
+ public function filter_wp_is_large_network_on_different_network( $is_large_network, $using, $count, $network_id ) {
+ if ( $network_id === (int) self::$different_network_id ) {
+ return $count > 1000;
+ }
+
+ return $is_large_network;
+ }
</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>