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



お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

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

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

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。