詳解WordPress中用於合成數組的wp_parse_args函數

WBOY
發布: 2016-07-29 09:09:57
原創
1127 人瀏覽過

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

(陣列)(數組參數)的預設參數(數組參數)。

預設值:空字串

範例

function explain_parse_args( $args = array() ){
 
  //$args 的默认值
  $defaults = array(
    'before' => '<div>',
    'after' => '</div>',
    '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();//打印:<div>wp_parse_args() 函数演示</div>
 
//字符串参数
$output = explain_parse_args( 'text=字符串参数&before=<div>&echo=0' );
echo $output;//打印:<div>字符串参数</div>
 
//数组参数
explain_parse_args( array( 'text' => '数组参数', 'before' => '<div>' ) );//打印:<div>数组参数</div>
还有另一种不使用第二个 $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 函式的來源程式碼比較簡單,
文此函數的原始碼:

/**
 * 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教程有興趣的朋友有所幫助。

相關標籤:
來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板