Changeset 37465

Timestamp:

05/19/2016 02:38:33 AM (7 years ago)

Author:

boonebgorges

Message:

Introduce required argument for wp_dropdown_categories().

This allows the HTML5 required attribute to be added to the select element.

Props wzislam, pcarvalho.
Fixes #31909.

Location:

trunk

Files:

• src/wp-includes/category-template.php (modified) (4 diffs)
• tests/phpunit/tests/category/wpDropdownCategories.php (modified) (1 diff)

trunk/src/wp-includes/category-template.php

@@ -315 +315 @@
  * @since 2.1.0
  * @since 4.2.0 Introduced the `value_field` argument.
+ * @since 4.6.0 Introduced the `required` argument.
  *
  * @param string|array $args {
@@ -352 +353 @@
  *     @type bool         $hide_if_empty     True to skip generating markup if no categories are found.
  *                                           Default false (create select element even if no categories are found).
+ *     @type bool         $required          Whether the <select> element should have the HTML5 'required' attribute.
+ *                                           Default false.
  * }
  * @return string HTML content only if 'echo' argument is 0.
@@ -377 +380 @@
         'option_none_value' => -1,
         'value_field'       => 'term_id',
+        'required'          => false,
     );
 
@@ -415 +419 @@
     $class = esc_attr( $r['class'] );
     $id = $r['id'] ? esc_attr( $r['id'] ) : $name;
+    $required = $r['required'] ? 'required' : '';
 
     if ( ! $r['hide_if_empty'] || ! empty( $categories ) ) {
-        $output = "<select name='$name' id='$id' class='$class' $tab_index_attribute>\n";
+        $output = "<select $required name='$name' id='$id' class='$class' $tab_index_attribute>\n";
     } else {
         $output = '';

trunk/tests/phpunit/tests/category/wpDropdownCategories.php

@@ -154 +154 @@
         }
     }
+
+    /**
+     * @ticket 31909
+     */
+    public function test_required_true_should_add_required_attribute() {
+        // Create a test category.
+        $cat_id = self::factory()->category->create( array(
+            'name' => 'Test Category',
+            'slug' => 'test_category',
+        ) );
+
+        $args = array(
+            'show_option_none'  => __( 'Select one', 'text-domain' ),
+            'option_none_value' => "",
+            'required'          => true,
+            'hide_empty'        => 0,
+            'echo'              => 0,
+        );
+        $dropdown_categories = wp_dropdown_categories( $args );
+
+        // Test to see if it contains the "required" attribute.
+        $this->assertRegExp( '/<select[^>]+required/', $dropdown_categories );
+    }
+
+    /**
+     * @ticket 31909
+     */
+    public function test_required_false_should_omit_required_attribute() {
+        // Create a test category.
+        $cat_id = self::factory()->category->create( array(
+            'name' => 'Test Category',
+            'slug' => 'test_category',
+        ) );
+
+        $args = array(
+            'show_option_none'  => __( 'Select one', 'text-domain' ),
+            'option_none_value' => "",
+            'required'          => false,
+            'hide_empty'        => 0,
+            'echo'              => 0,
+        );
+        $dropdown_categories = wp_dropdown_categories( $args );
+
+        // Test to see if it contains the "required" attribute.
+        $this->assertNotRegExp( '/<select[^>]+required/', $dropdown_categories );
+    }
+
+    /**
+     * @ticket 31909
+     */
+    public function test_required_should_default_to_false() {
+        // Create a test category.
+        $cat_id = self::factory()->category->create( array(
+            'name' => 'Test Category',
+            'slug' => 'test_category',
+        ) );
+
+        $args = array(
+            'show_option_none'  => __( 'Select one', 'text-domain' ),
+            'option_none_value' => "",
+            'hide_empty'        => 0,
+            'echo'              => 0,
+        );
+        $dropdown_categories = wp_dropdown_categories( $args );
+
+        // Test to see if it contains the "required" attribute.
+        $this->assertNotRegExp( '/<select[^>]+required/', $dropdown_categories );
+    }
 }