Changeset 58182

Timestamp:

05/21/2024 09:36:43 PM (3 months ago)

Author:

spacedmonkey

Message:

Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.

WordPress's get_network_option function generally makes individual database requests for each network option. While some options are preloaded in wp_load_core_site_options, many still require single database calls to the network options table.

Building on the work done in [56445], [56990], and [57013], which introduced the wp_prime_option_caches function, this commit adds two new functions: wp_prime_network_option_caches and wp_prime_site_option_caches. These functions enable developers to pass an array of option names, allowing caches for these options to be primed in a single object cache or database request. If an option is not found, the notoptions cache key is refreshed, preventing unnecessary repeated requests.

The function wp_prime_site_option_caches is similar to get_site_option, enabling developers to retrieve network options on the current network without needing to know the current network ID. If these functions are called in a non-multisite environment, they fall back to using wp_prime_option_caches.

These functions have been implemented in wp_load_core_site_options, get_site_transient, and set_site_transient.

Props to spacedmonkey, peterwilsoncc, mukesh27, joemcgill.
Fixes #61053.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (3 diffs)
• tests/phpunit/tests/option/wpPrimeNetworkOptionCaches.php (added)

trunk/src/wp-includes/option.php

@@ -644 +644 @@
 
 /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
  * Loads and primes caches of certain often requested network options if is_multisite().
  *
  * @since 3.0.0
  * @since 6.3.0 Also prime caches for network options when persistent object cache is enabled.
- *
- * @global wpdb $wpdb WordPress database abstraction object.
+ * @since 6.6.0 Uses wp_prime_network_option_caches().
  *
  * @param int $network_id Optional. Network ID of network for which to prime network options cache. Defaults to current network.
  */
 function wp_load_core_site_options( $network_id = null ) {
-    global $wpdb;
-
     if ( ! is_multisite() || wp_installing() ) {
         return;
     }
-
-    if ( empty( $network_id ) ) {
-        $network_id = get_current_network_id();
-    }
-
-    $core_options = array( 'site_name', 'siteurl', 'active_sitewide_plugins', '_site_transient_timeout_theme_roots', '_site_transient_theme_roots', 'site_admins', 'can_compress_scripts', 'global_terms_enabled', 'ms_files_rewriting' );
-
-    if ( wp_using_ext_object_cache() ) {
-        $cache_keys = array();
-        foreach ( $core_options as $option ) {
-            $cache_keys[] = "{$network_id}:{$option}";
-        }
-        wp_cache_get_multiple( $cache_keys, 'site-options' );
-
-        return;
-    }
-
-    $core_options_in = "'" . implode( "', '", $core_options ) . "'";
-    $options         = $wpdb->get_results( $wpdb->prepare( "SELECT meta_key, meta_value FROM $wpdb->sitemeta WHERE meta_key IN ($core_options_in) AND site_id = %d", $network_id ) );
-
-    $data = array();
-    foreach ( $options as $option ) {
-        $key                = $option->meta_key;
-        $cache_key          = "{$network_id}:$key";
-        $option->meta_value = maybe_unserialize( $option->meta_value );
-
-        $data[ $cache_key ] = $option->meta_value;
-    }
-    wp_cache_set_multiple( $data, 'site-options' );
+    $core_options = array( 'site_name', 'siteurl', 'active_sitewide_plugins', '_site_transient_timeout_theme_roots', '_site_transient_theme_roots', 'site_admins', 'can_compress_scripts', 'global_terms_enabled', 'ms_files_rewriting', 'WPLANG' );
+
+    wp_prime_network_option_caches( $network_id, $core_options );
 }
 
@@ -2416 +2516 @@
         if ( ! in_array( $transient, $no_timeout, true ) ) {
             $transient_timeout = '_site_transient_timeout_' . $transient;
-            $timeout           = get_site_option( $transient_timeout );
+            wp_prime_site_option_caches( array( $transient_option, $transient_timeout ) );
+
+            $timeout = get_site_option( $transient_timeout );
             if ( false !== $timeout && $timeout < time() ) {
                 delete_site_option( $transient_option );
@@ -2494 +2596 @@
         $transient_timeout = '_site_transient_timeout_' . $transient;
         $option            = '_site_transient_' . $transient;
+
 
         if ( false === get_site_option( $option ) ) {