<!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>[37333] trunk: Widgets: Provide PHP 5.2 fallback for `spl_object_hash()` if disabled in logic for registering and unregistering pre-instantiated widgets.</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/37333">37333</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/37333","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-04-30 22:35:27 +0000 (Sat, 30 Apr 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'>Widgets: Provide PHP 5.2 fallback for `spl_object_hash()` if disabled in logic for registering and unregistering pre-instantiated widgets.
Fixes <a href="https://core.trac.wordpress.org/ticket/28216">#28216</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpwidgetfactoryphp">trunk/src/wp-includes/class-wp-widget-factory.php</a></li>
<li><a href="#trunktestsphpunittestswidgetsphp">trunk/tests/phpunit/tests/widgets.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpwidgetfactoryphp"></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/class-wp-widget-factory.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-widget-factory.php 2016-04-30 15:08:06 UTC (rev 37332)
+++ trunk/src/wp-includes/class-wp-widget-factory.php 2016-04-30 22:35:27 UTC (rev 37333)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,6 +46,50 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Memory for the number of times unique class instances have been hashed.
+ *
+ * This can be eliminated in favor of straight spl_object_hash() when 5.3
+ * is the minimum requirement for PHP.
+ *
+ * @since 4.6.0
+ * @access private
+ * @see WP_Widget_Factory::hash_object()
+ *
+ * @var array
+ */
+ private $hashed_class_counts = array();
+
+ /**
+ * Hash an object, doing fallback of `spl_object_hash()` if not available.
+ *
+ * This can be eliminated in favor of straight spl_object_hash() when 5.3
+ * is the minimum requirement for PHP.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @param WP_Widget $widget Widget.
+ * @return string Object hash.
+ */
+ private function hash_object( $widget ) {
+ if ( function_exists( 'spl_object_hash' ) ) {
+ return spl_object_hash( $widget );
+ } else {
+ $class_name = get_class( $widget );
+ $hash = $class_name;
+ if ( ! isset( $widget->_wp_widget_factory_hash_id ) ) {
+ if ( ! isset( $this->hashed_class_counts[ $class_name ] ) ) {
+ $this->hashed_class_counts[ $class_name ] = 0;
+ }
+ $this->hashed_class_counts[ $class_name ] += 1;
+ $widget->_wp_widget_factory_hash_id = $this->hashed_class_counts[ $class_name ];
+ }
+ $hash .= ':' . $widget->_wp_widget_factory_hash_id;
+ return $hash;
+ }
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Registers a widget subclass.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,7 +100,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function register( $widget ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $widget instanceof WP_Widget ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->widgets[ spl_object_hash( $widget ) ] = $widget;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->widgets[ $this->hash_object( $widget ) ] = $widget;
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->widgets[ $widget ] = new $widget();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -73,7 +117,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function unregister( $widget ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $widget instanceof WP_Widget ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $this->widgets[ spl_object_hash( $widget ) ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $this->widgets[ $this->hash_object( $widget ) ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $this->widgets[ $widget ] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetsphp"></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/widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets.php 2016-04-30 15:08:06 UTC (rev 37332)
+++ trunk/tests/phpunit/tests/widgets.php 2016-04-30 22:35:27 UTC (rev 37333)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -78,7 +78,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_better_search->widget_options['classname'] = 'widget_' . $widget_better_search->id_base;
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_better_search->control_options['id_base'] = $widget_better_search->id_base;
</span><span class="cx" style="display: block; padding: 0 10px"> register_widget( $widget_better_search );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( $widget_better_search, $wp_widget_factory->widgets );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_best_search = new WP_Widget_Search();
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_best_search->id_base = 'best_search';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -87,12 +87,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_best_search->widget_options['classname'] = 'widget_' . $widget_best_search->id_base;
</span><span class="cx" style="display: block; padding: 0 10px"> $widget_best_search->control_options['id_base'] = $widget_best_search->id_base;
</span><span class="cx" style="display: block; padding: 0 10px"> register_widget( $widget_best_search );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( $widget_best_search, $wp_widget_factory->widgets );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertCount( 3, $wp_widget_factory->widgets );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
- $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( $widget_better_search, $wp_widget_factory->widgets );
+ $this->assertContains( $widget_best_search, $wp_widget_factory->widgets );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_widget_factory->_register_widgets();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,14 +103,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $widget_better_search, $wp_registered_widgets['better_search-3']['callback'][0] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $widget_best_search, $wp_registered_widgets['best_search-4']['callback'][0] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
- $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertContains( $widget_better_search, $wp_widget_factory->widgets );
+ $this->assertContains( $widget_best_search, $wp_widget_factory->widgets );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
</span><span class="cx" style="display: block; padding: 0 10px"> unregister_widget( 'WP_Widget_Search' );
</span><span class="cx" style="display: block; padding: 0 10px"> unregister_widget( $widget_better_search );
</span><span class="cx" style="display: block; padding: 0 10px"> unregister_widget( $widget_best_search );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertArrayNotHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
- $this->assertArrayNotHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertNotContains( $widget_better_search, $wp_widget_factory->widgets );
+ $this->assertNotContains( $widget_best_search, $wp_widget_factory->widgets );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayNotHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>