contextual_help
Deprecated from version 3.3.0. It is no longer supported and can be removed in future releases. See
{@see get_current_screen()->add_help_tab()} or
{@see get_current_screen()->remove_help_tab()}
.Filters the legacy contextual help text.
Usage
add_filter( 'contextual_help', 'wp_kama_contextual_help_filter', 10, 4 ); /** * Function for `contextual_help` filter-hook. * * @param string $old_help Help text that appears on the screen. * @param string $screen_id Screen ID. * @param WP_Screen $screen Current WP_Screen instance. * @param $get_current_screen()->remove_help_tab() * * @return string */ function wp_kama_contextual_help_filter( $old_help, $screen_id, $screen, $get_current_screen()->remove_help_tab() ){ // filter... return $old_help; }
- $old_help(string)
- Help text that appears on the screen.
- $screen_id(string)
- Screen ID.
- $screen(WP_Screen)
- Current WP_Screen instance.
- $get_current_screen()->remove_help_tab()
- -
Changelog
Since 2.7.0 | Introduced. |
Deprecated since 3.3.0 | Use {@see get_current_screen()->add_help_tab()} or |
Where the hook is called
wp-admin/includes/class-wp-screen.php 822-827
$old_help = apply_filters_deprecated( 'contextual_help', array( $old_help, $this->id, $this ), '3.3.0', 'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()' );