<!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>[38251] trunk: Bootstrap/Load: Revert Plugin Global restoration around `advance-cache.php`.</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/38251">38251</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/38251","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-08-13 15:59:03 +0000 (Sat, 13 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'>Bootstrap/Load: Revert Plugin Global restoration around `advance-cache.php`.
First added in <a href="https://core.trac.wordpress.org/changeset/37588">[37588]</a> and later modified in <a href="https://core.trac.wordpress.org/changeset/38224">[38224]</a>, the idea was to ensure that filters/actions added before `advance-cache.php` would not disappear if `advance-cache.php` overloaded the filters/actions with code such as `$wp_filter = array()`. This is an edge case and one that there is no documented case of existing.
This restores the behavior from WordPress 4.5 and before. It is strongly encouraged that developers using `advance-cache.php` to use the Plugins API that is available before the loading of `advance-cache.php` rather than directly interacting with any of the globals.
Props azaozz, jorbin, dd32 for review, pento for review, westi for investigation, ipstenu for research.
See <a href="https://core.trac.wordpress.org/ticket/36819">#36819</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludespluginphp">trunk/src/wp-includes/plugin.php</a></li>
<li><a href="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
<li><a href="#trunktestsphpunittestsactionsphp">trunk/tests/phpunit/tests/actions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludespluginphp"></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/plugin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/plugin.php 2016-08-12 14:11:58 UTC (rev 38250)
+++ trunk/src/wp-includes/plugin.php 2016-08-13 15:59:03 UTC (rev 38251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1001,97 +1001,3 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $function[0] . '::' . $function[1];
</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">-
-/**
- * Backs up global variables used for actions and filters.
- *
- * Prevents redefinition of these globals in advanced-cache.php from accidentally
- * destroying existing data.
- *
- * @since 4.6.0
- * @access private
- *
- * @global array $wp_filter Stores all filters and actions.
- * @global array $wp_actions Stores the amount of times an action was triggered.
- * @global array $merged_filters Merges the filter hooks using this function.
- * @global array $wp_current_filter Stores the list of current filters with the current one last.
- * @staticvar array $backup_globals Backed up globals.
- *
- * @return array the staticvar from the first time it is set.
- */
-function _backup_plugin_globals( $backup = true ) {
- global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
-
- static $backup_globals = array();
-
- if ( $backup ) {
- $backup_globals = array(
- 'backup_wp_filter' => $wp_filter,
- 'backup_wp_actions' => $wp_actions,
- 'backup_merged_filters' => $merged_filters,
- 'backup_wp_current_filter' => $wp_current_filter,
- );
-
- $wp_filter = $wp_actions = array();
- }
- return $backup_globals;
-}
-
-/**
- * Safely restores backed up global variables used for actions and filters.
- *
- * @since 4.6.0
- * @access private
- *
- * @global array $wp_filter Stores all filters and actions.
- * @global array $wp_actions Stores the amount of times an action was triggered.
- * @global array $merged_filters Merges the filter hooks using this function.
- * @global array $wp_current_filter Stores the list of current filters with the current one last.
- * @staticvar array $backup_globals Backed up globals.
- */
-function _restore_plugin_globals() {
- global $wp_filter, $wp_actions, $merged_filters, $wp_current_filter;
-
- $backup_globals = _backup_plugin_globals( false );
-
- 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'] );
- }
- }
- }
- }
-
- 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;
- }
- }
-
- if ( $merged_filters !== $backup_globals['backup_merged_filters'] ) {
- $merged_filters = array_merge_recursive( $merged_filters, $backup_globals['backup_merged_filters'] );
- }
-
- if ( $wp_current_filter !== $backup_globals['backup_wp_current_filter'] ) {
- $wp_current_filter = array_merge_recursive( $wp_current_filter, $backup_globals['backup_wp_current_filter'] );
- }
-}
</del></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2016-08-12 14:11:58 UTC (rev 38250)
+++ trunk/src/wp-settings.php 2016-08-13 15:59:03 UTC (rev 38251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -83,9 +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( true );
</del><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- _restore_plugin_globals();
</del><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"> // Define WP_LANG_DIR if not set.
</span></span></pre></div>
<a id="trunktestsphpunittestsactionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/actions.php 2016-08-12 14:11:58 UTC (rev 38250)
+++ trunk/tests/phpunit/tests/actions.php 2016-08-13 15:59:03 UTC (rev 38251)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -328,89 +328,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( doing_filter( 'testing' ) ); // No longer doing this filter
</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">- /**
- * @ticket 36819
- */
- function test_backup_plugin_globals_returns_filters() {
- $backup = _backup_plugin_globals( true );
- $this->assertArrayHasKey( 'backup_wp_filter', $backup );
- $this->assertArrayHasKey( 'backup_wp_actions', $backup );
- $this->assertArrayHasKey( 'backup_wp_current_filter', $backup );
- $this->assertArrayHasKey( 'backup_merged_filters', $backup );
- }
-
- /**
- * @ticket 36819
- */
- function test_backup_plugin_globals_returns_filters_from_first_time_called() {
- $backup = _backup_plugin_globals( true );
-
- $a = new MockAction();
- $tag = rand_str();
-
- add_action($tag, array(&$a, 'action'));
-
- $new_backup = _backup_plugin_globals( false );
- $this->assertEquals( $backup, $new_backup );
- }
-
- /**
- * @ticket 36819
- */
- function test_restore_plugin_globals_from_stomp() {
- global $wp_actions;
- $original_actions = $wp_actions;
-
- _backup_plugin_globals( true );
-
- $wp_actions = array();
-
- $this->assertEmpty( $wp_actions );
- _restore_plugin_globals();
-
- $this->assertEquals( $GLOBALS['wp_actions'], $original_actions );
- }
-
- /**
- * @ticket 36819
- */
- function test_restore_plugin_globals_includes_additions() {
- global $wp_filter;
- $original_filter = $wp_filter;
-
- $backup = _backup_plugin_globals( true );
-
- $a = new MockAction();
- $tag = rand_str();
- add_action($tag, array(&$a, 'action'));
-
- $this->assertNotEquals( $GLOBALS['wp_filter'], $original_filter );
-
- _restore_plugin_globals();
-
- $this->assertNotEquals( $GLOBALS['wp_filter'], $original_filter );
- }
-
- /**
- * @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 ] );
- }
-
</del><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>