詳解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

（數組）（可選）數組參數的預設參數。

預設值：Null 字元串

例子

function explain_parse_args( $args = array() ){   //$args 的預設值  $defaults = array(    'before' => '',    'after' => '',    'echo' => true,    'text' => 'wp_parse_args() 函數示範'  );   //綁定預設值  $r = wp_parse_args( $args, $defaults );   $output = $r['before'] . $r['text'] . $r['after'];  if( !$r['echo'] ) return $output;  echo $output;} //沒有參數explain_parse_args();//列印：wp_parse_args() 函數示範 //字串參數$output = explain_parse_args( 'text=字串參數&before=&echo=0' );echo $output;//列印：字串參數 //數組參數explain_parse_args( array( 'text' => '數組參數', 'before' => '' ) );//列印：數組參數還有另一種不使用第二個 $defaults 參數的用法，就是幫你把一個查詢字串、對象或者數組的變數直接轉換成通用的數組，避免判斷類型。//字串$array = wp_parse_args( 'text=測試另一種用法&type=字串' );var_dump( $array );/*  array(2) {    ["text"]=>      string(21) "測試另一種用法"    ["type"]=>      string(9) "字串"  }*/ //對象（object）class args_obj{   public $text = '測試另一種用法';   public $type = '對象（object）';   function func(){    //轉換成數組的時候對象裡邊的函數會被忽略  } }$obj = new args_obj;var_dump( $obj );/*object(args_obj)#2175 (2) {  ["text"]=>    string(21) "測試另一種用法"  ["type"]=>    string(18) "對象（object）"}*/

wp_parse_args函數原始碼詳解
wp_parse_args 函數的原始碼比較簡單，
依附於PHP 內建函數get_object_vars、array_merge與WordPress的wp_parse_str函數來實現，
以下是該函數的原始碼：

/** * Merge user defined arguments into defaults array. * * This function is used throughout WordPress to allow for both string or array * to be merged into another array. * * @since 2.2.0 * *第一個參數可以是 字串、數組或對象（obj） * @param string|array $args Value to merge with $defaults *第二個參數為預設的預設值數組，必須是數組 * @param array $defaults Array that serves as the defaults. *傳回值將是一個數組 * @return array Merged user defined values with defaults. */function wp_parse_args( $args, $defaults = '' ) { if ( is_object( $args ) ) //將接收的對象（obj）轉換為數組 $r = get_object_vars( $args ); elseif ( is_array( $args ) ) //如果是數組則不轉換 $r =& $args; else //將接收的字串轉換為數組 wp_parse_str( $args, $r ); if ( is_array( $defaults ) ) return array_merge( $defaults, $r ); return $r;}

其中get_object_vars函數是用來返回由對象屬性群組成的關聯陣列。
array_merge函數用是將兩個或多個數組的單元合并起來，一個數組中的值附加在前一個數組的後面。返回作為結果的數組。

以上就介紹了詳解WordPress中用於合成數組的wp_parse_args函數，包括了方面的內容，希望對PHP教程有興趣的朋友有所協助。

