Changeset 57013 for trunk/tests/phpunit/tests/option/wpPrimeOptionCachesByGroup.php

Timestamp:

10/26/2023 10:54:15 PM (14 months ago)

Author:

peterwilsoncc

Message:

Options, Meta APIs: Rename option cache priming functions.

Rename the option cache priming functions to more closely follow the naming convention used by other cache priming functions.

• wp_load_options() becomes wp_prime_option_caches()
• wp_load_options_by_group() becomes wp_prime_option_caches_by_group()

The unit test files and classes are renamed accordingly.

Unlike the existing cache priming functions, these functions were introduced with the intention of being public so use the wp_ prefix rather than the _ prefix used by the functions initially introduced as private functions but since made public.

Follow up to [56445],[56990].

Props flixos90, peterwilsoncc, joemcgill, SergeyBiryukov, desrosj.
Fixes #58962.

File:

• trunk/tests/phpunit/tests/option/wpPrimeOptionCachesByGroup.php (moved) (moved from trunk/tests/phpunit/tests/option/wpLoadOptionsByGroup.php) (5 diffs)

trunk/tests/phpunit/tests/option/wpPrimeOptionCachesByGroup.php

@@ -1 +1 @@
 <?php
 /**
- * Test wp_load_options_by_group().
+ * Test wp_prime_option_caches_by_group().
  *
  * @group option
  *
- * @covers ::wp_load_options_by_group
+ * @covers ::wp_prime_option_caches_by_group
  */
-class Tests_Option_PrimeOptionsByGroup extends WP_UnitTestCase {
+class Tests_Option_WpPrimeOptionCachesByGroup extends WP_UnitTestCase {
 
     /**
-     * Tests that wp_load_options_by_group() only loads options in the specified group.
+     * Tests that wp_prime_option_caches_by_group() only primes options in the specified group.
      *
      * @ticket 58962
      */
-    public function test_wp_load_options_by_group() {
+    public function test_wp_prime_option_caches_by_group() {
         global $new_allowed_options;
 
-        // Create some options to load.
+        // Create some options to prime.
         $new_allowed_options = array(
             'group1' => array(
@@ -28 +28 @@
         );
 
-        $options_to_load = array(
+        $options_to_prime = array(
             'option1',
             'option2',
@@ -39 +39 @@
          * check options are not in cache initially.
          */
-        foreach ( $options_to_load as $option ) {
+        foreach ( $options_to_prime as $option ) {
             update_option( $option, "value_$option", false );
             wp_cache_delete( $option, 'options' );
@@ -45 +45 @@
         }
 
-        // Call the wp_load_options_by_group function to load the options.
-        wp_load_options_by_group( 'group1' );
+        // Call the wp_prime_option_caches_by_group function to prime the options.
+        wp_prime_option_caches_by_group( 'group1' );
 
         // Check that options are now in the cache.
-        $this->assertSame( get_option( 'option1' ), wp_cache_get( 'option1', 'options' ), 'option1 was not loaded.' );
-        $this->assertSame( get_option( 'option2' ), wp_cache_get( 'option2', 'options' ), 'option2 was not loaded.' );
+        $this->assertSame( get_option( 'option1' ), wp_cache_get( 'option1', 'options' ), 'option1\'s cache was not primed.' );
+        $this->assertSame( get_option( 'option2' ), wp_cache_get( 'option2', 'options' ), 'option2\'s cache was not primed.' );
 
         // Make sure option3 is still not in cache.
@@ -57 +57 @@
 
     /**
-     * Tests wp_load_options_by_group() with a nonexistent option group.
+     * Tests wp_prime_option_caches_by_group() with a nonexistent option group.
      *
      * @ticket 58962
      */
-    public function test_wp_load_options_by_group_with_nonexistent_group() {
+    public function test_wp_prime_option_caches_by_group_with_nonexistent_group() {
         // Make sure options are not in cache or database initially.
         $this->assertFalse( wp_cache_get( 'option1', 'options' ), 'option1 was not deleted from the cache.' );
         $this->assertFalse( wp_cache_get( 'option2', 'options' ), 'option2 was not deleted from the cache.' );
 
-        // Call the wp_load_options_by_group function with a nonexistent group.
-        wp_load_options_by_group( 'nonexistent_group' );
+        // Call the wp_prime_option_caches_by_group function with a nonexistent group.
+        wp_prime_option_caches_by_group( 'nonexistent_group' );
 
         // Check that options are still not in the cache or database.