add_query_arg 添加自定义查询参数生成新的 URL-鲍成龙创作记录

鲍成龙

开发中，总是需要给 url 拼接参数，为此，WordPress 非常贴心的提供了一个函数 add_query_arg，给一个 URL 添加新的查询参数获取新的 URL。我们可以使用此功能重建 URL，或添加新的查询参数到 URL，也可以获取带查询参数的完整 URL。添加一个键值对或者一个关联数组，设置键的值为假可以出 URL 移除该查询字符串。用 $_SERVER 值省略旧的查询或 URI（第二或第三个参数）。

add_query_arg( 'key', 'value', 'https://baochenglong.cn/' );
 
add_query_arg( array(
    'key1' => 'value1',
    'key2' => 'value2',
), 'https://baochenglong.cn/' );

dd_query_arg 绝不仅仅是把参数拼接到 URL 尾部，还做了很多兼容，优化，安全等工作。另外，WordPress 官方强烈建议，对返回的 url ，要使用 esc_url 进行处理。如果，我们自己拼接 url 基本不可能考虑的这么周全，所以，强烈建议使用 add_query_arg 拼接 url。

参数	数据类型	是否必需	描述	默认值
$param1	整数｜字符串｜数字	是	新的查询字符串或数组	无
$param2	整数｜字符串｜数字	否	新的查询字符串值，如果$param1 是关联数组，此参数为原 URL	无
$old_query_or_uri	字符串｜布尔值	否	原查询字符串或 URL	$_SERVER[REQUEST_URI]

使用举例：

假设我们当前在 WordPress 页面： “http://example.com/client/?s=word”…

// 下面将输出 '/client/?s=word&foo=bar'
echo add_query_arg( 'foo', 'bar' );
 
// 下面将输出 '/client/?s=word&foo=bar&baz=tiny'
$arr_params = array( 'foo' => 'bar', 'baz' => 'tiny' );
echo add_query_arg( $arr_params );

很多时候你可能发现你想使用下面的方法在你所在的当前页面添加查询参数，这中情况下，你可以使用你需要修改的 URL 作为最后一个参数。

// 下面将输出 'http://example.com/2023/06/23/?hello=world'
echo add_query_arg( 'hello', 'world', 'http://example.com/2023/06/23/' );

因为 get_permalink() 函数返回的是一个完整的 URL，在需要修改文章页面时，你可以使用这个函数作为最后一个参数。

// 下面将输出添加查询字符串：?hello=there 后的 id 为 9 的文章的链接。
echo add_query_arg( 'hello', 'there', get_permalink(9) );

通过关联数组删除和添加查询字符串：

$query = 'http://example.com/link?foo=bar';
$new_query = add_query_arg( array('foo' => false, 'baz' => 'qux'), $query );
// 结果：http://example.com/link?baz=qux

1年前