函数原型
add_contextual_help( string $screen, string $help )
函数描述
Add contextual help text for a page.
是否弃用
Warning: This function has been deprecated. Use WP_Screen::add_help_tab() instead.
函数参数
-
$screen
string
Required -
The handle for the screen to add help to. This is usually the hook name returned by the
add_*_page()
functions. -
$help
string
Required -
The content of an
'Overview'
help tab.
函数返回值
无
函数位置
File: wp-admin/includes/deprecated.php
.
函数源码
function add_contextual_help( $screen, $help ) {
_deprecated_function( __FUNCTION__, '3.3.0', 'get_current_screen()->add_help_tab()' );
if ( is_string( $screen ) )
$screen = convert_to_screen( $screen );
WP_Screen::add_old_compat_help( $screen, $help );
}
源码链接
变更日志
Version | Description |
---|---|
3.3.0 | Use WP_Screen::add_help_tab() |
2.7.0 | Introduced. |