Changeset 37333

Timestamp:

04/30/2016 10:35:27 PM (10 years ago)

Author:

westonruter

Message:

Widgets: Provide PHP 5.2 fallback for spl_object_hash() if disabled in logic for registering and unregistering pre-instantiated widgets.

Fixes #28216.

Location:

trunk

Files:

• src/wp-includes/class-wp-widget-factory.php (modified) (3 diffs)
• tests/phpunit/tests/widgets.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-widget-factory.php

@@ -47 +47 @@
 
         /**
+         * 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;
+                }
+        }
+
+        /**
          * Registers a widget subclass.
          *
@@ -57 +101 @@
         public function register( $widget ) {
                 if ( $widget instanceof WP_Widget ) {
-                        $this->widgets[ spl_object_hash( $widget ) ] = $widget;
+                        $this->widgets[ $this->hash_object( $widget ) ] = $widget;
                 } else {
                         $this->widgets[ $widget ] = new $widget();
@@ -74 +118 @@
         public function unregister( $widget ) {
                 if ( $widget instanceof WP_Widget ) {
-                        unset( $this->widgets[ spl_object_hash( $widget ) ] );
+                        unset( $this->widgets[ $this->hash_object( $widget ) ] );
                 } else {
                         unset( $this->widgets[ $widget ] );

trunk/tests/phpunit/tests/widgets.php

@@ -79 +79 @@
                 $widget_better_search->control_options['id_base'] = $widget_better_search->id_base;
                 register_widget( $widget_better_search );
-                $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
+                $this->assertContains( $widget_better_search, $wp_widget_factory->widgets );
 
                 $widget_best_search = new WP_Widget_Search();
@@ -88 +88 @@
                 $widget_best_search->control_options['id_base'] = $widget_best_search->id_base;
                 register_widget( $widget_best_search );
-                $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+                $this->assertContains( $widget_best_search, $wp_widget_factory->widgets );
 
                 $this->assertCount( 3, $wp_widget_factory->widgets );
                 $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
-                $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
-                $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+                $this->assertContains( $widget_better_search, $wp_widget_factory->widgets );
+                $this->assertContains( $widget_best_search, $wp_widget_factory->widgets );
 
                 $wp_widget_factory->_register_widgets();
@@ -104 +104 @@
                 $this->assertSame( $widget_best_search, $wp_registered_widgets['best_search-4']['callback'][0] );
 
-                $this->assertArrayHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
-                $this->assertArrayHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+                $this->assertContains( $widget_better_search, $wp_widget_factory->widgets );
+                $this->assertContains( $widget_best_search, $wp_widget_factory->widgets );
                 $this->assertArrayHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
                 unregister_widget( 'WP_Widget_Search' );
                 unregister_widget( $widget_better_search );
                 unregister_widget( $widget_best_search );
-                $this->assertArrayNotHasKey( spl_object_hash( $widget_better_search ), $wp_widget_factory->widgets );
-                $this->assertArrayNotHasKey( spl_object_hash( $widget_best_search ), $wp_widget_factory->widgets );
+                $this->assertNotContains( $widget_better_search, $wp_widget_factory->widgets );
+                $this->assertNotContains( $widget_best_search, $wp_widget_factory->widgets );
                 $this->assertArrayNotHasKey( 'WP_Widget_Search', $wp_widget_factory->widgets );
         }