WordPress 常用函数中文翻译

WordPress为我们提供了丰富的函数,方便我们对WordPress进行定制,开发WordPress主题或插件,我们会在这里把经常使用的函数文档翻译成中文,加上使用总结和代码示例,方便后续查阅。

wp_remote_get 发送 GET 请求到 URL 并返回数据

函数功能 使用GET方法执行HTTP请求并返回其响应。 函数参数 参数 数据类型 是否必需 描述 默认值 $url 字符串 是 请求 URL 无 $args 数组 否 请求参数 array() 函数返回值 成功时,返回一个数组,失败时,返回一个 WP_Error 对象 使用示例 发送 HTTP 请求时,我们可以通过该函数的 $args 参数来设置 HTTP 的各种参数,包括超时时间,HTTP 版本,Headers 等信息。 请求时设置超 […]

wp_remote_post 发送 HTTP POST 请求并返回相应

函数功能 使用POST方法执行HTTP请求并返回其响应数据。 参数 参数 数据类型 是否必需 描述 默认值 $url 字符串 是 请求 URL 无 $args 数字 否 请求参数 array() 返回值 响应数组,如果出错,返回 WP_Error 对象 使用示例 发送的Post数据应该在 body 中提供,body 不一定是数组,也可以是 XML 或 JSON 格式的字符串或其他可以通过 HTTP 协议发送的数据。 在请求中添加基础授权 […]

remove_query_arg 从URL中从移除查询字符串生成新的URL

参数 $key:(string|array) (必需) 需要移除的查询键 $query:(bool|string) (可选) false 时使用当前 URL,默认为 false 参数 数据类型 是否必需 描述 默认值 $key 字符串|数组 是 需要移除的查询键 无 $query 布尔值|字符串 否 留空时使用当前URL false 返回值 返回值为新的 URL 字符串 使用示例 假设当前页面的 URL 为:http […]

nav_menu_submenu_css_class Filter 修改子菜单 class

功能 过滤应用于菜单列表元素的CSS类。 参数 参数 数据类型 描述 $classes 数组 应用于菜单的CSS类数组 $args stdClass wp_nav_menu() 参数的对象 $depth 整数 菜单深度,用于菜单级别和锁进 代码示例 需要修改 has-submenu 菜单类是,使用此 filter 修改,以适应我们的前端代码。

wp_nav_menu_items 修改导航菜单项目的 HTML 内容

函数描述 修改导航菜单的HTML列表内容。 函数参数 参数 数据类型 描述 $items 字符串 菜单项目的 HTML 列表内容。 $args stdClass 包含 wp_nav_menu() 的对象。 $items:(字符串) 菜单项目的 HTML 列表内容。 $args:(stdClass) 包含 wp_nav_menu() 的对象。 使用示例 假如,我们需要添加一个「登录/我的账户链接」到导航菜单,因为我们要根据用户登录状态判断 […]

add_query_arg 添加自定义查询参数生成新的 URL

函数功能描述 给一个 URL 添加新的查询参数获取新的 URL。 我们可以使用此功能重建URL,或添加新的查询参数到URL,也可以获取带查询参数的完整URL。 添加一个键值对或者一个关联数组,设置键的值为假可以出URL移除该查询字符串。用 $_SERVER 值省略旧的查询或 URI(第二或第三个参数)。 使用说明 参数 参数 数据类型 是否必需 描述 默认值 $param1 整数|字符串|数字 是 新的查询字符串或数组 无 $param […]

wp_redirect | wp_safe_redirect 重定用户到指定页面

功能描述 跳转用户到指定的URL,URL 必须是完整的绝对 URL。 使用说明 wp_redirect() 不会自动退出,使用时需要在后面添加退出函数。如下: 参数 参数 数据类型 是否必需 描述 默认值 $location 字符串 是 用户将被重定向到的绝对URL 无 $status 整数 否 重定向 HTTP 状态码 302 返回值 如果 $location 没有设置,返回false,其他情况下不返回任何值 使用示例 也可以跳转到外 […]

get_query_var 获取WordPress查询变量

功能描述 获取全局变量 $wp_query 对象使用的 WP_Query 类中的公开查询参数。 使用说明 参数 参数 数据类型 是否必需 描述 默认值 $var 字符串 是 需要获取的查询变量的名称 无 返回值 (mixed)返回参数值,如果参数没有设置,返回空 使用示例 获取当前分页数 想要获取静态首页 (或页面模板) 的分页数,我们必须使用 ‘page’ 查询参数: 注意:查询参 […]

get_current_user_id 获取当前用户 ID

函数描述 返回当前用户 ID,需要在 Init 或之后的 Action 中调用此函数,否则可能获取不到正确的用户 ID. 使用方法 返回值 返回 int 类型的用户 ID,如果获取不到,返回 0。