wppaste
WordPress

wp_should_upgrade_global_tables(): bool

Since
4.3.0
Source
wp-admin/includes/upgrade.php:3816
Determine if global tables should be upgraded.

Description

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.

Return

bool
Whether to run the upgrade routines on global tables.

Hooks fired · 1

One hook fires while wp_should_upgrade_global_tables() runs, in this order:

  1. apply_filters( wp_should_upgrade_global_tables )filterline 3843 (+27 into the body)

    Filters if upgrade routines should be run on global tables.

Uses · 3

  • is_main_network()Determines whether a network is the main network of the Multisite installation.
  • is_main_site()Determines whether a site is the main site of the current network.
  • apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 8

Source

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;	} 	/**	 * Filters if upgrade routines should be run on global tables.	 *	 * @since 4.3.0	 *	 * @param bool $should_upgrade Whether to run the upgrade routines on global tables.	 */	return apply_filters( 'wp_should_upgrade_global_tables', $should_upgrade );}

History

Introduced in 4.3.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/upgrade.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.