remove_query_arg()


WordPressのremove_query_arg()関数は、URLから特定のクエリ引数を削除するために使用されます。この関数は、動的にURLを生成したり操作したりする場合に役立ちます。

構文

remove_query_arg( mixed $key, string $url = '' );

引数の説明:

  • $key (mixed) — 削除するクエリ引数のキー名。文字列または配列を指定できます。
  • $url (string) — 操作対象のURL。指定しない場合は現在のURLが使用されます。

例 1: 単一のクエリ引数を削除

この例では、URLからexample_keyを削除します。

<?php echo remove_query_arg( 'example_key', 'https://example.com/?example_key=value&another_key=value2' ); ?>

例 2: 複数のクエリ引数を削除

この例では、複数の引数を削除します。

<?php echo remove_query_arg( array( 'key1', 'key2' ), 'https://example.com/?key1=value1&key2=value2&key3=value3' ); ?>

例 3: 現在のURLから引数を削除

現在のURLから特定の引数を削除します。

<?php echo remove_query_arg( 'session_id' ); ?>

例 4: 動的に生成されたURLを操作

動的に生成されたURLから特定の引数を削除します。

<?php
$url = add_query_arg( 'test_key', 'test_value', home_url() );
echo remove_query_arg( 'test_key', $url );
?>

例 5: 配列を使用して複数の引数を削除

配列形式で複数の引数を指定して削除します。

<?php
$query_args = array( 'param1', 'param2', 'param3' );
$url = 'https://example.com/?param1=value1&param2=value2&param3=value3';
echo remove_query_arg( $query_args, $url );
?>

注意点

  • この関数はURLが正しい形式であることを前提としています。無効なURLを渡すと予期しない動作を引き起こす可能性があります。
  • 現在のURLを操作する場合、サーバーの環境によっては正しく動作しない場合があります。その場合はURLを明示的に指定してください。

関連機能：