<!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>[58182] trunk: Options, Meta APIs: Introduce wp_prime_network_option_caches() to load multiple network options with a single database request.</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/58182">58182</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/58182","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-05-21 21:36:43 +0000 (Tue, 21 May 2024)</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'>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 <a href="https://core.trac.wordpress.org/changeset/56445">[56445]</a>, <a href="https://core.trac.wordpress.org/changeset/56990">[56990]</a>, and <a href="https://core.trac.wordpress.org/changeset/57013">[57013]</a>, 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 <a href="https://core.trac.wordpress.org/ticket/61053">#61053</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesoptionphp">trunk/src/wp-includes/option.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsoptionwpPrimeNetworkOptionCachesphp">trunk/tests/phpunit/tests/option/wpPrimeNetworkOptionCaches.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesoptionphp"></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/option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/option.php 2024-05-21 10:31:51 UTC (rev 58181)
+++ trunk/src/wp-includes/option.php 2024-05-21 21:36:43 UTC (rev 58182)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -643,53 +643,153 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Loads and primes caches of certain often requested network options if is_multisite().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Primes specific network options for the current network into the cache with a single database query.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 3.0.0
- * @since 6.3.0 Also prime caches for network options when persistent object cache is enabled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Only network options that do not already exist in cache will be loaded.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If site is not multisite, then call wp_prime_option_caches().
+ *
+ * @since 6.6.0
+ *
+ * @see wp_prime_network_option_caches()
+ *
+ * @param string[] $options An array of option names to be loaded.
+ */
+function wp_prime_site_option_caches( array $options ) {
+ wp_prime_network_option_caches( null, $options );
+}
+
+/**
+ * Primes specific network options into the cache with a single database query.
+ *
+ * Only network options that do not already exist in cache will be loaded.
+ *
+ * If site is not multisite, then call wp_prime_option_caches().
+ *
+ * @since 6.6.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $network_id Optional. Network ID of network for which to prime network options cache. Defaults to current network.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $network_id ID of the network. Can be null to default to the current network ID.
+ * @param string[] $options An array of option names to be loaded.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_load_core_site_options( $network_id = null ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_prime_network_option_caches( $network_id, array $options ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</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 ( ! is_multisite() || wp_installing() ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( wp_installing() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</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 ( empty( $network_id ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_multisite() ) {
+ wp_prime_option_caches( $options );
+ return;
+ }
+
+ if ( $network_id && ! is_numeric( $network_id ) ) {
+ return;
+ }
+
+ $network_id = (int) $network_id;
+
+ // Fallback to the current network if a network ID is not specified.
+ if ( ! $network_id ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $network_id = get_current_network_id();
</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">- $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' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cache_keys = array();
+ foreach ( $options as $option ) {
+ $cache_keys[ $option ] = "{$network_id}:{$option}";
+ }
</ins><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_using_ext_object_cache() ) {
- $cache_keys = array();
- foreach ( $core_options as $option ) {
- $cache_keys[] = "{$network_id}:{$option}";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cache_group = 'site-options';
+ $cached_options = wp_cache_get_multiple( array_values( $cache_keys ), $cache_group );
+
+ $notoptions_key = "$network_id:notoptions";
+ $notoptions = wp_cache_get( $notoptions_key, $cache_group );
+
+ if ( ! is_array( $notoptions ) ) {
+ $notoptions = array();
+ }
+
+ // Filter options that are not in the cache.
+ $options_to_prime = array();
+ foreach ( $cache_keys as $option => $cache_key ) {
+ if (
+ ( ! isset( $cached_options[ $cache_key ] ) || false === $cached_options[ $cache_key ] )
+ && ! isset( $notoptions[ $option ] )
+ ) {
+ $options_to_prime[] = $option;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_get_multiple( $cache_keys, 'site-options' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bail early if there are no options to be loaded.
+ if ( empty( $options_to_prime ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</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">- $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 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query_args = $options_to_prime;
+ $query_args[] = $network_id;
+ $results = $wpdb->get_results(
+ $wpdb->prepare(
+ sprintf(
+ "SELECT meta_key, meta_value FROM $wpdb->sitemeta WHERE meta_key IN (%s) AND site_id = %s",
+ implode( ',', array_fill( 0, count( $options_to_prime ), '%s' ) ),
+ '%d'
+ ),
+ $query_args
+ )
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = array();
- foreach ( $options as $option ) {
- $key = $option->meta_key;
- $cache_key = "{$network_id}:$key";
- $option->meta_value = maybe_unserialize( $option->meta_value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data = array();
+ $options_found = array();
+ foreach ( $results as $result ) {
+ $key = $result->meta_key;
+ $cache_key = $cache_keys[ $key ];
+ $data[ $cache_key ] = maybe_unserialize( $result->meta_value );
+ $options_found[] = $key;
+ }
+ wp_cache_set_multiple( $data, $cache_group );
+ // If all options were found, no need to update `notoptions` cache.
+ if ( count( $options_found ) === count( $options_to_prime ) ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data[ $cache_key ] = $option->meta_value;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $options_not_found = array_diff( $options_to_prime, $options_found );
+
+ // Add the options that were not found to the cache.
+ $update_notoptions = false;
+ foreach ( $options_not_found as $option_name ) {
+ if ( ! isset( $notoptions[ $option_name ] ) ) {
+ $notoptions[ $option_name ] = true;
+ $update_notoptions = true;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_cache_set_multiple( $data, 'site-options' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Only update the cache if it was modified.
+ if ( $update_notoptions ) {
+ wp_cache_set( $notoptions_key, $notoptions, $cache_group );
+ }
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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.
+ * @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 ) {
+ if ( ! is_multisite() || wp_installing() ) {
+ return;
+ }
+ $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 );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Updates the value of an option that was already added.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * You do not need to serialize values. If the value needs to be serialized,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2415,7 +2515,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $transient_option = '_site_transient_' . $transient;
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $transient, $no_timeout, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $transient_timeout = '_site_transient_timeout_' . $transient;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timeout = get_site_option( $transient_timeout );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_prime_site_option_caches( array( $transient_option, $transient_timeout ) );
+
+ $timeout = get_site_option( $transient_timeout );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $timeout && $timeout < time() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> delete_site_option( $transient_option );
</span><span class="cx" style="display: block; padding: 0 10px"> delete_site_option( $transient_timeout );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2493,6 +2595,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $transient_timeout = '_site_transient_timeout_' . $transient;
</span><span class="cx" style="display: block; padding: 0 10px"> $option = '_site_transient_' . $transient;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_prime_site_option_caches( array( $option, $transient_timeout ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === get_site_option( $option ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $expiration ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsoptionwpPrimeNetworkOptionCachesphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/option/wpPrimeNetworkOptionCaches.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/option/wpPrimeNetworkOptionCaches.php (rev 0)
+++ trunk/tests/phpunit/tests/option/wpPrimeNetworkOptionCaches.php 2024-05-21 21:36:43 UTC (rev 58182)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,302 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test wp_prime_network_option_caches().
+ *
+ * @group option
+ *
+ * @covers ::wp_prime_network_option_caches
+ */
+class Tests_Option_WpPrimeNetworkOptionCaches extends WP_UnitTestCase {
+
+ /**
+ * @var int|WP_Error
+ */
+ private static $different_network_id;
+
+ public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
+ if ( is_multisite() ) {
+ self::$different_network_id = $factory->network->create(
+ array(
+ 'domain' => 'wordpress.org',
+ 'path' => '/',
+ )
+ );
+ }
+ }
+
+ /**
+ * Tests that wp_prime_network_option_caches() primes multiple options.
+ *
+ * @ticket 61053
+ */
+ public function test_wp_prime_network_option_caches() {
+ // Create some options to prime.
+ $network_id = get_current_network_id();
+ if ( is_multisite() ) {
+ $cache_group = 'site-options';
+ } else {
+ $cache_group = 'options';
+ }
+
+ // Create some options to prime.
+ $options_to_prime = array(
+ 'option1',
+ 'option2',
+ 'option3',
+ );
+
+ $cache_keys = array();
+ foreach ( $options_to_prime as $option ) {
+ if ( is_multisite() ) {
+ $cache_key = "$network_id:$option";
+ } else {
+ $cache_key = $option;
+ }
+ $cache_keys[ $option ] = $cache_key;
+ }
+
+ /*
+ * Set values for the options,
+ * clear the cache for the options,
+ * check options are not in cache initially.
+ */
+ foreach ( $cache_keys as $option => $cache_key ) {
+ update_network_option( $network_id, $option, "value_$option" );
+ wp_cache_delete( $cache_key, $cache_group );
+ $this->assertFalse( wp_cache_get( $cache_key, $cache_group ), "$option was not deleted from the cache." );
+ }
+
+ // Call the wp_prime_network_option_caches() function to prime the options.
+ wp_prime_network_option_caches( $network_id, $options_to_prime );
+
+ // Store the initial database query count.
+ $initial_query_count = get_num_queries();
+
+ // Check that options are only in the 'options' or 'site-options' cache group.
+ foreach ( $cache_keys as $option => $cache_key ) {
+ $this->assertSame( "value_$option", wp_cache_get( $cache_key, $cache_group ), "$option cache is not primed" );
+ $this->assertSame(
+ "value_$option",
+ get_network_option( $network_id, $option ),
+ "$option has not been loaded"
+ );
+ }
+
+ // Ensure no additional database queries were made.
+ $this->assertSame(
+ $initial_query_count,
+ get_num_queries(),
+ 'Additional database queries were made.'
+ );
+ }
+
+ /**
+ * Tests that running wp_prime_network_option_caches() twice does not requery options.
+ *
+ * @ticket 61053
+ */
+ public function test_wp_prime_network_option_caches_run_twice() {
+ // Create some options to prime.
+ $network_id = get_current_network_id();
+ if ( is_multisite() ) {
+ $cache_group = 'site-options';
+ } else {
+ $cache_group = 'options';
+ }
+
+ // Create some options to prime.
+ $options_to_prime = array(
+ 'option1',
+ 'option2',
+ 'option3',
+ );
+
+ $cache_keys = array();
+ foreach ( $options_to_prime as $option ) {
+ if ( is_multisite() ) {
+ $cache_key = "$network_id:$option";
+ } else {
+ $cache_key = $option;
+ }
+ $cache_keys[ $option ] = $cache_key;
+ }
+
+ /*
+ * Set values for the options,
+ * clear the cache for the options,
+ * check options are not in cache initially.
+ */
+ foreach ( $cache_keys as $option => $cache_key ) {
+ update_network_option( $network_id, $option, "value_$option" );
+ wp_cache_delete( $cache_key, $cache_group );
+ $this->assertFalse( wp_cache_get( $cache_key, $cache_group ), "$option was not deleted from the cache." );
+ }
+
+ // Call the wp_prime_network_option_caches() function to prime the options.
+ wp_prime_network_option_caches( $network_id, $options_to_prime );
+
+ // Store the initial database query count.
+ $initial_query_count = get_num_queries();
+
+ // Call the wp_prime_network_option_caches() function second time
+ wp_prime_network_option_caches( $network_id, $options_to_prime );
+
+ // Ensure no additional database queries were made.
+ $this->assertSame(
+ $initial_query_count,
+ get_num_queries(),
+ 'Additional database queries were made.'
+ );
+ }
+
+ /**
+ * Tests that wp_prime_network_option_caches() handles a mix of primed and unprimed options.
+ *
+ * @ticket 61053
+ */
+ public function test_wp_prime_network_option_caches_handles_a_mix_of_primed_and_unprimed_options() {
+ // Create some options to prime.
+ $options_to_prime = array(
+ 'option1',
+ 'option2',
+ 'option3',
+ );
+
+ $network_id = get_current_network_id();
+ if ( is_multisite() ) {
+ $cache_group = 'site-options';
+ } else {
+ $cache_group = 'options';
+ }
+
+ $cache_keys = array();
+ foreach ( $options_to_prime as $option ) {
+ if ( is_multisite() ) {
+ $cache_key = "$network_id:$option";
+ } else {
+ $cache_key = $option;
+ }
+ $cache_keys[ $option ] = $cache_key;
+ }
+
+ /*
+ * Set values for the options,
+ * clear the cache for the options,
+ * check options are not in cache initially.
+ */
+ foreach ( $cache_keys as $option => $cache_key ) {
+ update_network_option( $network_id, $option, "value_$option" );
+ wp_cache_delete( $cache_key, $cache_group );
+ $this->assertFalse( wp_cache_get( $cache_key, $cache_group ), "$option was not deleted from the cache." );
+ }
+
+ // Add non-existent option to the options to prime.
+ $options_to_prime[] = 'option404notfound';
+
+ // Prime the first option with a non-existent option.
+ wp_prime_network_option_caches( $network_id, $options_to_prime );
+
+ array_pop( $options_to_prime );
+
+ // Store the initial database query count.
+ $initial_query_count = get_num_queries();
+
+ // Check that options are only in the 'options' or 'site-options' cache group.
+ foreach ( $cache_keys as $option => $cache_key ) {
+ $this->assertSame( "value_$option", wp_cache_get( $cache_key, $cache_group ), "$option cache is not primed" );
+ $this->assertSame(
+ "value_$option",
+ get_network_option( $network_id, $option ),
+ "$option has not been loaded"
+ );
+ }
+
+ $this->assertFalse( get_network_option( $network_id, 'option404notfound' ), 'option404notfound should return false as option does not exist' );
+
+ // Ensure no additional database queries were made.
+ $this->assertSame(
+ $initial_query_count,
+ get_num_queries(),
+ 'Additional database queries were made.'
+ );
+ }
+
+ /**
+ * Test prime options on a different network.
+ *
+ * @group ms-required
+ *
+ * @ticket 61053
+ */
+ public function test_wp_prime_network_option_caches_no_exists_cache() {
+ $options_to_prime = array(
+ 'option1',
+ 'option2',
+ 'option3',
+ );
+
+ // Call the wp_prime_network_option_caches() function to prime the options.
+ wp_prime_network_option_caches( self::$different_network_id, $options_to_prime );
+
+ $notoptions_key = self::$different_network_id . ':notoptions';
+ $expected = array_fill_keys( $options_to_prime, true );
+ $this->assertSame( $expected, wp_cache_get( $notoptions_key, 'site-options' ) );
+ }
+
+ /**
+ * Test prime options on a different network.
+ *
+ * @group ms-required
+ *
+ * @ticket 61053
+ */
+ public function test_wp_prime_network_option_caches_multiple_networks() {
+ $network_id = get_current_network_id();
+ $cache_group = 'site-options';
+
+ // Create some options to prime.
+ $options_to_prime = array(
+ 'option1',
+ 'option2',
+ 'option3',
+ );
+
+ $cache_keys = array();
+ foreach ( $options_to_prime as $option ) {
+ $cache_key = "$network_id:$option";
+ $cache_keys[ $option ] = $cache_key;
+ }
+
+ /*
+ * Set values for the options,
+ * clear the cache for the options,
+ * check options are not in cache initially.
+ */
+ foreach ( $cache_keys as $option => $cache_key ) {
+ update_network_option( $network_id, $option, "value_$option" );
+ wp_cache_delete( $cache_key, $cache_group );
+ $this->assertFalse( wp_cache_get( $cache_key, $cache_group ), "$option was not deleted from the cache." );
+ }
+
+ // Call the wp_prime_network_option_caches() function to prime the options.
+ wp_prime_network_option_caches( self::$different_network_id, $options_to_prime );
+
+ // Store the initial database query count.
+ $initial_query_count = get_num_queries();
+
+ foreach ( $cache_keys as $option => $cache_key ) {
+ $this->assertFalse( wp_cache_get( $cache_key, $cache_group ), "$option cache should be false" );
+ $this->assertFalse(
+ get_network_option( self::$different_network_id, $option ),
+ "$option has not been loaded"
+ );
+ }
+
+ // Ensure no additional database queries were made.
+ $this->assertSame(
+ $initial_query_count,
+ get_num_queries(),
+ 'Additional database queries were made.'
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/option/wpPrimeNetworkOptionCaches.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>