<!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>[53018] trunk/src/wp-includes: Users: Move `get_user_count()` and related functions to `wp-includes/user.php`.</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/53018">53018</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/53018","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>2022-03-29 13:51:52 +0000 (Tue, 29 Mar 2022)</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'>Users: Move `get_user_count()` and related functions to `wp-includes/user.php`.
The new location is next to the pre-existing `count_users()` function, along with other user-specific functions, and should be a more appropriate place in terms of consistency.
This affects:
* `get_user_count()`
* `wp_maybe_update_user_counts()`
* `wp_update_user_counts()`
* `wp_schedule_update_user_counts()`
* `wp_is_large_user_count()`
Follow-up to <a href="https://core.trac.wordpress.org/changeset/53011">[53011]</a>, <a href="https://core.trac.wordpress.org/changeset/53016">[53016]</a>.
See <a href="https://core.trac.wordpress.org/ticket/38741">#38741</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></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/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.php 2022-03-29 13:47:15 UTC (rev 53017)
+++ trunk/src/wp-includes/functions.php 2022-03-29 13:51:52 UTC (rev 53018)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8418,147 +8418,3 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_fuzzy_number_match( $expected, $actual, $precision = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return abs( (float) $expected - (float) $actual ) <= $precision;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-/**
- * Returns the number of active users in your installation.
- *
- * Note that on a large site the count may be cached and only updated twice daily.
- *
- * @since MU (3.0.0)
- * @since 4.8.0 The `$network_id` parameter has been added.
- * @since 6.0.0 Move to wp-includes/functions.php.
- *
- * @param int|null $network_id ID of the network. Default is the current network.
- * @return int Number of active users on the network.
- */
-function get_user_count( $network_id = null ) {
- if ( ! is_multisite() && null !== $network_id ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: %s: $network_id */
- __( 'Unable to pass %s if not using multisite.' ),
- '<code>$network_id</code>'
- ),
- '6.0.0'
- );
- }
-
- return (int) get_network_option( $network_id, 'user_count', -1 );
-}
-
-/**
- * Updates the total count of users on the site if live user counting is enabled.
- *
- * @since 6.0.0
- *
- * @param int|null $network_id ID of the network. Default is the current network.
- * @return bool Whether the update was successful.
- */
-function wp_maybe_update_user_counts( $network_id = null ) {
- if ( ! is_multisite() && null !== $network_id ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: %s: $network_id */
- __( 'Unable to pass %s if not using multisite.' ),
- '<code>$network_id</code>'
- ),
- '6.0.0'
- );
- }
-
- $is_small_network = ! wp_is_large_user_count( $network_id );
- /** This filter is documented in wp-includes/ms-functions.php */
- if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) ) {
- return false;
- }
-
- return wp_update_user_counts( $network_id );
-}
-
-/**
- * Updates the total count of users on the site.
- *
- * @global wpdb $wpdb WordPress database abstraction object.
- * @since 6.0.0
- *
- * @param int|null $network_id ID of the network. Default is the current network.
- * @return bool Whether the update was successful.
- */
-function wp_update_user_counts( $network_id = null ) {
- global $wpdb;
-
- if ( ! is_multisite() && null !== $network_id ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: %s: $network_id */
- __( 'Unable to pass %s if not using multisite.' ),
- '<code>$network_id</code>'
- ),
- '6.0.0'
- );
- }
-
- $query = "SELECT COUNT(ID) as c FROM $wpdb->users";
- if ( is_multisite() ) {
- $query .= " WHERE spam = '0' AND deleted = '0'";
- }
-
- $count = $wpdb->get_var( $query );
-
- return update_network_option( $network_id, 'user_count', $count );
-}
-
-/**
- * Schedules a recurring recalculation of the total count of users.
- *
- * @since 6.0.0
- */
-function wp_schedule_update_user_counts() {
- if ( ! is_main_site() ) {
- return;
- }
-
- if ( ! wp_next_scheduled( 'wp_update_user_counts' ) && ! wp_installing() ) {
- wp_schedule_event( time(), 'twicedaily', 'wp_update_user_counts' );
- }
-}
-
-/**
- * Determines whether the site has a large number of users.
- *
- * The default criteria for a large site is more than 10,000 users.
- *
- * @since 6.0.0
- *
- * @param int|null $network_id ID of the network. Default is the current network.
- * @return bool Whether the site has a large number of users.
- */
-function wp_is_large_user_count( $network_id = null ) {
- if ( ! is_multisite() && null !== $network_id ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: %s: $network_id */
- __( 'Unable to pass %s if not using multisite.' ),
- '<code>$network_id</code>'
- ),
- '6.0.0'
- );
- }
-
- $count = get_user_count( $network_id );
-
- /**
- * Filters whether the site is considered large, based on its number of users.
- *
- * @since 6.0.0
- *
- * @param bool $is_large_user_count Whether the site has a large number of users.
- * @param int $count The total number of users.
- * @param int|null $network_id ID of the network. `null` represents the current network.
- */
- return apply_filters( 'wp_is_large_user_count', $count > 10000, $count, $network_id );
-}
</del></span></pre></div>
<a id="trunksrcwpincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2022-03-29 13:47:15 UTC (rev 53017)
+++ trunk/src/wp-includes/user.php 2022-03-29 13:51:52 UTC (rev 53018)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1305,6 +1305,150 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $result;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Returns the number of active users in your installation.
+ *
+ * Note that on a large site the count may be cached and only updated twice daily.
+ *
+ * @since MU (3.0.0)
+ * @since 4.8.0 The `$network_id` parameter has been added.
+ * @since 6.0.0 Moved to wp-includes/user.php.
+ *
+ * @param int|null $network_id ID of the network. Defaults to the current network.
+ * @return int Number of active users on the network.
+ */
+function get_user_count( $network_id = null ) {
+ if ( ! is_multisite() && null !== $network_id ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: $network_id */
+ __( 'Unable to pass %s if not using multisite.' ),
+ '<code>$network_id</code>'
+ ),
+ '6.0.0'
+ );
+ }
+
+ return (int) get_network_option( $network_id, 'user_count', -1 );
+}
+
+/**
+ * Updates the total count of users on the site if live user counting is enabled.
+ *
+ * @since 6.0.0
+ *
+ * @param int|null $network_id ID of the network. Defaults to the current network.
+ * @return bool Whether the update was successful.
+ */
+function wp_maybe_update_user_counts( $network_id = null ) {
+ if ( ! is_multisite() && null !== $network_id ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: $network_id */
+ __( 'Unable to pass %s if not using multisite.' ),
+ '<code>$network_id</code>'
+ ),
+ '6.0.0'
+ );
+ }
+
+ $is_small_network = ! wp_is_large_user_count( $network_id );
+ /** This filter is documented in wp-includes/ms-functions.php */
+ if ( ! apply_filters( 'enable_live_network_counts', $is_small_network, 'users' ) ) {
+ return false;
+ }
+
+ return wp_update_user_counts( $network_id );
+}
+
+/**
+ * Updates the total count of users on the site.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @since 6.0.0
+ *
+ * @param int|null $network_id ID of the network. Defaults to the current network.
+ * @return bool Whether the update was successful.
+ */
+function wp_update_user_counts( $network_id = null ) {
+ global $wpdb;
+
+ if ( ! is_multisite() && null !== $network_id ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: $network_id */
+ __( 'Unable to pass %s if not using multisite.' ),
+ '<code>$network_id</code>'
+ ),
+ '6.0.0'
+ );
+ }
+
+ $query = "SELECT COUNT(ID) as c FROM $wpdb->users";
+ if ( is_multisite() ) {
+ $query .= " WHERE spam = '0' AND deleted = '0'";
+ }
+
+ $count = $wpdb->get_var( $query );
+
+ return update_network_option( $network_id, 'user_count', $count );
+}
+
+/**
+ * Schedules a recurring recalculation of the total count of users.
+ *
+ * @since 6.0.0
+ */
+function wp_schedule_update_user_counts() {
+ if ( ! is_main_site() ) {
+ return;
+ }
+
+ if ( ! wp_next_scheduled( 'wp_update_user_counts' ) && ! wp_installing() ) {
+ wp_schedule_event( time(), 'twicedaily', 'wp_update_user_counts' );
+ }
+}
+
+/**
+ * Determines whether the site has a large number of users.
+ *
+ * The default criteria for a large site is more than 10,000 users.
+ *
+ * @since 6.0.0
+ *
+ * @param int|null $network_id ID of the network. Defaults to the current network.
+ * @return bool Whether the site has a large number of users.
+ */
+function wp_is_large_user_count( $network_id = null ) {
+ if ( ! is_multisite() && null !== $network_id ) {
+ _doing_it_wrong(
+ __FUNCTION__,
+ sprintf(
+ /* translators: %s: $network_id */
+ __( 'Unable to pass %s if not using multisite.' ),
+ '<code>$network_id</code>'
+ ),
+ '6.0.0'
+ );
+ }
+
+ $count = get_user_count( $network_id );
+
+ /**
+ * Filters whether the site is considered large, based on its number of users.
+ *
+ * @since 6.0.0
+ *
+ * @param bool $is_large_user_count Whether the site has a large number of users.
+ * @param int $count The total number of users.
+ * @param int|null $network_id ID of the network. `null` represents the current network.
+ */
+ return apply_filters( 'wp_is_large_user_count', $count > 10000, $count, $network_id );
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> //
</span><span class="cx" style="display: block; padding: 0 10px"> // Private helper functions.
</span><span class="cx" style="display: block; padding: 0 10px"> //
</span></span></pre>
</div>
</div>
</body>
</html>