WordPress 内置的数组处理相关函数大全

我们使用 WordPress 开发的时候,有很大一部分的工作和数组处理有关,WordPress 本身也内置了一些非常方便的数组处理函数,今天给大家罗列一下,也方便自己以后写代码的时候查询。 🙂

wp_parse_args

wp_parse_args($args, $defaults=[])

将用户定义的参数($args)合并到默认的参数($defaults)中,用户自定义的参数可以是数组,也可以是对象,甚至支持链接地址查询类型的字符串(比如:"id=5&status=draft")。

$args = wp_parse_args($args, [
	'post_type'			=> 'post',
	'posts_per_page'	=> 5,
	'cat' 				=> 1
]);

也可以使用该函数将链接地址查询类型的字符串转换成数组:

$args = wp_parse_args('post_type=post&posts_per_page=5&cat=1');

// 输出 Array ( [type] => post [posts_per_page] => 5 [cat] => 1 )

wp_parse_list

wp_parse_list( $list )

将逗号或者空格隔开的标量转换成数组。

wp_parse_list('1 2,3 abc');

// 输出 Array ( [0] => 1 [1] => 2 [2] => 3 [3] => abc )

wp_parse_id_list

wp_parse_id_list($list)

将多个 ID 组成数组,或者逗号或者空格隔开的 ID 列表,转换过一个纯数字没有重复的 ID 数组。

wp_parse_id_list(array( 1, 13, '11', 13 ))

或者

wp_parse_id_list('1, 13 11, 13')

这两个都输出:

// Array ( [0] => 1 [1] => 13 [2] => 11 )

wp_parse_slug_list

wp_parse_slug_list($list)

将多个字符串组成的数组,或者逗号或者空格分隔的字符串列表,转换过一个别名(slug)(对数组每个元素调用 sanitize_title 处理)的数组。

用法和 wp_parse_id_list 类似,这里就不再重复。

wp_array_slice_assoc

wp_array_slice_assoc( $array, $keys )

根据给定的键值列表从关联数组中获取相关的子数组。这个非常好理解:

$array = array(
	1 => 'Item 1',
	2 => 'Item 2',
	3 => 'Item 3',
	4 => 'Item 4',
	5 => 'Item 5',
);

wp_array_slice_assoc($array, array(1,3,5));

将会返回:

Array
(
    [1] => Item 1
    [3] => Item 3
    [5] => Item 5
)

wp_is_numeric_array

wp_is_numeric_array( $data )

判断数组是否数字索引的数组,非常简单,就不在举例了。

wp_list_filter

wp_list_filter($list, $args = array(), $operator = 'AND')

根据一组 key=>value 的参数,来过滤一组对象(或者数组)列表,比如下面就是 WordPress 查询到了多种 post_type 的日志列表结果,过滤出 page 类型的:

$pages = wp_list_filter( $wp_query->posts, array('post_type' => 'page'));

还有第三个元素 $openrator,它的默认值是 AND,还有 OR 和 NOT 这两个参数,意思是 $args 参数中的 key=>value 由多个的时候的比较方式,AND 就是所有都要相等,OR 只要一组值相等即可,NOT 所有的值都不相等才行。

当然我们也可以使用 PHP 的原生函数 array_filter 实现相同的功能。

wp_list_pluck

wp_list_pluck( $list, $field, $index_key = null )

从对象(或者数组)列表中每个元素中去某个字段组成一个新数组,最后一个参数是新数组的元素 key,使用原来列表元素的 $index_key 值,比如下面的数组:

$foods = array(
	array(
		'id'	=> 4,
		'name'	=> 'Banana',
		'color'	=> 'Yellow',
	),
	array(
		'id'	=> '5',
		'name'	=> 'Apple',
		'color'	=> 'Red',
	),
	array(
		'id'	=> 2,
		'name'	=> 'Lettuce',
		'color'	=> 'Green',
	),
	array(
		'id'	=> '7',
		'name'	=> 'Apple',
		'color'	=> 'Red',
	)
);

我们取出 'name' 列的值组成新数组:

$food_names = wp_list_pluck( $foods, 'name' );

将返回:

Array
(
    [0] => Banana
    [1] => Apple
    [2] => Lettuce
    [3] => Apple
)

如果我们想使用原来列表的每个元素的 id 作为 key

$food_names = wp_list_pluck( $foods, 'name', 'id' );

将得到:

Array
(
    [4] => Banana
    [5] => Apple
    [2] => Lettuce
    [7] => Apple
)

从 PHP 5.5 开始,PHP 的 array_column 函数也可实现同样的功能了。

wp_filter_object_list

wp_filter_object_list( $list, $args = array(), $operator = 'and', $field = false )

这个函数就是先 wp_filter_list 操作,然后如果 $field 参数值不为空,则再进行 wp_list_pluck 操作,不过它没有 wp_list_pluck 的 $index_key 参数。

wp_list_sort

wp_list_sort($list, $orderby = array(), $order = 'ASC', $preserve_keys = false)

根据 orderby 的参数对对象(或者数组)列表进行排序,最后一个参数 $preserve_keys 用于是否保持原来的 key。

比如我们可以把文章列表按照发布时间降序排序:

$sorted_posts = wp_list_sort( $posts, 'post_date', 'DESC' );

根据时间降序,然后根据标题升序排序:

$sorted_posts = wp_list_sort($posts, array(
	'post_date'		=> 'DESC',
	'post_title'	=> 'ASC',
));

map_deep

map_deep( $value, $callback )

将函数映射到数组或对象的所有不可迭代元素,有点类似于 array_walk_recursive() 函数,但是 map_deep 还支持对象:

比如,对数组或者对象的所有元素进行 URL 编码:

map_deep( $value, 'urlencode' )

所以 WordPress 基于 map_deep 创建几个深度映射回调的函数:

  • stripslashes_deep:对于是字符串元素执行去掉斜线操作。
  • urlencode_deep:对元素执行 URL 编码操作。
  • rawurlencode_deep:对元素执行 RAWURL 编码操作。
  • urldecode_deep:对元素执行 URL 解码操作。

当然我们也可以基于函数创建执行深度映射操作的函数。

关于 WordPress 内置的函数,我目前收集到就是那么多,如果你有发现什么好的函数也可以留言告诉我。

发表评论

您的电子邮箱地址不会被公开。