Changeset 34780

Timestamp:

10/02/2015 08:23:54 PM (9 years ago)

Author:

johnbillion

Message:

Introduce support for array format field names in WP_Widget::get_field_name() and WP_Widget::get_field_id().

Fixes #12133
Props ch1902, welcher

Location:

trunk

Files:

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

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

@@ -178 +178 @@
      * This function should be used in form() methods to create name attributes for fields to be saved by update()
      *
+     * @since 4.4.0 Array format field names are now accepted.
+     *
      * @param string $field_name Field name
      * @return string Name attribute for $field_name
      */
     public function get_field_name($field_name) {
-        return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
+        if ( false === $pos = strpos( $field_name, '[' ) ) {
+            return 'widget-' . $this->id_base . '[' . $this->number . '][' . $field_name . ']';
+        } else {
+            return 'widget-' . $this->id_base . '[' . $this->number . '][' . substr_replace( $field_name, '][', $pos, strlen( '[' ) );
+        }
     }
 
@@ -191 +197 @@
      * for fields to be saved by {@see WP_Widget::update()}.
      *
+     * @since 4.4.0 Array format field IDs are now accepted.
+     *
      * @since 2.8.0
      * @access public
@@ -198 +206 @@
      */
     public function get_field_id( $field_name ) {
-        return 'widget-' . $this->id_base . '-' . $this->number . '-' . $field_name;
+        return 'widget-' . $this->id_base . '-' . $this->number . '-' . trim( str_replace( array( '[]', '[', ']' ), array( '', '-', '' ), $field_name ), '-' );
     }
 

trunk/tests/phpunit/tests/widgets.php

@@ -158 +158 @@
     /**
      * @see WP_Widget::get_field_name()
-     */
-    function test_wp_widget_get_field_name() {
+     * @dataProvider data_wp_widget_get_field_name
+     *
+     */
+    function test_wp_widget_get_field_name( $expected, $value_to_test ) {
         $widget = new WP_Widget( 'foo', 'Foo' );
         $widget->_set( 2 );
-        $this->assertEquals( 'widget-foo[2][title]', $widget->get_field_name( 'title' ) );
+        $this->assertEquals( $expected, $widget->get_field_name( $value_to_test ) );
+    }
+
+    /**
+     * Data provider.
+     *
+     * Passes the expected field name and the value to test.
+     *
+     * @since 4.4.0
+     *
+     * @return array {
+     *     @type array {
+     *         @type string $expected      The expected field id to be returned.
+     *         @type string $value_to_test The value being passed to the get_field_name method.
+     *     }
+     * }
+     */
+    function data_wp_widget_get_field_name( ) {
+
+        return array(
+            array(
+                'widget-foo[2][title]',
+                'title',
+            ),
+            array(
+                'widget-foo[2][posttypes][]',
+                'posttypes[]',
+            ),
+            array(
+                'widget-foo[2][posttypes][4]',
+                'posttypes[4]',
+            ),
+            array(
+                'widget-foo[2][posttypes][4][]',
+                'posttypes[4][]',
+            ),
+            array(
+                'widget-foo[2][posttypes][4][][6]',
+                'posttypes[4][][6]',
+            ),
+        );
     }
 
     /**
      * @see WP_Widget::get_field_id()
-     */
-    function test_wp_widget_get_field_id() {
+     * @dataProvider data_wp_widget_get_field_id
+     *
+     */
+    function test_wp_widget_get_field_id( $expected, $value_to_test ) {
         $widget = new WP_Widget( 'foo', 'Foo' );
         $widget->_set( 2 );
-        $this->assertEquals( 'widget-foo-2-title', $widget->get_field_id( 'title' ) );
+        $this->assertEquals( $expected, $widget->get_field_id( $value_to_test ) );
+    }
+
+
+    /**
+     * Data provider.
+     *
+     * Passes the expected field id and the value to be used in the tests.
+     *
+     * @since 4.4.0
+     *
+     * @return array {
+     *     @type array {
+     *         @type string $expected      The expected field id to be returned.
+     *         @type string $value_to_test The value being passed to the get_field_id method.
+     *     }
+     * }
+     */
+    function data_wp_widget_get_field_id() {
+        return array(
+            array(
+                'widget-foo-2-title',
+                'title',
+            ),
+            array(
+                'widget-foo-2-posttypes',
+                'posttypes[]',
+            ),
+            array(
+                'widget-foo-2-posttypes-4',
+                'posttypes[4]',
+            ),
+            array(
+                'widget-foo-2-posttypes-4',
+                'posttypes[4][]',
+            ),
+            array(
+                'widget-foo-2-posttypes-4-6',
+                'posttypes[4][][6]',
+            ),
+        );
     }