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



お勧め

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

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

ツイート引用が簡単になる仕組み(2012年6月8日 更新)

WordPress 3.4では、投稿記事の中にツイートのURLを記述するだけで、投稿ページにそれっぽい表示をしてくれるようになる。ちょっと気になったので、その仕組みを追っかけてみた。

5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)

WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。

サイトヘルス機能を使ってみた(2019年4月12日 更新)

先月末にWordPress 5.2 Beta1が、今日はWordPress 5.2 Beta2(以降5.2Beta2)が公開された。5.2ではブロックエディターの機能が強化され、サイトの安全性とパフォーマンス向上に役立つとされるサイトヘルス機能が追加される。

ブロックエディターで編集したページが出力した余分な改行を削除(2019年2月22日 更新)

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。