wp_parse_args()


WordPressの関数wp_parse_args()は、配列またはクエリ文字列の形式で渡された引数を解析し、デフォルト値とマージして返します。

シンタックス

wp_parse_args( mixed $args, array|string $defaults = '' );

引数の説明:

  • $args (mixed) — 解析される引数。配列またはクエリ文字列。
  • $defaults (array|string) — デフォルト値を指定する配列またはクエリ文字列。

例1: 配列の引数をデフォルト値とマージ

以下のコードでは、デフォルト値を指定し、引数をマージします。

<?php
$args = wp_parse_args( array( 'color' => 'red' ), array( 'color' => 'blue', 'size' => 'medium' ) );
print_r( $args );
?>

例2: クエリ文字列の引数を解析

クエリ文字列を解析して、デフォルト値とマージします。

<?php
$args = wp_parse_args( 'color=red&size=large', array( 'color' => 'blue', 'size' => 'medium' ) );
print_r( $args );
?>

例3: 空のデフォルト値を使用

デフォルト値がない場合でも引数を解析します。

<?php
$args = wp_parse_args( 'color=green' );
print_r( $args );
?>

例4: 関数内での使用

このコードはwp_parse_args()を関数内で使用し、引数をカスタマイズします。

<?php
function my_custom_function( $args ) {
    $defaults = array( 'width' => 100, 'height' => 200 );
    $args = wp_parse_args( $args, $defaults );
    return $args;
}
print_r( my_custom_function( array( 'width' => 300 ) ) );
?>

例5: テーマカスタマイザーでの使用

wp_parse_args()を使ってテーマオプションの引数をデフォルト設定とマージします。

<?php
$options = wp_parse_args( get_option( 'theme_options' ), array( 'header_color' => 'white', 'footer_color' => 'black' ) );
print_r( $options );
?>

注意点:

引数が配列でない場合、自動的にクエリ文字列として解析されるため、データ形式を事前に確認することが推奨されます。

関連機能：