WordPress 常用函数中文翻译

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

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

函数描述 修改导航菜单的HTML列表内容。 函数参数 参数数据类型描述$items字符串菜单项目的 HTML 列表内容。$argsstdClass包含 wp_nav_menu() 的对象。 $items:(字符串) 菜单项目的 HTML 列表内容。 $args:(stdClass)…

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

函数功能描述 给一个 URL 添加新的查询参数获取新的 URL。 我们可以使用此功能重建URL,或添加新的查询参数到URL,也可以获取带查询参数的完整URL。 添加一个键值对或者一个关联数组,设置键的值为假可以出URL移除该查询字符…

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

功能描述 跳转用户到指定的URL,URL 必须是完整的绝对 URL。 使用说明 wp_redirect() 不会自动退出,使用时需要在后面添加退出函数。如下: wp_redirect( $location, $status ); exit; 参数 参数数据类型是否必需描…

get_query_var 获取WordPress查询变量

功能描述 获取全局变量 $wp_query 对象使用的 WP_Query 类中的公开查询参数。 使用说明 get_query_var( $var ); 参数 参数数据类型是否必需描述默认值$var字符串是需要获取的查询变量的名称无 返回值 (mixed…

get_current_user_id 获取当前用户 ID

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

get_currentuserinfo 获取当前登录用户的信息

从 WordPress 4.5 开始,这个函数已经被弃用了,请使用 wp_get_current_user() 函数替代。 函数描述 获取当前登录用户的信息并存入 $userdata 全局变量中,属性和 wp_users 数据表对应。同时也把以下信息存入对应的全局变量…

wp_set_current_user 设置当前用户,不会自动登录该用户

函数描述 此函数可以被插件替换,如果没有插件替换,则使用 WordPress 内置的函数,函数的作用是通过用户 ID 或名称修改当前用户。如果不知道用户ID,设置 $id 为 null 然后指定一个用户名称。 一些 WordPress 功能需…

get_current_screen 获取仪表盘中当前页面信息

函数描述 该函数返回一个包含当前页面 ID 的对象,如:base, post type, 或 taxonomy, 以及其他类型的名称 使用方法 $screen = get_current_screen(); 使用限制 该函数在很多管理页面中都有定义,但并不是所有页面,这…

wp_get_current_user 获取当前登录的用户对象

函数描述 获取当前登录的用户对象 (WP_User),是 get_currentuserinfo() 函数的封装,使用全局变量 $current_user 使用方法 wp_get_current_user(); WordPress 版本 3.4 以下:在 init 或之后调…

get_user_by 通过用户的某属性字段获取用户数据对象

函数描述 通过用户的某属性字段获取用户数据对象,可用的属性为下面几种的任意一个,分别对应 wp_users 数据表的的相应列。 'id' - 用户 ID'slug' - user_nicename 用户昵称'email' - user_email 用户电子邮件'login' - use…

current_user_can 判断用户是否有某个权限或是否为某个角色

函数描述 判断用户是否有某个权限或是否为某个角色,比如我们需要判断当前登录的用户是否为管理员,或者是否有作者权限。 使用方法 current_user_can( $capability, $args ); 参数 参数数据类型是否必需描述默认值$capa…