<!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>[28900] trunk: Add index key support for wp_list_pluck(), ?\195?\160 la array_column().</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/28900">28900</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2014-06-29 21:25:21 +0000 (Sun, 29 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add index key support for wp_list_pluck(), ?\195?\160 la array_column().
props trepmal.
fixes <a href="http://core.trac.wordpress.org/ticket/28666">#28666</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesfunctionsphp">trunk/src/wp-includes/functions.php</a></li>
<li><a href="#trunktestsphpunittestsfunctionslistFilterphp">trunk/tests/phpunit/tests/functions/listFilter.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/functions.php (28899 => 28900)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/functions.php 2014-06-29 18:55:45 UTC (rev 28899)
+++ trunk/src/wp-includes/functions.php 2014-06-29 21:25:21 UTC (rev 28900)
</span><span class="lines">@@ -2882,21 +2882,51 @@
</span><span class="cx"> /**
</span><span class="cx"> * Pluck a certain field out of each object in a list.
</span><span class="cx"> *
</span><ins>+ * This has the same functionality and prototype of
+ * array_column() (PHP 5.5) but also supports objects.
+ *
</ins><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="cx"> * @param array $list A list of objects or arrays
</span><span class="cx"> * @param int|string $field A field from the object to place instead of the entire object
</span><ins>+ * @param int|string $index_key A field from the object to use as keys for the new array
</ins><span class="cx"> * @return array
</span><span class="cx"> */
</span><del>-function wp_list_pluck( $list, $field ) {
- foreach ( $list as $key => $value ) {
- if ( is_object( $value ) )
- $list[ $key ] = $value->$field;
- else
- $list[ $key ] = $value[ $field ];
</del><ins>+function wp_list_pluck( $list, $field, $index_key = null ) {
+ if ( ! $index_key ) {
+ // This is simple. Could at some point wrap array_column()
+ // if we knew we had an array of arrays.
+ foreach ( $list as $key => $value ) {
+ if ( is_object( $value ) ) {
+ $list[ $key ] = $value->$field;
+ } else {
+ $list[ $key ] = $value[ $field ];
+ }
+ }
+ return $list;
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- return $list;
</del><ins>+ // When index_key is not set for a particular item,
+ // push the value to the end of the stack.
+ // This is how array_column() behaves.
+ $newlist = array();
+ foreach ( $list as $value ) {
+ if ( is_object( $value ) ) {
+ if ( isset( $value->$index_key ) ) {
+ $newlist[ $value->$index_key ] = $value->$field;
+ } else {
+ $newlist[] = $value->$field;
+ }
+ } else {
+ if ( isset( $value[ $index_key ] ) ) {
+ $newlist[ $value[ $index_key ] ] = $value[ $field ];
+ } else {
+ $newlist[] = $value[ $field ];
+ }
+ }
+ }
+
+ return $newlist;
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestsfunctionslistFilterphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/tests/functions/listFilter.php (28899 => 28900)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/tests/functions/listFilter.php 2014-06-29 18:55:45 UTC (rev 28899)
+++ trunk/tests/phpunit/tests/functions/listFilter.php 2014-06-29 21:25:21 UTC (rev 28900)
</span><span class="lines">@@ -11,9 +11,9 @@
</span><span class="cx">
</span><span class="cx"> function setUp() {
</span><span class="cx"> parent::setUp();
</span><del>- $this->array_list['foo'] = array( 'name' => 'foo', 'field1' => true, 'field2' => true, 'field3' => true, 'field4' => array( 'red' ) );
- $this->array_list['bar'] = array( 'name' => 'bar', 'field1' => true, 'field2' => true, 'field3' => false, 'field4' => array( 'green' ) );
- $this->array_list['baz'] = array( 'name' => 'baz', 'field1' => true, 'field2' => false, 'field3' => false, 'field4' => array( 'blue' ) );
</del><ins>+ $this->array_list['foo'] = array( 'name' => 'foo', 'id' => 'f', 'field1' => true, 'field2' => true, 'field3' => true, 'field4' => array( 'red' ) );
+ $this->array_list['bar'] = array( 'name' => 'bar', 'id' => 'b', 'field1' => true, 'field2' => true, 'field3' => false, 'field4' => array( 'green' ) );
+ $this->array_list['baz'] = array( 'name' => 'baz', 'id' => 'z', 'field1' => true, 'field2' => false, 'field3' => false, 'field4' => array( 'blue' ) );
</ins><span class="cx"> foreach ( $this->array_list as $key => $value ) {
</span><span class="cx"> $this->object_list[ $key ] = (object) $value;
</span><span class="cx"> }
</span><span class="lines">@@ -66,6 +66,50 @@
</span><span class="cx"> $this->assertEquals( array( 'foo' => 'foo', 'bar' => 'bar', 'baz' => 'baz' ) , $list );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * @ticket 28666
+ */
+ function test_wp_list_pluck_index_key() {
+ $list = wp_list_pluck( $this->array_list, 'name', 'id' );
+ $this->assertEquals( array( 'f' => 'foo', 'b' => 'bar', 'z' => 'baz' ), $list );
+ }
+
+ /**
+ * @ticket 28666
+ */
+ function test_wp_list_pluck_object_index_key() {
+ $list = wp_list_pluck( $this->object_list, 'name', 'id' );
+ $this->assertEquals( array( 'f' => 'foo', 'b' => 'bar', 'z' => 'baz' ), $list );
+ }
+
+ /**
+ * @ticket 28666
+ */
+ function test_wp_list_pluck_missing_index_key() {
+ $list = wp_list_pluck( $this->array_list, 'name', 'nonexistent' );
+ $this->assertEquals( array( 0 => 'foo', 1 => 'bar', 2 => 'baz' ), $list );
+ }
+
+ /**
+ * @ticket 28666
+ */
+ function test_wp_list_pluck_partial_missing_index_key() {
+ $array_list = $this->array_list;
+ unset( $array_list[ 'bar']['id'] );
+ $list = wp_list_pluck( $array_list, 'name', 'id' );
+ $this->assertEquals( array( 'f' => 'foo', 0 => 'bar', 'z' => 'baz' ), $list );
+ }
+
+ /**
+ * @ticket 28666
+ */
+ function test_wp_list_pluck_mixed_index_key() {
+ $mixed_list = $this->array_list;
+ $mixed_list['bar'] = (object) $mixed_list['bar'];
+ $list = wp_list_pluck( $mixed_list, 'name', 'id' );
+ $this->assertEquals( array( 'f' => 'foo', 'b' => 'bar', 'z' => 'baz' ), $list );
+ }
+
</ins><span class="cx"> function test_filter_object_list_nested_array_and() {
</span><span class="cx"> $list = wp_filter_object_list( $this->object_list, array( 'field4' => array( 'blue' ) ), 'AND' );
</span><span class="cx"> $this->assertEquals( 1, count( $list ) );
</span></span></pre>
</div>
</div>
</body>
</html>