📌  相关文章
📜  add_query_arg wordpress (1)

📅  最后修改于: 2023-12-03 15:29:17.631000             🧑  作者: Mango

add_query_arg WordPress 函数介绍

简介

add_query_arg 是 WordPress 中的一个核心函数，用于将 URL 查询参数添加到给定的 URL 中。该函数是 WordPress 中处理 URL 的核心函数之一。

语法

add_query_arg( $key, $value, $url )

参数

  • $key (string) (Required) 查询参数的名称。

  • $value (string) (Optional) 查询参数的值。如果省略，则查询参数将存在但将没有值。

  • $url (string|null) (Optional) 要添加查询参数的 URL。如果为空，则默认为当前页面的 URL。

返回值

一个包含新的查询参数的 URL 字符串。

使用方法

add_query_arg() 常用于构建带有查询参数的 URL。例如：

$url = add_query_arg( 'arg1', 'value1', 'http://example.com/my-page' );

这会在 URL 后添加查询参数 ?arg1=value1。如果 $url 参数为空，则默认使用当前页面的 URL。

您还可以同时添加多个查询参数，例如：

$args = array(
    'arg1' => 'value1',
    'arg2' => 'value2',
    'arg3' => 'value3',
);
$url = add_query_arg( $args, 'http://example.com/my-page' );

这会在 URL 后添加查询参数 ?arg1=value1&arg2=value2&arg3=value3。

示例代码
// 添加单个查询参数
$url = add_query_arg( 'arg1', 'value1', 'http://example.com/my-page' );
echo $url; // 输出：http://example.com/my-page?arg1=value1

// 添加多个查询参数
$args = array(
    'arg1' => 'value1',
    'arg2' => 'value2',
    'arg3' => 'value3',
);
$url = add_query_arg( $args, 'http://example.com/my-page' );
echo $url; // 输出：http://example.com/my-page?arg1=value1&arg2=value2&arg3=value3
建议

  • 在使用 add_query_arg() 时，请注意过滤所有用户输入内容，以避免安全风险。

  • 在添加查询参数时，请注意查询参数名称和值是否符合 URI 规范。例如，应避免使用特殊字符，如空格和斜杆。为了避免这些问题，您可以使用 urlencode() 函数对查询参数进行编码。

  • 如果您需要在添加查询参数时使用当前页面的 URL，您可以将 $url 参数设置为空字符串，例如：

$url = add_query_arg( 'arg1', 'value1', '' );

这将在当前页面的 URL 后添加查询参数。

参考文献