详解WordPress中用于合成数组的wp_parse_args()函数

这篇文章主要介绍了WordPress中用于合成数组的wp_parse_args()函数,转换成数组通常是为了方便查询,需要的朋友可以参考下。

wp_parse_args() 函数是 WordPress 核心经常用到的函数，它的用途很多，但最主要用来给一个数组参数（args）绑定默认值。

因为 wp_parse_args() 函数返回的一定是一个数组，所以他会把传入查询字符串和对象（object）自动转换成数组，给了使用者更加方便的条件，也增加了兼容性。

常见的 query_posts()、wp_list_comments() 和 get_terms() 函数都使用了 wp_parse_args() 函数来帮它给数组参数添加默认值。

用法：

wp_parse_args( $args, $defaults );

参数

$args

（数组 | 字符串）（必须）查询字符串、对象或者数组参数，用来绑定默认值。

默认值：None

查询字符串：

type=post&posts_per_page=5&cat=1

数组：

array( 'type' => 'post', 'posts_per_page' => 5, 'cat' => '1' )

$defaults

（数组）（可选）数组参数的默认参数。

默认值：空字符串

例子：

1. function explain_parse_args( $args = array() ){ 
2.    
3.   //$args 的默认值 
4.   $defaults = array( 
5.     'before' => '<div class="box">', 
6.     'after' => '</div>', 
7.     'echo' => true, 
8.     'text' => 'wp_parse_args() 函数演示' 
9.   ); 
10.    
11.   //绑定默认值 
12.   $r = wp_parse_args( $args, $defaults ); 
13.    
14.   $output = $r['before'] . $r['text'] . $r['after']; 
15.   if( !$r['echo'] ) return $output; 
16.   echo $output; 
17. } 
18.    
19. //没有参数 
20. explain_parse_args();//打印：<div class="box">wp_parse_args() 函数演示</div> 
21.    
22. //字符串参数 
23. $output = explain_parse_args( 'text=字符串参数&before=<div class="box-2">&echo=0' ); 
24. echo $output;//打印：<div class="box-2">字符串参数</div> 
25.    
26. //数组参数 
27. explain_parse_args( array( 'text' => '数组参数', 'before' => '<div class="box-3">' ) );//打印：<div class="box-3">数组参数</div> 

还有另一种不使用第二个 $defaults 参数的用法，就是帮你把一个查询字符串、对象或者数组的变量直接转换成通用的数组，避免判断类型。

1. //字符串 
2. $array = wp_parse_args( 'text=测试另一种用法&type=字符串' ); 
3. var_dump( $array ); 
4. /* 
5.   array(2) { 
6.     ["text"]=> 
7.       string(21) "测试另一种用法" 
8.     ["type"]=> 
9.       string(9) "字符串" 
10.   } 
11. */ 
12.    
13. //对象（object） 
14. class args_obj{ 
15.    
16.   public $text = '测试另一种用法'; 
17.    
18.   public $type = '对象（object）'; 
19.    
20.   function func(){ 
21.     //转换成数组的时候对象里边的函数会被忽略 
22.   } 
23.    
24. } 
25. $obj = new args_obj; 
26. var_dump( $obj ); 
27. /* 
28. object(args_obj)#2175 (2) { 
29.   ["text"]=> 
30.     string(21) "测试另一种用法" 
31.   ["type"]=> 
32.     string(18) "对象（object）" 
33. } 
34. */ 

wp_parse_args函数源代码详解

wp_parse_args 函数的源代码比较简单，依附于PHP 内置函数get_object_vars、array_merge与WordPress的wp_parse_str函数来实现，以下是该函数的源代码：

1. /** 
2.  * Merge user defined arguments into defaults array. 
3.  * 
4.  * This function is used throughout WordPress to allow for both string or array 
5.  * to be merged into another array. 
6.  * 
7.  * @since 2.2.0 
8.  * 
9.  *第一个参数可以是 字符串、数组或对象（obj） 
10.  * @param string|array $args Value to merge with $defaults 
11.  *第二个参数为默认的预设值数组，必须是数组 
12.  * @param array $defaults Array that serves as the defaults. 
13.  *返回值将是一个数组 
14.  * @return array Merged user defined values with defaults. 
15.  */ 
16. function wp_parse_args( $args, $defaults = '' ) { 
17.  if ( is_object( $args ) ) 
18.  //将接收的对象（obj）转换为数组 
19.  $r = get_object_vars( $args ); 
20.  elseif ( is_array( $args ) ) 
21.  //如果是数组则不转换 
22.  $r =& $args; 
23.  else 
24.  //将接收的字符串转换为数组 
25.  wp_parse_str( $args, $r ); 
26.  if ( is_array( $defaults ) ) 
27.  return array_merge( $defaults, $r ); 
28.  return $r; 
29. } 

其中get_object_vars函数是用来返回由对象属性组成的关联数组。

array_merge函数用是将两个或多个数组的单元合并起来，一个数组中的值附加在前一个数组的后面。返回作为结果的数组。