<!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>[60614] trunk: Upgrade/Install: Reduce number of DB queries populating roles.</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/60614">60614</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/60614","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-08-07 01:32:17 +0000 (Thu, 07 Aug 2025)</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'>Upgrade/Install: Reduce number of DB queries populating roles.
Reduces the number of database queries made when populating roles during install/multisite site creation by 344 (347 queries down to 3).
`populate_roles()` has been modified to prevent an individual database query each time a role or capability is added to the `WP_Roles` object. Instead the roles option, `{$wpdb->prefix}user_roles` is updated once at the end of the function call.
Introduces a test to ensure that updating the roles option via `WP_Roles` and updating the option in the manner now used by `populate_roles()` results in the same capabilities been applied to a role.
Props fliespl, johnjamesjacoby, ocean90, realloc, rishabhwp, sainathpoojary, sirlouen, spacedmonkey, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/37687">#37687</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesschemaphp">trunk/src/wp-admin/includes/schema.php</a></li>
<li><a href="#trunktestsphpunittestsusercapabilitiesphp">trunk/tests/phpunit/tests/user/capabilities.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesschemaphp"></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/includes/schema.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/schema.php 2025-08-06 22:35:39 UTC (rev 60613)
+++ trunk/src/wp-admin/includes/schema.php 2025-08-07 01:32:17 UTC (rev 60614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -713,6 +713,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function populate_roles() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_roles = wp_roles();
+
+ // Disable role updates to the database while populating roles.
+ $original_use_db = $wp_roles->use_db;
+ $wp_roles->use_db = false;
+
+ // Populate roles
</ins><span class="cx" style="display: block; padding: 0 10px"> populate_roles_160();
</span><span class="cx" style="display: block; padding: 0 10px"> populate_roles_210();
</span><span class="cx" style="display: block; padding: 0 10px"> populate_roles_230();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -721,6 +728,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> populate_roles_270();
</span><span class="cx" style="display: block; padding: 0 10px"> populate_roles_280();
</span><span class="cx" style="display: block; padding: 0 10px"> populate_roles_300();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Save the updated roles to the database.
+ if ( $original_use_db ) {
+ update_option( $wp_roles->role_key, $wp_roles->roles, true );
+ }
+
+ // Restore original value for writing to database.
+ $wp_roles->use_db = $original_use_db;
</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="trunktestsphpunittestsusercapabilitiesphp"></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/user/capabilities.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/capabilities.php 2025-08-06 22:35:39 UTC (rev 60613)
+++ trunk/tests/phpunit/tests/user/capabilities.php 2025-08-07 01:32:17 UTC (rev 60614)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2542,4 +2542,55 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensure that caps are updated correctly when using `update_option()` to save roles.
+ *
+ * Compares the efficiency and accuracy of updating role capabilities when `WP_Roles`
+ * uses the database vs when the updates are done via `update_option()`.
+ *
+ * This method of updating roles is used in `populate_roles()` to reduce the number of
+ * queries by approximately 300.
+ *
+ * @ticket 37687
+ */
+ public function test_role_capabilities_updated_correctly_via_update_option() {
+ global $wp_roles;
+ $emcee_role = 'emcee';
+ $wp_roles->add_role( $emcee_role, 'Emcee', array( 'level_1' => true ) );
+ $this->flush_roles();
+
+ $expected_caps = array(
+ 'level_1' => true,
+ 'attend_kit_kat_klub' => true,
+ 'win_tony_award' => true,
+ );
+
+ $start_queries = get_num_queries();
+ $wp_roles->add_cap( $emcee_role, 'attend_kit_kat_klub' );
+ $wp_roles->add_cap( $emcee_role, 'win_tony_award' );
+ $emcee_queries = get_num_queries() - $start_queries;
+ $this->flush_roles();
+ $emcee_caps = $wp_roles->get_role( $emcee_role )->capabilities;
+
+ $wp_roles->use_db = false;
+ $sally_role = 'sally';
+ $wp_roles->add_role( $sally_role, 'Sally Bowles', array( 'level_1' => true ) );
+ $start_queries = get_num_queries();
+ $wp_roles->add_cap( $sally_role, 'attend_kit_kat_klub' );
+ $wp_roles->add_cap( $sally_role, 'win_tony_award' );
+
+ update_option( $wp_roles->role_key, $wp_roles->roles, true );
+ $sally_queries = get_num_queries() - $start_queries;
+ $wp_roles->use_db = true;
+
+ // Restore the default value.
+ $this->flush_roles();
+ $sally_caps = $wp_roles->get_role( $sally_role )->capabilities;
+
+ $this->assertSameSetsWithIndex( $expected_caps, $emcee_caps, 'Emcee role should include the three expected capabilities.' );
+ $this->assertSameSetsWithIndex( $expected_caps, $sally_caps, 'Sally role should include the three expected capabilities.' );
+ $this->assertSameSetsWithIndex( $emcee_caps, $sally_caps, 'Emcee and Sally roles should have the same capabilities after update.' );
+ $this->assertLessThan( $emcee_queries, $sally_queries, 'Updating roles via update_option should be more efficient than WP_Roles using the database.' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>