深入理解 WordPress `wp_list_pluck()` 函数的源码：如何从对象或数组数组中高效地提取特定字段。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

嘿，各位代码爱好者！今天咱们不开车，但要深入研究一下 WordPress 引擎盖下的一个实用小工具——wp_list_pluck() 函数。这玩意儿啊，就像一个数据挖掘工，专门从对象或者数组的数组里，把我们想要的特定字段像挖矿一样提取出来。

开场白：为什么我们需要 wp_list_pluck()？

想象一下，你从数据库里捞出了一堆用户信息，每个用户都是一个对象，包含姓名、邮箱、注册时间等等。现在，你只想拿到所有用户的邮箱地址，然后群发一封充满诚意的（或者促销的）邮件。手动循环遍历，一个个提取？太 low 了！wp_list_pluck() 就是来解决这个问题的，它可以优雅、高效地完成这项任务。

正文：解剖 wp_list_pluck() 的源码

让我们直接上代码，看看 wp-includes/functions.php 里 wp_list_pluck() 的真面目：

/**
 * Retrieves a list of values from a list of objects, in the style of array_column().
 *
 * @since 4.7.0
 *
 * @param array        $list     A list of objects or arrays.
 * @param string|int   $field    Field from the object to place into the array.
 * @param string|int   $index_key Optional. Field from the object to use as keys for the associative array.
 *                               Default null.
 * @return array A list of values.
 */
function wp_list_pluck( $list, $field, $index_key = null ) {
    if ( ! is_iterable( $list ) ) {
        return array();
    }

    $newlist = array();

    if ( null === $index_key ) {
        foreach ( $list as $value ) {
            if ( is_object( $value ) ) {
                if ( isset( $value->$field ) ) {
                    $newlist[] = $value->$field;
                } else {
                    $newlist[] = null; // Or handle the missing field differently
                }
            } else {
                if ( isset( $value[ $field ] ) ) {
                    $newlist[] = $value[ $field ];
                } else {
                    $newlist[] = null; // Or handle the missing field differently
                }
            }
        }
    } else {
        foreach ( $list as $value ) {
            if ( is_object( $value ) ) {
                if ( isset( $value->$index_key ) ) {
                    $index = $value->$index_key;
                } else {
                    $index = null; // Or handle the missing index key differently
                }

                if ( isset( $value->$field ) ) {
                    $newlist[ $index ] = $value->$field;
                } else {
                    $newlist[ $index ] = null; // Or handle the missing field differently
                }
            } else {
                if ( isset( $value[ $index_key ] ) ) {
                    $index = $value[ $index_key ];
                } else {
                    $index = null; // Or handle the missing index key differently
                }

                if ( isset( $value[ $field ] ) ) {
                    $newlist[ $index ] = $value[ $field ];
                } else {
                    $newlist[ $index ] = null; // Or handle the missing field differently
                }
            }
        }
    }

    return $newlist;
}

逐行解读，深入虎穴：

函数定义： function wp_list_pluck( $list, $field, $index_key = null )
- $list: 这是我们要处理的数据源，一个包含对象或数组的数组。
- $field: 我们要提取的字段名，可以是字符串或整数（数组索引）。
- $index_key: 可选参数，指定用哪个字段的值作为结果数组的键。默认为 null，表示结果数组是索引数组。
类型检查： if ( ! is_iterable( $list ) ) { return array(); }
- 首先，函数会检查 $list 是否可迭代。如果不是（比如是一个整数、字符串），直接返回一个空数组，避免报错。毕竟，巧妇难为无米之炊。
初始化结果数组： $newlist = array();
- 创建一个空数组 $newlist，用于存储提取后的结果。

判断是否使用 $index_key： if ( null === $index_key ) { ... } else { ... }

这是函数的核心逻辑分支。根据是否提供了 $index_key，采取不同的提取策略。
情况一：没有 $index_key
```
foreach ( $list as $value ) {
    if ( is_object( $value ) ) {
        if ( isset( $value->$field ) ) {
            $newlist[] = $value->$field;
        } else {
            $newlist[] = null; // Or handle the missing field differently
        }
    } else {
        if ( isset( $value[ $field ] ) ) {
            $newlist[] = $value[ $field ];
        } else {
            $newlist[] = null; // Or handle the missing field differently
        }
    }
}
```
- 遍历 $list 中的每个元素 $value。
- 判断 $value 是对象还是数组。
- 如果是对象，使用 $value->$field 访问字段。如果是数组，使用 $value[ $field ] 访问字段。
- isset() 检查字段是否存在。如果存在，将字段的值添加到 $newlist 中。如果不存在，添加 null (这里你可以根据实际需求调整，比如抛出异常，或者使用一个默认值)。
- 最终，$newlist 会成为一个包含所有提取字段值的索引数组。

情况二：有 $index_key

foreach ( $list as $value ) {
    if ( is_object( $value ) ) {
        if ( isset( $value->$index_key ) ) {
            $index = $value->$index_key;
        } else {
            $index = null; // Or handle the missing index key differently
        }

        if ( isset( $value->$field ) ) {
            $newlist[ $index ] = $value->$field;
        } else {
            $newlist[ $index ] = null; // Or handle the missing field differently
        }
    } else {
        if ( isset( $value[ $index_key ] ) ) {
            $index = $value[ $index_key ];
        } else {
            $index = null; // Or handle the missing index key differently
        }

        if ( isset( $value[ $field ] ) ) {
            $newlist[ $index ] = $value[ $field ];
        } else {
            $newlist[ $index ] = null; // Or handle the missing field differently
        }
    }
}

和情况一类似，遍历 $list 中的每个元素 $value。
同样判断 $value 是对象还是数组，并根据类型选择访问字段的方式。
首先，提取 $index_key 对应的值，作为 $newlist 的键 $index。
然后，提取 $field 对应的值，作为 $newlist 中键为 $index 的元素的值。
最终，$newlist 会成为一个关联数组，键是 $index_key 对应的值，值是 $field 对应的值。

返回结果： return $newlist;
- 函数返回提取后的 $newlist 数组。

用例演示，一目了然：

为了更好地理解，让我们来看几个实际的例子。

例子 1：提取用户邮箱（没有 $index_key）

假设我们有以下用户数据：

$users = array(
    (object) array( 'id' => 1, 'name' => '张三', 'email' => '[email protected]' ),
    (object) array( 'id' => 2, 'name' => '李四', 'email' => '[email protected]' ),
    (object) array( 'id' => 3, 'name' => '王五', 'email' => '[email protected]' ),
);

要提取所有用户的邮箱地址，可以这样使用 wp_list_pluck()：

$emails = wp_list_pluck( $users, 'email' );
print_r( $emails );

输出结果：

Array
(
    [0] => [email protected]
    [1] => [email protected]
    [2] => [email protected]
)

例子 2：提取用户邮箱，并以用户 ID 作为键（有 $index_key）

还是上面的用户数据，这次我们想以用户 ID 作为键，邮箱地址作为值。

$emails = wp_list_pluck( $users, 'email', 'id' );
print_r( $emails );

输出结果：

Array
(
    [1] => [email protected]
    [2] => [email protected]
    [3] => [email protected]
)

例子 3：处理数组数据

wp_list_pluck() 同样可以处理数组的数组。

$data = array(
    array( 'id' => 1, 'name' => '苹果', 'price' => 5 ),
    array( 'id' => 2, 'name' => '香蕉', 'price' => 3 ),
    array( 'id' => 3, 'name' => '橙子', 'price' => 4 ),
);

$prices = wp_list_pluck( $data, 'price', 'name' );
print_r( $prices );

输出结果：

Array
(
    [苹果] => 5
    [香蕉] => 3
    [橙子] => 4
)

性能考量：array_column() vs wp_list_pluck()

你可能已经注意到，wp_list_pluck() 的功能和 PHP 内置函数 array_column() 很相似。那么，我们应该选择哪个呢？

array_column(): PHP 5.5+ 引入，性能更好，更简洁。
wp_list_pluck(): WordPress 自带，兼容性更好（支持 PHP 5.3+），并且在对象和数组之间做了兼容处理。

通常情况下，如果你的项目运行在 PHP 5.5 或更高版本上，并且只需要处理数组，那么 array_column() 是更好的选择。但是，如果你的项目需要兼容更老的 PHP 版本，或者需要处理对象和数组混合的数据，那么 wp_list_pluck() 仍然是一个不错的选择。

为了更直观地比较，我们用表格来总结一下：

特性	`array_column()`	`wp_list_pluck()`
PHP 版本	5.5+	5.3+
对象支持	不支持	支持
性能	更优	稍逊
兼容性	较差	较好
是否 WordPress 自带	否	是

高级用法：自定义字段不存在时的处理

在实际应用中，我们可能会遇到某些对象或数组缺少指定字段的情况。 wp_list_pluck() 默认会返回 null。如果我们想自定义处理方式，可以修改源码（不推荐，升级 WordPress 会覆盖），或者在函数调用后进行处理。

例如，我们可以使用 array_map() 函数，将 null 值替换为默认值：

$users = array(
    (object) array( 'id' => 1, 'name' => '张三', 'email' => '[email protected]' ),
    (object) array( 'id' => 2, 'name' => '李四', 'email' => null ), // 缺少邮箱
    (object) array( 'id' => 3, 'name' => '王五', 'email' => '[email protected]' ),
);

$emails = wp_list_pluck( $users, 'email' );

$emails = array_map( function( $email ) {
    return $email === null ? '未提供' : $email;
}, $emails );

print_r( $emails );

输出结果：

Array
(
    [0] => [email protected]
    [1] => 未提供
    [2] => [email protected]
)

总结：wp_list_pluck() 的价值

wp_list_pluck() 虽然只是一个简单的函数，但它在 WordPress 开发中扮演着重要的角色。它可以帮助我们：

简化代码： 避免手动循环遍历提取字段。
提高效率： 快速提取所需数据。
增强可读性： 使代码更清晰易懂。

掌握 wp_list_pluck()，就像拥有了一把锋利的瑞士军刀，可以轻松应对各种数据提取任务。

最后的彩蛋：wp_list_filter()

既然提到了 wp_list_pluck()，顺便提一下它的好兄弟 wp_list_filter()。顾名思义，wp_list_filter() 用于过滤对象或数组的数组。它可以根据指定的字段和值，筛选出符合条件的元素。

例如，我们可以使用 wp_list_filter() 筛选出所有 ID 大于 1 的用户：

$users = array(
    (object) array( 'id' => 1, 'name' => '张三', 'email' => '[email protected]' ),
    (object) array( 'id' => 2, 'name' => '李四', 'email' => '[email protected]' ),
    (object) array( 'id' => 3, 'name' => '王五', 'email' => '[email protected]' ),
);

$filtered_users = wp_list_filter( $users, array( 'id' => 1 ), '!=' ); // 筛选出id不等于1的用户
print_r( $filtered_users );

$filtered_users_greater_than_one = array_filter($users, function($user){
    return $user->id > 1;
});
print_r($filtered_users_greater_than_one);

输出结果：

Array
(
    [1] => stdClass Object
        (
            [id] => 2
            [name] => 李四
            [email] => [email protected]
        )

    [2] => stdClass Object
        (
            [id] => 3
            [name] => 王五
            [email] => [email protected]
        )

)
Array
(
    [1] => stdClass Object
        (
            [id] => 2
            [name] => 李四
            [email] => [email protected]
        )

    [2] => stdClass Object
        (
            [id] => 3
            [name] => 王五
            [email] => [email protected]
        )

)

wp_list_filter() 和 wp_list_pluck() 就像一对黄金搭档，可以帮助我们轻松完成各种数据处理任务。掌握它们，你的 WordPress 开发技能将更上一层楼！

本次讲座到此结束，感谢大家的聆听！希望大家有所收获，并在实际项目中灵活运用 wp_list_pluck() 和 wp_list_filter()，让你的代码更加优雅、高效！记住，代码的世界，没有最好，只有更好！不断学习，不断进步，才能成为真正的代码大师！

发表回复 取消回复

发表回复取消回复