<!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>[41627] trunk: Options: Add new `alloptions` and `pre_cache_alloptions` filters.</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 { 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/41627">41627</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/41627","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-09-28 00:22:48 +0000 (Thu, 28 Sep 2017)</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: 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 <a href="https://core.trac.wordpress.org/ticket/33958">#33958</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="#trunktestsphpunittestsoptionwpLoadAllOptionsphp">trunk/tests/phpunit/tests/option/wpLoadAllOptions.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 2017-09-27 22:24:37 UTC (rev 41626)
+++ trunk/src/wp-includes/option.php 2017-09-28 00:22:48 UTC (rev 41627)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,25 +186,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_load_alloptions() {
</span><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 ( ! wp_installing() || ! is_multisite() )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! wp_installing() || ! is_multisite() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $alloptions = wp_cache_get( 'alloptions', 'options' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- else
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } else {
</ins><span class="cx" style="display: block; padding: 0 10px"> $alloptions = false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</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 ( !$alloptions ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $alloptions ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $suppress = $wpdb->suppress_errors();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( !$alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'" ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options WHERE autoload = 'yes'" ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $alloptions_db = $wpdb->get_results( "SELECT option_name, option_value FROM $wpdb->options" );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $wpdb->suppress_errors($suppress);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
+ $wpdb->suppress_errors( $suppress );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $alloptions = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( (array) $alloptions_db as $o ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $alloptions[$o->option_name] = $o->option_value;
</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 ( ! wp_installing() || ! is_multisite() )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ 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 );
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_cache_add( 'alloptions', $alloptions, 'options' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><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">- return $alloptions;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters all options after retrieving them.
+ *
+ * @since 4.9.0
+ *
+ * @param array $alloptions Array with all options.
+ */
+ return apply_filters( 'alloptions', $alloptions );
</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></span></pre></div>
<a id="trunktestsphpunittestsoptionwpLoadAllOptionsphp"></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/wpLoadAllOptions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/option/wpLoadAllOptions.php (rev 0)
+++ trunk/tests/phpunit/tests/option/wpLoadAllOptions.php 2017-09-28 00:22:48 UTC (rev 41627)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,109 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Test wp_load_alloptions().
+ *
+ * @group option
+ */
+class Tests_Option_WP_Load_Alloptions extends WP_UnitTestCase {
+ protected $alloptions = null;
+
+ function tearDown() {
+ $this->alloptions = null;
+ parent::tearDown();
+ }
+
+ function test_if_alloptions_is_cached() {
+ $this->assertNotEmpty( wp_cache_get( 'alloptions', 'options' ) );
+ }
+
+ /**
+ * @depends test_if_alloptions_is_cached
+ */
+ function test_if_cached_alloptions_is_deleted() {
+ $this->assertTrue( wp_cache_delete( 'alloptions', 'options' ) );
+ }
+
+ /**
+ * @depends test_if_alloptions_is_cached
+ */
+ function test_if_alloptions_are_retrieved_from_cache() {
+ global $wpdb;
+ $before = $wpdb->num_queries;
+ wp_load_alloptions();
+ $after = $wpdb->num_queries;
+
+ // Database has not been hit.
+ $this->assertEquals( $before, $after );
+ }
+
+ /**
+ * @depends test_if_cached_alloptions_is_deleted
+ */
+ function test_if_alloptions_are_retrieved_from_database() {
+ global $wpdb;
+
+ // Delete the existing cache first.
+ wp_cache_delete( 'alloptions', 'options' );
+
+ $before = $wpdb->num_queries;
+ wp_load_alloptions();
+ $after = $wpdb->num_queries;
+
+ // Database has been hit.
+ $this->assertEquals( $before + 1, $after );
+ }
+
+ /**
+ * @depends test_if_cached_alloptions_is_deleted
+ */
+ function test_filter_pre_cache_alloptions_is_called() {
+ $temp = wp_installing();
+
+ /**
+ * Set wp_installing() to false.
+ *
+ * If wp_installing is false and the cache is empty, the filter is called regardless if it's multisite or not.
+ */
+ wp_installing( false );
+
+ // Delete the existing cache first.
+ wp_cache_delete( 'alloptions', 'options' );
+
+ add_filter( 'pre_cache_alloptions', array( $this, 'return_pre_cache_filter' ) );
+ $all_options = wp_load_alloptions();
+
+ // Value could leak to other tests if not reset.
+ wp_installing( $temp );
+
+ // Filter was called.
+ $this->assertEquals( $this->alloptions, $all_options );
+ }
+
+ /**
+ * @depends test_if_alloptions_is_cached
+ */
+ function test_filter_pre_cache_alloptions_is_not_called() {
+ $temp = wp_installing();
+
+ /**
+ * Set wp_installing() to true.
+ *
+ * If wp_installing is true and it's multisite, the cache and filter are not used.
+ * If wp_installing is true and it's not multisite, the cache is used (if not empty), and the filter not.
+ */
+ wp_installing( true );
+
+ add_filter( 'pre_cache_alloptions', array( $this, 'return_pre_cache_filter' ) );
+ wp_load_alloptions();
+
+ // Value could leak to other tests if not reset.
+ wp_installing( $temp );
+
+ // Filter was not called.
+ $this->assertNull( $this->alloptions );
+ }
+
+ function return_pre_cache_filter( $alloptions ) {
+ return $this->alloptions = $alloptions;
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>