<!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>[31338] trunk: Introduce `'value_field'` parameter to `wp_dropdown_pages()`.</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/31338">31338</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/31338","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>2015-02-05 19:03:52 +0000 (Thu, 05 Feb 2015)</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'>Introduce `'value_field'` parameter to `wp_dropdown_pages()`.

This parameter allows developers to choose the post field that will be used to
fill in the 'option' attribute of the generated dropdown markup.

See <a href="https://core.trac.wordpress.org/changeset/31006">[31006]</a> <a href="https://core.trac.wordpress.org/ticket/30306">#30306</a> for a parallel enhancement in `wp_dropdown_categories()`.

Props jfarthing84.
Fixes <a href="https://core.trac.wordpress.org/ticket/12494">#12494</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesposttemplatephp">trunk/src/wp-includes/post-template.php</a></li>
<li><a href="#trunktestsphpunittestsposttemplatephp">trunk/tests/phpunit/tests/post/template.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesposttemplatephp"></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/post-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post-template.php   2015-02-05 18:59:22 UTC (rev 31337)
+++ trunk/src/wp-includes/post-template.php     2015-02-05 19:03:52 UTC (rev 31338)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -971,7 +971,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">                'selected' => 0, 'echo' => 1,
</span><span class="cx" style="display: block; padding: 0 10px">                'name' => 'page_id', 'id' => '',
</span><span class="cx" style="display: block; padding: 0 10px">                'show_option_none' => '', 'show_option_no_change' => '',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-                'option_none_value' => ''
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         'option_none_value' => '',
+               'value_field' => '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">        $r = wp_parse_args( $args, $defaults );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1425,15 +1426,20 @@
</span><span class="cx" style="display: block; padding: 0 10px">         * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px">         *
</span><span class="cx" style="display: block; padding: 0 10px">         * @param string $output Passed by reference. Used to append additional content.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * @param object $page Page data object.
-        * @param int $depth Depth of page in reference to parent pages. Used for padding.
-        * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option element.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * @param object $page   Page data object.
+        * @param int    $depth  Depth of page in reference to parent pages. Used for padding.
+        * @param array  $args   Uses 'selected' argument for selected page to set selected HTML attribute for option
+        *              element. Uses 'value_field' argument to fill "value" attribute. See {@see wp_dropdown_pages()}.
</ins><span class="cx" style="display: block; padding: 0 10px">          * @param int $id
</span><span class="cx" style="display: block; padding: 0 10px">         */
</span><span class="cx" style="display: block; padding: 0 10px">        public function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px">                $pad = str_repeat('&nbsp;', $depth * 3);
</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=\"$page->ID\"";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+         if ( ! isset( $args['value_field'] ) || ! isset( $page->{$args['value_field']} ) ) {
+                       $args['value_field'] = 'ID';
+               }
+
+               $output .= "\t<option class=\"level-$depth\" value=\"" . esc_attr( $page->{$args['value_field']} ) . "\"";
</ins><span class="cx" style="display: block; padding: 0 10px">                 if ( $page->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="trunktestsphpunittestsposttemplatephp"></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/post/template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post/template.php       2015-02-05 18:59:22 UTC (rev 31337)
+++ trunk/tests/phpunit/tests/post/template.php 2015-02-05 19:03:52 UTC (rev 31338)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -131,4 +131,70 @@
</span><span class="cx" style="display: block; padding: 0 10px">                ) );
</span><span class="cx" style="display: block; padding: 0 10px">                $this->assertEquals( $option_no_change, $output );
</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 12494
+        */
+       public function test_wp_dropdown_pages_value_field_should_default_to_ID() {
+               $p = $this->factory->post->create( array(
+                       'post_type' => 'page',
+               ) );
+
+               $found = wp_dropdown_pages( array(
+                       'echo' => 0,
+               ) );
+
+               // Should contain page ID by default.
+               $this->assertContains( 'value="' . $p . '"', $found );
+       }
+
+       /**
+        * @ticket 12494
+        */
+       public function test_wp_dropdown_pages_value_field_ID() {
+               $p = $this->factory->post->create( array(
+                       'post_type' => 'page',
+               ) );
+
+               $found = wp_dropdown_pages( array(
+                       'echo' => 0,
+                       'value_field' => 'ID',
+               ) );
+
+               $this->assertContains( 'value="' . $p . '"', $found );
+       }
+
+       /**
+        * @ticket 12494
+        */
+       public function test_wp_dropdown_pages_value_field_post_name() {
+               $p = $this->factory->post->create( array(
+                       'post_type' => 'page',
+                       'post_name' => 'foo',
+               ) );
+
+               $found = wp_dropdown_pages( array(
+                       'echo' => 0,
+                       'value_field' => 'post_name',
+               ) );
+
+               $this->assertContains( 'value="foo"', $found );
+       }
+
+       /**
+        * @ticket 12494
+        */
+       public function test_wp_dropdown_pages_value_field_should_fall_back_on_ID_when_an_invalid_value_is_provided() {
+               $p = $this->factory->post->create( array(
+                       'post_type' => 'page',
+                       'post_name' => 'foo',
+               ) );
+
+               $found = wp_dropdown_pages( array(
+                       'echo' => 0,
+                       'value_field' => 'foo',
+               ) );
+
+               $this->assertContains( 'value="' . $p . '"', $found );
+       }
+}
</ins></span></pre>
</div>
</div>

</body>
</html>