Changeset 32602 for trunk/src/wp-includes/widgets.php

Timestamp:

05/26/2015 04:50:03 PM (10 years ago)

Author:

westonruter

Message:

Add support for WP_Widget::get_settings() returning ArrayIterator/ArrayObject instances.

Plugins can use pre_option_widget_{$id_base} filters to return ArrayIterator/ArrayObject instances instead of primitive arrays. This makes possible for widget instance data to be drawn from somewhere else than wp_options, such as a custom post type.

Add unit tests for widgets.

Fixes #32474.

File:

• trunk/src/wp-includes/widgets.php (modified) (5 diffs)

trunk/src/wp-includes/widgets.php

@@ -215 +215 @@
         $empty = true;
 
-        if ( is_array($settings) ) {
-            foreach ( array_keys($settings) as $number ) {
-                if ( is_numeric($number) ) {
-                    $this->_set($number);
-                    $this->_register_one($number);
+        // When $settings is an array-like object, get an intrinsic array for use with array_keys().
+        if ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) {
+            $settings = $settings->getArrayCopy();
+        }
+
+        if ( is_array( $settings ) ) {
+            foreach ( array_keys( $settings ) as $number ) {
+                if ( is_numeric( $number ) ) {
+                    $this->_set( $number );
+                    $this->_register_one( $number );
                     $empty = false;
                 }
@@ -226 +231 @@
 
         if ( $empty ) {
-            // If there are none, we register the widget's existence with a
-            // generic template
-            $this->_set(1);
+            // If there are none, we register the widget's existence with a generic template.
+            $this->_set( 1 );
             $this->_register_one();
         }
@@ -295 +299 @@
      */
     public function display_callback( $args, $widget_args = 1 ) {
-        if ( is_numeric($widget_args) )
+        if ( is_numeric( $widget_args ) ) {
             $widget_args = array( 'number' => $widget_args );
+        }
 
         $widget_args = wp_parse_args( $widget_args, array( 'number' => -1 ) );
         $this->_set( $widget_args['number'] );
-        $instance = $this->get_settings();
-
-        if ( array_key_exists( $this->number, $instance ) ) {
-            $instance = $instance[$this->number];
+        $instances = $this->get_settings();
+
+        if ( isset( $instances[ $this->number ] ) ) {
+            $instance = $instances[ $this->number ];
 
             /**
@@ -425 +430 @@
      *
      * @param int|array $widget_args Widget instance number or array of widget arguments.
+     * @return string|null
      */
     public function form_callback( $widget_args = 1 ) {
@@ -517 +523 @@
     public function get_settings() {
 
-        $settings = get_option($this->option_name);
-
-        if ( false === $settings && isset($this->alt_option_name) )
-            $settings = get_option($this->alt_option_name);
-
-        if ( !is_array($settings) )
+        $settings = get_option( $this->option_name );
+
+        if ( false === $settings && isset( $this->alt_option_name ) ) {
+            $settings = get_option( $this->alt_option_name );
+        }
+
+        if ( ! is_array( $settings ) && ! ( $settings instanceof ArrayObject || $settings instanceof ArrayIterator ) ) {
             $settings = array();
-
-        if ( !empty($settings) && !array_key_exists('_multiwidget', $settings) ) {
-            // old format, convert if single widget
-            $settings = wp_convert_widget_settings($this->id_base, $this->option_name, $settings);
-        }
-
-        unset($settings['_multiwidget'], $settings['__i__']);
+        }
+
+        if ( ! empty( $settings ) && ! isset( $settings['_multiwidget'] ) ) {
+            // Old format, convert if single widget.
+            $settings = wp_convert_widget_settings( $this->id_base, $this->option_name, $settings );
+        }
+
+        unset( $settings['_multiwidget'], $settings['__i__'] );
         return $settings;
     }