wp-includes/widgets.php

WP文件 41
Core Widgets API
函数/钩子名 描述
wp_widgets_init (函数) wp_widgets_init – 这个函数用来初始化WordPress小工具系统。它负责注册内置的WordPress小工具,并设置必要的动作和过滤器,以允许第三方插件和主题添加自定义小工具。
wp_widget_rss_process (函数) wp_widget_rss_process – 这个函数用来处理WordPress小工具管理界面中RSS小工具的小工具控制表格的输入。它负责根据用户的输入来更新RSS小工具的设置。
wp_widget_rss_output (函数) wp_widget_rss_output – 这个函数用来在WordPress网站的前端显示一个RSS小工具的输出。它负责渲染HTML输出,在一个小工具中显示RSS提要的内容。
wp_widget_rss_form (函数) wp_widget_rss_form – 这个函数用来在WordPress小工具管理屏幕中显示RSS小工具的小工具控制表格。它负责渲染HTML表格,让用户配置RSS小工具的设置。
wp_widget_description (函数) wp_widget_description – 这个函数用来在WordPress小工具管理界面显示小工具的描述文本。描述文本提供了一个关于该小工具的目的和用途的简要概述。
wp_use_widgets_block_editor (函数) wp_use_widgets_block_editor: 这个函数用来检查是否正在使用区块编辑器(Gutenberg)来管理WordPress管理员中的小工具。如果正在使用区块编辑器,它返回true,
wp_unregister_widget_control (函数) wp_unregister_widget_control: 这个函数删除了一个先前注册的widget的控制函数。控制函数负责在WordPress管理区呈现小工具控制,允许网站管理员修改小工具的设置。
wp_unregister_sidebar_widget (函数) wp_unregister_sidebar_widget: 这个函数删除了一个先前注册的侧边栏小工具。widget是一个可以被添加到WordPress网站侧边栏的小块。wp_unregister_si
wp_sidebar_description (函数) wp_sidebar_description 是一个函数,用来显示WordPress中一个小工具区域的描述。
wp_setup_widgets_block_editor (函数) wp_setup_widgets_block_editor: 这个函数在WordPress的区块编辑器(Gutenberg)中使用,用于设置区块编辑器中使用的小工具和小工具区域。
wp_set_sidebars_widgets (函数) wp_set_sidebars_widgets: 这个函数设置与一个侧边栏相关的小工具。它接受一个widgets数组,每个侧边栏由一个widget ID数组表示。
wp_render_widget_control (函数) wp_render_widget_control: 这个函数用来渲染WordPress管理面板中一个小工具的控制表单。它把小工具的ID和一个实例数据的数组作为参数,并返回控制表单的HTML。
wp_render_widget (函数) wp_render_widget: 这个函数用来在WordPress网站的前端渲染一个小工具。它把小工具的ID作为参数,并返回小工具的内容。
wp_register_widget_control (函数) wp_register_widget_control: 这个函数用于注册一个小工具的控制形式。它接受几个参数,包括小工具的ID、名称和回调函数。
wp_register_sidebar_widget (函数) wp_register_sidebar_widget: 这个函数用来注册一个小工具,以便在侧边栏显示。它接受几个参数,包括小工具的名称、ID、描述和回调函数。
wp_parse_widget_id (函数) wp_parse_widget_id: 这个函数解析一个widget ID,并返回一个包含widget类型和编号的数组。
wp_map_sidebars_widgets (函数) wp_map_sidebars_widgets: 这是一个函数,用于将注册的小工具区域映射到实际的小工具。它返回一个注册的小工具区域的数组,以及相应的小工具。
wp_get_widget_defaults (函数) wp_get_widget_defaults: 这个函数是用来获取一个小工具的默认设置。它把小工具的ID作为参数,并返回该小工具的默认设置数组。
wp_get_sidebars_widgets (函数) wp_get_sidebars_widgets: 这个函数检索当前分配给WordPress站点中每个侧边栏的小工具的列表。它返回一个数组,其中侧边栏的名字是键,小工具的ID列表是值。
wp_get_sidebar (函数) wp_get_sidebar: 这个函数为一个特定的WordPress主题检索侧边栏的内容。它接受一个单一的参数–要检索的侧边栏的名称。如果该侧边栏在主题中不存在,它将返回一个空字符串。
wp_find_widgets_sidebar (函数) wp_find_widgets_sidebar: 这个函数用来检索当前在指定的侧边栏中活动的小工具的列表。它接受侧边栏的ID作为参数,并返回一个widget对象的数组。
_wp_block_theme_register_classic_sidebars (函数) _wp_block_theme_register_classic_sidebars(): 这个函数为WordPress中的块主题注册经典侧边栏。
wp_convert_widget_settings (函数) wp_convert_widget_settings: 这是一个将小工具设置从数组格式转换为字符串格式的函数。它可以用来在数据库中保存小工具的设置,并在以后检索它们。
wp_check_widget_editor_deps (函数) wp_check_widget_editor_deps: 这是一个检查WordPress小工具编辑器所需依赖性的函数。它可以用来确保在使用小工具编辑器时,所有必要的脚本和样式都被加载。
wp_assign_widget_to_sidebar (函数) wp_assign_widget_to_sidebar: 这个函数用来把一个widget分配到WordPress的一个特定的侧边栏。它需要两个参数–小工具实例和小工具将被分配的侧边栏的ID: 这个函
unregister_widget (函数) unregister_widget: 在WordPress中取消一个先前注册的小工具: 这个函数将该小工具从注册的小工具列表中移除。
unregister_sidebar (函数) unregister_sidebar: 在WordPress中取消注册一个先前注册的侧边栏: 这个函数将侧边栏从注册的侧边栏列表中移除,并使其无法在Widgets管理屏幕中选择。
the_widget (函数) the_widget: 这个函数在一个特定的小工具区域显示一个注册的小工具。它需要两个参数:widget类实例和控制widget的显示和行为的参数数组。
retrieve_widgets (函数) retrieve_widgets: 这是一个WordPress的函数,用来检索特定侧边栏的小工具。小工具是一些小的内容块,可以添加到网站的不同区域,如侧边栏。 retrieve_widgets检索已经
register_widget (函数) register_widget: 这个函数允许你注册一个新的小工具。小工具是小的内容块,可以放置在WordPress的侧边栏或任何其他小工具区域。你可以使用这个函数来注册一个新的小工具,并定义它的功能
register_sidebars (函数) register_sidebars: 这个函数用于在WordPress中注册多个侧边栏: 当创建一个有多个小工具区域的主题或创建一个在网站上添加多个侧边栏的插件时,这很有用。
register_sidebar (函数) register_sidebar: 这个函数用来在WordPress中注册一个新的侧边栏。侧边栏是用来在WordPress网站上显示小工具的,比如最近的文章列表或搜索栏。
is_registered_sidebar (函数) is_registered_sidebar – 这个函数检查一个给定的侧边栏是否被注册。如果该侧边栏已经注册,则返回真,否则返回假。
is_dynamic_sidebar (函数) is_dynamic_sidebar: 如果当前页面有一个动态侧边栏,该函数返回 true。动态侧边栏是网站中的一个区域,网站所有者可以在其中添加或删除小工具: 这个函数经常被用来根据动态边栏是否存在
is_active_widget (函数) is_active_widget: 这个函数用来检查一个小工具是否当前在网站上是活跃的。它以小工具的ID为参数,如果该小工具是活动的,则返回true,否则返回false。
is_active_sidebar (函数) is_active_sidebar: 这个函数用来检查一个侧边栏是否有任何小工具被添加到它。它把侧边栏的ID作为一个参数,如果侧边栏有任何小工具,则返回true,否则返回false。
dynamic_sidebar (函数) dynamic_sidebar: 这个函数在WordPress中显示一个小工具区域(sidebar)的内容。它通常用于sidebar.php模板文件,显示在WordPress管理面板中添加的小工具。
_wp_sidebars_changed (函数) _wp_sidebars_changed: 这个函数检查WordPress安装中的侧边栏是否被改变: 当一个主题被改变时,它被用来更新侧边栏。
_wp_remove_unregistered_widgets (函数) _wp_remove_unregistered_widgets: 这个函数删除任何不再在WordPress安装中注册的小工具。它在widgets_init动作中被调用。
_register_widget_update_callback (函数) _register_widget_update_callback: 这个函数用来注册一个回调函数,用来为一个widget保存表单数据。
More

常见问题

FAQs
查看更多 >