<!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>[38224] branches/4.6: Boostrap/Load: Improve forward compatiblity of plugin global backup methods.</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/38224">38224</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/38224","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>2016-08-09 01:50:21 +0000 (Tue, 09 Aug 2016)</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'>Boostrap/Load: Improve forward compatiblity of plugin global backup methods.
<a href="https://core.trac.wordpress.org/changeset/37588">[37588]</a> added methods to backup the plugin globals, for ensuring that advanced cache drop-ins don't overwrite hooks that've been added earlier in the load process.
The method for restoring the plugin globals wasn't compatible with the implementation of `WP_Hook` in <a href="https://core.trac.wordpress.org/ticket/17817">#17817</a>. `WP_Hook` implements `ArrayAccess`, so `_restore_plugin_globals()` was treating it as an array, and inadvertantly overwriting the `WP_Hook` object with a plain array.
To avoid having to re-write this code as part of <a href="https://core.trac.wordpress.org/ticket/17817">#17817</a>, we now use `add_filter()` to restore any hooks that were added by cache drop-ins, which `WP_Hook` correctly supports.
Merge of <a href="https://core.trac.wordpress.org/changeset/38223">[38223]</a> with the 4.6 branch.
Props pento, jorbin.
Fixes <a href="https://core.trac.wordpress.org/ticket/36819">#36819</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches46srcwpincludespluginphp">branches/4.6/src/wp-includes/plugin.php</a></li>
<li><a href="#branches46srcwpsettingsphp">branches/4.6/src/wp-settings.php</a></li>
<li><a href="#branches46testsphpunittestsactionsphp">branches/4.6/tests/phpunit/tests/actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="branches46srcwpincludespluginphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.6/src/wp-includes/plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.6/src/wp-includes/plugin.php 2016-08-09 01:44:20 UTC (rev 38223)
+++ branches/4.6/src/wp-includes/plugin.php 2016-08-09 01:50:21 UTC (rev 38224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1019,19 +1019,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array the staticvar from the first time it is set.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function _backup_plugin_globals(){
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function _backup_plugin_globals( $backup = true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> static $backup_globals = array();
</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( $backup_globals ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $backup ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $backup_globals = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'backup_wp_filter' => $wp_filter,
</span><span class="cx" style="display: block; padding: 0 10px"> 'backup_wp_actions' => $wp_actions,
</span><span class="cx" style="display: block; padding: 0 10px"> 'backup_merged_filters' => $merged_filters,
</span><span class="cx" style="display: block; padding: 0 10px"> 'backup_wp_current_filter' => $wp_current_filter,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- };
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $wp_filter = $wp_actions = array();
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> return $backup_globals;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1047,24 +1049,49 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @global array $wp_current_filter Stores the list of current filters with the current one last.
</span><span class="cx" style="display: block; padding: 0 10px"> * @staticvar array $backup_globals Backed up globals.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function _restore_plugin_globals(){
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function _restore_plugin_globals() {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $backup_globals = _backup_plugin_globals();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $backup_globals = _backup_plugin_globals( false );
</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_filter !== $backup_globals['backup_wp_filter'] ){
- $wp_filter = array_merge_recursive( $wp_filter, $backup_globals['backup_wp_filter'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $wp_filter ) ) {
+ $wp_filter = $backup_globals['backup_wp_filter'];
+ } else {
+ $added_filters = $wp_filter;
+ $wp_filter = $backup_globals['backup_wp_filter'];
+
+ foreach ( $added_filters as $tag => $callback_groups ) {
+ // Loop through callback groups.
+ foreach ( $callback_groups as $priority => $callbacks ) {
+
+ // Loop through callbacks.
+ foreach ( $callbacks as $cb ) {
+ add_filter( $tag, $cb['function'], $priority, $cb['accepted_args'] );
+ }
+ }
+ }
</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">- if ( $wp_actions !== $backup_globals['backup_wp_actions'] ){
- $wp_actions = array_merge_recursive( $wp_actions, $backup_globals['backup_wp_actions'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty ( $wp_actions ) ) {
+ $wp_actions = $backup_globals['backup_wp_actions'];
+ } else {
+ $run_actions = $wp_actions;
+ $wp_actions = $backup_globals['backup_wp_actions'];
+
+ foreach( $run_actions as $action => $count ) {
+ if ( ! isset( $wp_actions[ $action ] ) ) {
+ $wp_actions[ $action ] = 0;
+ }
+
+ $wp_actions[ $action ] += $count;
+ }
</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">- if ( $merged_filters !== $backup_globals['backup_merged_filters'] ){
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $merged_filters !== $backup_globals['backup_merged_filters'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $merged_filters = array_merge_recursive( $merged_filters, $backup_globals['backup_merged_filters'] );
</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 ( $wp_current_filter !== $backup_globals['backup_wp_current_filter'] ){
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $wp_current_filter !== $backup_globals['backup_wp_current_filter'] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $wp_current_filter = array_merge_recursive( $wp_current_filter, $backup_globals['backup_wp_current_filter'] );
</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="branches46srcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.6/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.6/src/wp-settings.php 2016-08-09 01:44:20 UTC (rev 38223)
+++ branches/4.6/src/wp-settings.php 2016-08-09 01:50:21 UTC (rev 38224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -83,7 +83,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( WP_CACHE && apply_filters( 'enable_loading_advanced_cache_dropin', true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // For an advanced caching plugin to use. Uses a static drop-in because you would only want one.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _backup_plugin_globals();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _backup_plugin_globals( true );
</ins><span class="cx" style="display: block; padding: 0 10px"> WP_DEBUG ? include( WP_CONTENT_DIR . '/advanced-cache.php' ) : @include( WP_CONTENT_DIR . '/advanced-cache.php' );
</span><span class="cx" style="display: block; padding: 0 10px"> _restore_plugin_globals();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="branches46testsphpunittestsactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.6/tests/phpunit/tests/actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.6/tests/phpunit/tests/actions.php 2016-08-09 01:44:20 UTC (rev 38223)
+++ branches/4.6/tests/phpunit/tests/actions.php 2016-08-09 01:50:21 UTC (rev 38224)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -332,7 +332,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 36819
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_backup_plugin_globals_returns_filters() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $backup = _backup_plugin_globals();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $backup = _backup_plugin_globals( true );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'backup_wp_filter', $backup );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'backup_wp_actions', $backup );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'backup_wp_current_filter', $backup );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -343,14 +343,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 36819
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_backup_plugin_globals_returns_filters_from_first_time_called() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $backup = _backup_plugin_globals();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $backup = _backup_plugin_globals( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $a = new MockAction();
</span><span class="cx" style="display: block; padding: 0 10px"> $tag = rand_str();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> add_action($tag, array(&$a, 'action'));
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $new_backup = _backup_plugin_globals();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $new_backup = _backup_plugin_globals( false );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $backup, $new_backup );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -361,7 +361,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_actions;
</span><span class="cx" style="display: block; padding: 0 10px"> $original_actions = $wp_actions;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _backup_plugin_globals();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ _backup_plugin_globals( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_actions = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -378,7 +378,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filter;
</span><span class="cx" style="display: block; padding: 0 10px"> $original_filter = $wp_filter;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $backup = _backup_plugin_globals();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $backup = _backup_plugin_globals( true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $a = new MockAction();
</span><span class="cx" style="display: block; padding: 0 10px"> $tag = rand_str();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -391,6 +391,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEquals( $GLOBALS['wp_filter'], $original_filter );
</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">+ /**
+ * @ticket 36819
+ */
+ function test_applied_actions_are_counted_after_restore() {
+ global $wp_actions;
+
+ $action_name = 'this_is_a_fake_action_name';
+ $this->assertArrayNotHasKey( $action_name, $wp_actions );
+
+ do_action( $action_name );
+
+ $this->assertEquals( 1, $wp_actions[ $action_name ] );
+
+ _backup_plugin_globals( true );
+ do_action( $action_name );
+ _restore_plugin_globals();
+
+ $this->assertEquals( 2, $wp_actions[ $action_name ] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function apply_testing_filter() {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->apply_testing_filter = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>