wp_parse_args

説明

array wp_parse_args( mixed $args, mixed $defaults = '' )
クエリー文字列を解析し、各パラメータのデフォルト値とマージした連想配列を取得する。

パラメータ

  • $args
    パラメータとなる連想配列またはオブジェクト、クエリー文字列の何れかを指定。
  • $defaults
    デフォルトのパラメータ値の連想配列を指定(省略時は'')。

返り値

結合した連想配列を返す。

注意

パラメータ$argsに'post=44&action=edit'、$defaultsがarray( 'post'=>0,'action'='new', 'post_type'=>'post' )の場合、この関数の戻り値は次のようになる。
array( 'post' => 44, 'action' => 'edit', 'post_type' => 'post' )

使用例

  • クエリー文字列が格納された変数$argsの内容を解析した連想配列を取得する。
    <?php $args = wp_parse_args( $args ); ?>
  • 変数$argsとデフォルトパラメータの連想配列を結合したパラメータ全種の連想配列を取得する。
    <?php $args = wp_parse_args( $args, array( 'type'=>'', 'number'=>10, 'status'=>'publish' ) ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/functions.php

最終更新 : 2012年07月19日 17:11



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。