add_query_arg

説明

string add_query_arg( mixed $param1 [ , mixed $param2 [ , mixed $param3 ] ] )
クエリーURIを更新する。

パラメータ

  • $param1
    キー名または更新するキー名と値を含んだ連想配列
  • $param2
    キー名に対応する値またはクエリーURIを指定
  • $param3
    クエリーURIを指定

返り値

更新されたクエリーURIを返す。

注意

パラメータ$param2$param3を省略した場合は、$_SERVER['REQUEST_URI']が更新対象となる。
クエリーURIにキー名のパラメータがある場合は値を更新し、ない場合は追加する。また第1パラメータがキー名で第2パラメータに値としてfalseまたはnullを指定した場合は、そのパラメータ(キー=値)がクエリーURIから削除される。

使用例

  • $_SERVER['REQUEST_URI']に's=keyword'を追加(更新)する(1)。
    <?php $new_uri = add_query_arg( 's', 'keyword' ); ?>
  • $_SERVER['REQUEST_URI']に's=keyword'を追加(更新)する(2)。
    <?php $new_uri = add_query_arg( 's', 'keyword', $_SERVER['REQUEST_URI'] ); ?>
  • $_SERVER['REQUEST_URI']に's=keyword&paged=2'を追加(更新)する(1)。
    <?php $new_uri = add_query_arg( array( 's'=>'keyword', 'paged'=>2 ) ); ?>
  • $_SERVER['REQUEST_URI']に's=keyword&paged=2'を追加(更新)する(2)。
    <?php $new_uri = add_query_arg( array( 's'=>'keyword', 'paged'=>2 ), $_SERVER['REQUEST_URI'] ); ?>
  • $_SERVER['REQUEST_URI']からキー名's'のパラメータを削除する(1)。
    <?php $new_uri = add_query_arg( 's' ); ?>
  • $_SERVER['REQUEST_URI']からキー名's'のパラメータを削除する(2)。
    <?php $new_uri = add_query_arg( 's', false ); ?>
  • $_SERVER['REQUEST_URI']からキー名's'のパラメータを削除する(3)。
    <?php $new_uri = add_query_arg( 's', false, $_SERVER['REQUEST_URI'] ); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/functions.php

最終更新 : 2013年01月22日 17:55



お勧め

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

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

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

32ピクセルのサイトアイコンを別の画像ファイルに変更する(2018年5月27日 更新)

「サイトアイコン」は4.3の新機能の1つ。管理画面で適当な画像ファイルを指定するだけでサイトアイコンが適用されます。そんなサイトアイコンで、既存の favicon.ico を併用する方法を紹介します。