钩子文档

default_contextual_help

💡 云策文档标注

概述

default_contextual_help 是一个已弃用的过滤器,用于修改默认的旧版上下文帮助文本。自 WordPress 3.3.0 起,建议使用 get_current_screen()->add_help_tab() 或 get_current_screen()->remove_help_tab() 替代。

关键要点

  • 过滤器名称:default_contextual_help
  • 参数:$old_help(默认上下文帮助文本字符串)
  • 状态:已弃用,自 3.3.0 版本起
  • 替代方法:使用 get_current_screen()->add_help_tab() 或 get_current_screen()->remove_help_tab() 来管理帮助标签
  • 相关函数:WP_Screen::render_screen_meta() 用于渲染屏幕帮助部分

代码示例

$default_help = apply_filters_deprecated(
    'default_contextual_help',
    array( '' ),
    '3.3.0',
    'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'
);

注意事项

  • 此过滤器在 WordPress 2.8.0 中引入,但在 3.3.0 版本中被弃用,开发者应更新代码以避免使用。
  • 弃用信息提示使用新的屏幕帮助 API 来添加或移除帮助标签。

📄 原文内容

Filters the default legacy contextual help text.

Parameters

$old_help_defaultstring
Default contextual help text.

Source

$default_help = apply_filters_deprecated(
	'default_contextual_help',
	array( '' ),
	'3.3.0',
	'get_current_screen()->add_help_tab(), get_current_screen()->remove_help_tab()'
);

Changelog

Version Description
3.3.0 Deprecated. Use get_current_screen()->add_help_tab() or get_current_screen()->remove_help_tab() instead.
2.8.0 Introduced.