<!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>[46251] trunk: Multisite/Sites: Add links to filter websites by status.</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/46251">46251</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/46251","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-23 17:34:20 +0000 (Mon, 23 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'>Multisite/Sites: Add links to filter websites by status.

This commit brings the Network-Admin Sites list page up-to-speed with other similar list-table powered pages, by adding links to filter the results by Site Status.

Includes a single unit test for the newly introduced `wp_count_sites()` multisite function, named to match the `wp_count_` function pattern from other list tables.

Fixes <a href="https://core.trac.wordpress.org/ticket/37392">#37392</a>. Props mnelson4, spacedmonkey, pbiron.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminnetworksitesphp">trunk/src/wp-admin/network/sites.php</a></li>
<li><a href="#trunksrcwpincludesmsblogsphp">trunk/src/wp-includes/ms-blogs.php</a></li>
<li><a href="#trunktestsphpunittestsmultisitephp">trunk/tests/phpunit/tests/multisite.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminnetworksitesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/network/sites.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/network/sites.php      2019-09-23 17:29:46 UTC (rev 46250)
+++ trunk/src/wp-admin/network/sites.php        2019-09-23 17:34:20 UTC (rev 46251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -369,6 +369,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> <hr class="wp-header-end">
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php $wp_list_table->views(); ?>
+
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php echo $msg; ?>
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px"> <form method="get" id="ms-search" class="wp-clearfix">
</span></span></pre></div>
<a id="trunksrcwpincludesmsblogsphp"></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-blogs.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-blogs.php        2019-09-23 17:29:46 UTC (rev 46250)
+++ trunk/src/wp-includes/ms-blogs.php  2019-09-23 17:34:20 UTC (rev 46251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -853,3 +853,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 
</span><span class="cx" style="display: block; padding: 0 10px">        update_posts_count();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Count number of sites grouped by site status.
+ *
+ * @since 5.3.0
+ *
+ * @param int $network_id The network to get counts for.  Default is the current network id.
+ * @return array Includes a grand total 'all' and an array of counts indexed by
+ *                status strings: public, archived, mature, spam, deleted.
+ */
+function wp_count_sites( $network_id = null ) {
+       if ( empty( $network_id ) ) {
+               $network_id = get_current_network_id();
+       }
+
+       $counts = array();
+       $args   = array(
+               'network_id'    => $network_id,
+               'number'        => 1,
+               'fields'        => 'ids',
+               'no_found_rows' => false,
+       );
+
+       $q             = new WP_Site_Query( $args );
+       $counts['all'] = $q->found_sites;
+
+       $_args    = $args;
+       $statuses = array( 'public', 'archived', 'mature', 'spam', 'deleted' );
+
+       foreach ( $statuses as $status ) {
+               $_args            = $args;
+               $_args[ $status ] = 1;
+
+               $q                 = new WP_Site_Query( $_args );
+               $counts[ $status ] = $q->found_sites;
+       }
+
+       return $counts;
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsmultisitephp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/multisite.php   2019-09-23 17:29:46 UTC (rev 46250)
+++ trunk/tests/phpunit/tests/multisite.php     2019-09-23 17:34:20 UTC (rev 46251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -34,6 +34,48 @@
</span><span class="cx" style="display: block; padding: 0 10px">                        $reg_blog = $wpdb->get_col( $wpdb->prepare( "SELECT email FROM {$wpdb->registration_log} WHERE {$wpdb->registration_log}.blog_id = 1 AND IP LIKE %s", $ip ) );
</span><span class="cx" style="display: block; padding: 0 10px">                        $this->assertEquals( $user->user_email, $reg_blog[ count( $reg_blog ) - 1 ] );
</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 37392
+                */
+               function test_wp_count_sites() {
+                       // create a random number of sites with each status.
+                       $site_ids = array(
+                               'public'   => self::factory()->blog->create_many(
+                                       random_int( 0, 5 ),
+                                       array( 'meta' => array( 'public' => 1 ) )
+                               ),
+                               'archived' => self::factory()->blog->create_many(
+                                       random_int( 0, 5 ),
+                                       array( 'meta' => array( 'archived' => 1 ) )
+                               ),
+                               'mature'   => self::factory()->blog->create_many(
+                                       random_int( 0, 5 ),
+                                       array( 'meta' => array( 'mature' => 1 ) )
+                               ),
+                               'spam'     => self::factory()->blog->create_many(
+                                       random_int( 0, 5 ),
+                                       array( 'meta' => array( 'spam' => 1 ) )
+                               ),
+                               'deleted'  => self::factory()->blog->create_many(
+                                       random_int( 0, 5 ),
+                                       array( 'meta' => array( 'deleted' => 1 ) )
+                               ),
+                       );
+
+                       $counts = wp_count_sites();
+
+                       $counts_by_status = array_map( 'count', $site_ids );
+                       $expected        = array_merge(
+                               array( 'all' => array_sum( $counts_by_status ) ),
+                               $counts_by_status
+                       );
+                       // add 1 to all & public for the main site.
+                       $expected['all']    += 1;
+                       $expected['public'] += 1;
+
+                       $this->assertEquals( $expected, $counts );
+               }
</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>