這篇文章主要介紹了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();//打?。?lt;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;//打?。?lt;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函數用是將兩個或多個數組的單元合并起來，一個數組中的值附加在前一個數組的后面。返回作為結果的數組。