<!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>[31006] trunk: In `wp_dropdown_categories()`, allow the term field used to populate option valuesto be specified.</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/31006">31006</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/31006","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-12-30 21:30:16 +0000 (Tue, 30 Dec 2014)</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'>In `wp_dropdown_categories()`, allow the term field used to populate option valuesto be specified.
The new 'value_field' parameter makes it possible to set term slugs (or some
other term property) as the 'value' attribute of the option elements generated
by `wp_dropdown_categories()`. This additional flexibility reduces the effort
required to translate term_id to other term fields when processing form
submissions that include values from taxonomy dropdowns. See <a href="https://core.trac.wordpress.org/ticket/30865">#30865</a> for a
use case.
Props collinsinternet.
Fixes <a href="https://core.trac.wordpress.org/ticket/30306">#30306</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescategorytemplatephp">trunk/src/wp-includes/category-template.php</a></li>
<li><a href="#trunktestsphpunittestscategoryphp">trunk/tests/phpunit/tests/category.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescategorytemplatephp"></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/category-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/category-template.php 2014-12-30 20:48:34 UTC (rev 31005)
+++ trunk/src/wp-includes/category-template.php 2014-12-30 21:30:16 UTC (rev 31006)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -293,6 +293,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * the 'depth' argument.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.2.0 Introduced the 'value_field' parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of arguments.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -327,7 +328,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $id Optional. Value for the 'id' attribute of the select element.
</span><span class="cx" style="display: block; padding: 0 10px"> * Defaults to the value of $name.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $class Optional. Value for the 'class' attribute of the select element.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type int $selected Optional. ID of the category to be selected.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type int|string $selected Optional. Value of the option that should be selected.
+ * @type string $value_field Optional. Term field that should be used to populate the 'value' attribute
+ * of the option elements. Accepts any valid term field: 'term_id', 'name',
+ * 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description',
+ * 'parent', 'count'. Default 'term_id'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $taxonomy Optional. Name of the category to retrieve. Default 'category'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $hide_if_empty Optional. True to skip generating markup if no categories are found.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false (create select element even if no categories are found).
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -346,7 +351,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'cat', 'id' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'class' => 'postform', 'depth' => 0,
</span><span class="cx" style="display: block; padding: 0 10px"> 'tab_index' => 0, 'taxonomy' => 'category',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'hide_if_empty' => false, 'option_none_value' => -1
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'hide_if_empty' => false, 'option_none_value' => -1,
+ 'value_field' => 'term_id',
</ins><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"> $defaults['selected'] = ( is_category() ) ? get_query_var( 'cat' ) : 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1106,7 +1112,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $output Passed by reference. Used to append additional content.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $category Category data object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $depth Depth of category. Used for padding.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args Uses 'selected' and 'show_count' keys, if they exist. @see wp_dropdown_categories()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Uses 'selected', 'show_count', and 'value_field' keys, if they exist.
+ * See {@see wp_dropdown_categories()}.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $pad = str_repeat(' ', $depth * 3);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1114,7 +1121,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/category-template.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $cat_name = apply_filters( 'list_cats', $category->name, $category );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $output .= "\t<option class=\"level-$depth\" value=\"".$category->term_id."\"";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $args['value_field'] ) || ! isset( $category->{$args['value_field']} ) ) {
+ $args['value_field'] = 'term_id';
+ }
+
+ $output .= "\t<option class=\"level-$depth\" value=\"" . esc_attr( $category->{$args['value_field']} ) . "\"";
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $category->term_id == $args['selected'] )
</span><span class="cx" style="display: block; padding: 0 10px"> $output .= ' selected="selected"';
</span><span class="cx" style="display: block; padding: 0 10px"> $output .= '>';
</span></span></pre></div>
<a id="trunktestsphpunittestscategoryphp"></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/category.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/category.php 2014-12-30 20:48:34 UTC (rev 31005)
+++ trunk/tests/phpunit/tests/category.php 2014-12-30 21:30:16 UTC (rev 31006)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -246,4 +246,86 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertNull( get_category_by_path( 'nocat/nocat/', false) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 30306
+ */
+ public function test_wp_dropdown_categories_value_field_should_default_to_term_id() {
+ // Create a test category.
+ $cat_id = $this->factory->category->create( array(
+ 'name' => 'Test Category',
+ 'slug' => 'test_category',
+ ) );
+
+ // Get the default functionality of wp_dropdown_categories().
+ $dropdown_default = wp_dropdown_categories( array(
+ 'echo' => 0,
+ 'hide_empty' => 0,
+ ) );
+
+ // Test to see if it returns the default with the category ID.
+ $this->assertContains( 'value="' . $cat_id . '"', $dropdown_default );
+ }
+
+ /**
+ * @ticket 30306
+ */
+ public function test_wp_dropdown_categories_value_field_term_id() {
+ // Create a test category.
+ $cat_id = $this->factory->category->create( array(
+ 'name' => 'Test Category',
+ 'slug' => 'test_category',
+ ) );
+
+ // Get the default functionality of wp_dropdown_categories().
+ $found = wp_dropdown_categories( array(
+ 'echo' => 0,
+ 'hide_empty' => 0,
+ 'value_field' => 'term_id',
+ ) );
+
+ // Test to see if it returns the default with the category ID.
+ $this->assertContains( 'value="' . $cat_id . '"', $found );
+ }
+
+ /**
+ * @ticket 30306
+ */
+ public function test_wp_dropdown_categories_value_field_slug() {
+ // Create a test category.
+ $cat_id = $this->factory->category->create( array(
+ 'name' => 'Test Category',
+ 'slug' => 'test_category',
+ ) );
+
+ // Get the default functionality of wp_dropdown_categories().
+ $found = wp_dropdown_categories( array(
+ 'echo' => 0,
+ 'hide_empty' => 0,
+ 'value_field' => 'slug',
+ ) );
+
+ // Test to see if it returns the default with the category slug.
+ $this->assertContains( 'value="test_category"', $found );
+ }
+
+ /**
+ * @ticket 30306
+ */
+ public function test_wp_dropdown_categories_value_field_should_fall_back_on_term_id_when_an_invalid_value_is_provided() {
+ // Create a test category.
+ $cat_id = $this->factory->category->create( array(
+ 'name' => 'Test Category',
+ 'slug' => 'test_category',
+ ) );
+
+ // Get the default functionality of wp_dropdown_categories().
+ $found = wp_dropdown_categories( array(
+ 'echo' => 0,
+ 'hide_empty' => 0,
+ 'value_field' => 'foo',
+ ) );
+
+ // Test to see if it returns the default with the category slug.
+ $this->assertContains( 'value="' . $cat_id . '"', $found );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>