WordPressで配列を合成するために使用されるwp_parse_args関数の詳細な説明

wp_parse_args() 関数は、WordPress のコアで頻繁に使用される関数であり、多くの用途がありますが、主にデフォルト値を配列パラメーター (args) にバインドするために使用されます。

wp_parse_args() 関数は配列を返す必要があるため、受信したクエリ文字列とオブジェクトを自動的に配列に変換し、ユーザーにより便利な条件を提供し、互換性を高めます。

共通の query_posts()、wp_list_comments()、get_terms() 関数はすべて、wp_parse_args() 関数を使用して、配列パラメータにデフォルト値を追加します。

使用法

wp_parse_args( $args, $defaults );

パラメータ

$args

(配列 | 文字列) (必須) デフォルト値をバインドするために使用されるクエリ文字列、オブジェクト、または配列パラメータ。

デフォルト: なし

クエリ文字列:

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 関数のソースコードの詳細 この関数のソースコード:

/**
 * 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 関数は、2 つ以上の配列のセルを結合するために使用され、1 つの配列の値が前の配列に追加されます。結果の配列を返します。

上記では、WordPress で配列を合成するために使用される wp_parse_args 関数の詳細な説明を、関連する内容も含めて紹介しました。PHP チュートリアルに興味のある友人に役立つことを願っています。