Changeset 41627

Timestamp:

09/28/2017 12:22:48 AM (7 years ago)

Author:

pento

Message:

Options: Add new alloptions and pre_cache_alloptions filters.

pre_cache_alloptions is run before the alloptions array is inserted into the cache, and is valuable for sanity checking the options, particularly if your caching scheme has size limitations.

alloptions is run before returning the alloptions array, and is useful for when you have extra information that alloptions should return.

Props sebastian.pisula, keesiemeijer.
Fixes #33958.

Location:

trunk

Files:

• src/wp-includes/option.php (modified) (1 diff)
• tests/phpunit/tests/option/wpLoadAllOptions.php (added)

trunk/src/wp-includes/option.php

@@ -187 +187 @@
     global $wpdb;
 
-    if ( ! wp_installing() || ! is_multisite() )
+    if ( ! wp_installing() || ! is_multisite() ) {
         $alloptions = wp_cache_get( 'alloptions', 'options' );
-    else
+    } else {
         $alloptions = false;
-
-    if ( !$alloptions ) {
+    }
+
+    if ( ! $alloptions ) {
         $suppress = $wpdb->suppress_errors();
-        if ( !$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'" ) )
+        if ( ! $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'" ) ) {
             $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options" );
-        $wpdb->suppress_errors($suppress);
+        }
+        $wpdb->suppress_errors( $suppress );
+
         $alloptions = array();
         foreach ( (array) $alloptions_db as $o ) {
             $alloptions[$o->option_name] = $o->option_value;
         }
-        if ( ! wp_installing() || ! is_multisite() )
+
+        if ( ! wp_installing() || ! is_multisite() ) {
+            /**
+             * Filters all options before caching them.
+             *
+             * @since 4.9.0
+             *
+             * @param array $alloptions Array with all options.
+             */
+            $alloptions = apply_filters( 'pre_cache_alloptions', $alloptions );
             wp_cache_add( 'alloptions', $alloptions, 'options' );
-    }
-
-    return $alloptions;
+        }
+    }
+
+    /**
+     * Filters all options after retrieving them.
+     *
+     * @since 4.9.0
+     *
+     * @param array $alloptions Array with all options.
+     */
+    return apply_filters( 'alloptions', $alloptions );
 }