set_current_screen()
云策文档标注
概述
set_current_screen() 函数用于设置当前屏幕对象,通常用于 WordPress 后台管理界面。它接受一个可选参数来指定屏幕,并调用 WP_Screen 类的相关方法。
关键要点
- 函数参数:$hook_name(字符串或 WP_Screen 对象),可选,用于确定屏幕或传递现有屏幕对象。
- 函数实现:通过 WP_Screen::get($hook_name)->set_current_screen() 来设置当前屏幕。
- 相关函数:WP_Screen::get() 用于获取屏幕对象。
- 使用场景:在 AJAX 操作如搜索插件、处理仪表板小部件时使用。
- 版本历史:自 WordPress 3.0.0 版本引入。
原文内容
Set the current screen object
Parameters
$hook_namestring|WP_Screenoptional-
The hook name (also known as the hook suffix) used to determine the screen, or an existing screen object.
Source
function set_current_screen( $hook_name = '' ) {
WP_Screen::get( $hook_name )->set_current_screen();
}
Changelog
| Version | Description |
|---|---|
| 3.0.0 | Introduced. |