WordPress 常用函数中文翻译

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

get_transient 获取瞬态数据

该函数用来获取瞬态数据的值,如果瞬态数据不存在、没有值或已过期,则返回值将为false。 函数参数 参数 数据类型 是否必需 描述 默认值 $transient 字符串 是 瞬态数据名称,预计不会被 SQL 转义 无 函数返回值 如果获取成功,返回瞬态数据的值,如果值不存在或已过期,返回false。 使用示例 下面的示例中,我们先尝试获取瞬态数据 special_query_results 的值,如果不存在,我们新建了一个 WP_Que […]

set_transient 设置或更新瞬态数据的值

在WordPress中设置或更新瞬态数据的值,经常用来保存一些不需要一直存在的数据。 函数参数 参数 数据类型 是否必需 描述 默认值 $transient 字符串 是 瞬态数据名称,长度不得超过 172 个字符。 无 $value 多种 是 瞬态数据的值,如果是非标量,必需是可以被序列化的 无 $expiration 整数 否 过期时间,以秒为单位 0 函数返回值 设置成功返回 true,否则返回 false 使用示例 下面的示例中, […]

sanitize_file_name 清理文件名称,用横线代替空格

删除文件名中的非法特殊字符和需要转义才能在命令行中显示的特殊字符,用英文破折号替换空格和连续破折号,删除文件名开头和结尾的句号、破折号和下划线。此函数不保证能返回允许上传的文件名。 函数参数 参数 数据类型 是否必需 描述 默认值 $filename 字符串 是 需要清理的文件名 无 函数返回值 返回清理后的文件名。 更多说明 可以通过sanitize_file_name_chars过滤器修改不允许在文件名中出现的字符。该函数清理文件名 […]

pre_get_posts Action —— 在创建查询变量之后、运行实际查询之前触发的操作

pre_get_posts Action主要用来修改主查询,经常在需要修改主文章查询时使用,可以让我们不用创建自定义查询来得到我们需要的文章内容。 参数 该Action只有一个参数,就是通过引用传递的$wp_query 对象。 使用示例 下面是几个使用示例,可以帮我我们快速了解 pre_get_posts Action 的使用方法。 在首页文章中排除ID位7、11 的文章。 在搜索结果中排除页面、只搜索文章内容。

remove_menu_page 移除后台菜单

函数功能 移除WordPress后台顶级菜单。 函数参数 参数 数据类型 是否必需 描述 默认值 $menu_slug 字符串 是 菜单Slug 无 函数返回值 如果成功,返回移除的菜单数据,失败返回 false 使用示例 函数需要挂载到 admin_init 钩子上才能生效。下面的例子中,我们移除了 wpcf7菜单。 相关函数 remove_submenu_page 功能和 remove_menu_page 类似,不同的是多了一个父级 […]

register_block_pattern 注册自定义Pattern

函数功能 注册自定义Pattern 到WordPress古腾堡编辑器。 函数参数 参数 数据类型 是否必需 描述 默认值 $pattern_name 字符串 是 包含命名空间的Pattern名称 无 $pattern_properties 数组 是 包含Pattern属性的数组。 无 $pattern_properties 数组可以包含以下几项数据。 参数 数据类型 是否必需 描述 title 字符串 是 模式标题 content 字符 […]

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 […]