<!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>[33057] trunk/src/wp-admin/includes/upgrade.php: Introduce `wp_should_upgrade_global_tables()` to determine if global tables should be upgraded automatically.</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/33057">33057</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/33057","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-07-03 04:33:14 +0000 (Fri, 03 Jul 2015)</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'>Introduce `wp_should_upgrade_global_tables()` to determine if global tables should be upgraded automatically. Use it throughout the existing upgrade routines.
Props johnjamesjacoby for initial patch
Fixes <a href="https://core.trac.wordpress.org/ticket/32154">#32154</a> for trunk</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesupgradephp">trunk/src/wp-admin/includes/upgrade.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesupgradephp"></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/upgrade.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/upgrade.php 2015-07-03 03:28:15 UTC (rev 33056)
+++ trunk/src/wp-admin/includes/upgrade.php 2015-07-03 04:33:14 UTC (rev 33057)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1252,7 +1252,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_site_option( 'siteurl', '' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // 3.0 screen options key name changes.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_main_site() && !defined('DO_NOT_UPGRADE_GLOBAL_TABLES') ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $sql = "DELETE FROM $wpdb->usermeta
</span><span class="cx" style="display: block; padding: 0 10px"> WHERE meta_key LIKE %s
</span><span class="cx" style="display: block; padding: 0 10px"> OR meta_key LIKE %s
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1292,7 +1292,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function upgrade_330() {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_current_db_version, $wpdb, $wp_registered_widgets, $sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $wp_current_db_version < 19061 && is_main_site() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wp_current_db_version < 19061 && wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( "DELETE FROM $wpdb->usermeta WHERE meta_key IN ('show_admin_bar_admin', 'plugins_last_view')" );
</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">@@ -1376,7 +1376,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->show_errors();
</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">- if ( $wp_current_db_version < 20022 && is_main_site() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wp_current_db_version < 20022 && wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( "DELETE FROM $wpdb->usermeta WHERE meta_key = 'themes_last_view'" );
</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">@@ -1403,7 +1403,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_current_db_version < 22006 && $wpdb->get_var( "SELECT link_id FROM $wpdb->links LIMIT 1" ) )
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'link_manager_enabled', 1 ); // Previously set to 0 by populate_options()
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $wp_current_db_version < 21811 && is_main_site() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wp_current_db_version < 21811 && wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $meta_keys = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( array_merge( get_post_types(), get_taxonomies() ) as $name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== strpos( $name, '-' ) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1673,7 +1673,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // 4.2
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_current_db_version < 31351 && $wpdb->charset === 'utf8mb4' ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) && DO_NOT_UPGRADE_GLOBAL_TABLES ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( "ALTER TABLE $wpdb->usermeta DROP INDEX meta_key, ADD INDEX meta_key(meta_key(191))" );
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( "ALTER TABLE $wpdb->site DROP INDEX domain, ADD INDEX domain(domain(140),path(51))" );
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( "ALTER TABLE $wpdb->sitemeta DROP INDEX meta_key, ADD INDEX meta_key(meta_key(191))" );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1689,7 +1689,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // 4.3
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_current_db_version < 33055 && 'utf8mb4' === $wpdb->charset ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) && DO_NOT_UPGRADE_GLOBAL_TABLES ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $upgrade = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $indexes = $wpdb->get_results( "SHOW INDEXES FROM $wpdb->signups" );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach( $indexes as $index ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2098,8 +2098,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $global_tables = $wpdb->tables( 'global' );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $cqueries as $table => $qry ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Upgrade global tables only for the main site. Don't upgrade at all if DO_NOT_UPGRADE_GLOBAL_TABLES is defined.
- if ( in_array( $table, $global_tables ) && ( !is_main_site() || defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Upgrade global tables only for the main site. Don't upgrade at all if conditions are not optimal.
+ if ( in_array( $table, $global_tables ) && ! wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> unset( $cqueries[ $table ], $for_update[ $table ] );
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2616,7 +2616,7 @@
</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"> // Multisite schema upgrades.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $wp_current_db_version < 25448 && is_multisite() && ! defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) && is_main_network() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wp_current_db_version < 25448 && is_multisite() && wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Upgrade verions prior to 3.7
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_current_db_version < 25179 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2634,7 +2634,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Upgrade versions prior to 4.2.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $wp_current_db_version < 31351 ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! is_multisite() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_should_upgrade_global_tables() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( "ALTER TABLE $wpdb->usermeta DROP INDEX meta_key, ADD INDEX meta_key(meta_key(191))" );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $wpdb->query( "ALTER TABLE $wpdb->terms DROP INDEX slug, ADD INDEX slug(slug(191))" );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2671,3 +2671,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> dbDelta( $ms_queries );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> endif;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Determine if global tables should be upgraded.
+ *
+ * This function performs a series of checks to ensure the environment allows
+ * for the safe upgrading of global WordPress database tables. It is necessary
+ * because global tables will commonly grow to millions of rows on large
+ * installations, and the ability to control their upgrade routines can be
+ * critical to the operation of large networks.
+ *
+ * In a future iteration, this function may use `wp_is_large_network()` to more-
+ * intelligently prevent global table upgrades. Until then, we make sure
+ * WordPress is on the main site of the main network, to avoid running queries
+ * more than once in multi-site or multi-network environments.
+ *
+ * @since 4.3.0
+ *
+ * @return bool Whether to run the upgrade routines on global tables.
+ */
+function wp_should_upgrade_global_tables() {
+
+ // Return false early if explicitly not upgrading
+ if ( defined( 'DO_NOT_UPGRADE_GLOBAL_TABLES' ) ) {
+ return false;
+ }
+
+ // Assume global tables should be upgraded
+ $should_upgrade = true;
+
+ // Set to false if not on main network (does not matter if not multi-network)
+ if ( ! is_main_network() ) {
+ $should_upgrade = false;
+ }
+
+ // Set to false if not on main site of current network (does not matter if not multi-site)
+ if ( ! is_main_site() ) {
+ $should_upgrade = false;
+ }
+
+ /**
+ * Filter if upgrade routines should be run on global tables in multisite.
+ *
+ * @param bool $should_upgrade Whether to run the upgrade routines on global tables.
+ */
+ return apply_filters( 'wp_should_upgrade_global_tables', $should_upgrade );
+}
</ins></span></pre>
</div>
</div>
</body>
</html>