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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

5.3の新機能:サイト管理者のメールアドレスを定期的に確認する(2019年9月27日 更新)

WordPress 5.3 Beta 1」に記載されていた「Admin Email Verification」の項目が目に留まる。管理者のメールアドレスを定期的に確認するという仕組みがどんなものなのか気になったので、ちょっと調べてみた。

3.6リリース直前チェック(2013年7月26日 更新)

$wpdbは、WordPressのデータベースにアクセスする際に使用できる便利なオブジェクト。独自テーブルの利用やデータ検索の最適化など、標準提供される関数では実現できないことを手助けしてくれる。そんな$wpdbのescapeメソッドが3.6で非推奨(deprecated)になる。

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

購読者は管理者ページのアクセス禁止(2013年11月12日 更新)

購読者(subscriber)は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。