add_query_arg

パラメータ

• $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