云策 WordPress 开发者社区

函数文档

wp_use_widgets_block_editor()

查看官方原文 ↗
💡 云策文档标注

概述

wp_use_widgets_block_editor() 函数用于确定是否使用区块编辑器来管理小工具。默认返回 true，除非主题移除了对 widgets-block-editor 的支持或插件过滤了此函数的返回值。

关键要点

  • 函数返回布尔值，指示是否启用小工具的区块编辑器管理。
  • 默认行为基于主题对 widgets-block-editor 的支持状态。
  • 可通过 apply_filters('use_widgets_block_editor', $use_widgets_block_editor) 钩子过滤返回值。
  • 函数自 WordPress 5.8.0 版本引入。

代码示例

function wp_use_widgets_block_editor() {
    /**
     * Filters whether to use the block editor to manage widgets.
     *
     * @since 5.8.0
     *
     * @param bool $use_widgets_block_editor Whether to use the block editor to manage widgets.
     */
    return apply_filters(
        'use_widgets_block_editor',
        get_theme_support( 'widgets-block-editor' )
    );
}
📄 原文内容

Determines whether or not to use the block editor to manage widgets.

Description

Defaults to true unless a theme has removed support for widgets-block-editor or a plugin has filtered the return value of this function.

Return

bool Whether to use the block editor to manage widgets.

Source

function wp_use_widgets_block_editor() {
	/**
	 * Filters whether to use the block editor to manage widgets.
	 *
	 * @since 5.8.0
	 *
	 * @param bool $use_widgets_block_editor Whether to use the block editor to manage widgets.
	 */
	return apply_filters(
		'use_widgets_block_editor',
		get_theme_support( 'widgets-block-editor' )
	);
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘use_widgets_block_editor’, bool $use_widgets_block_editor )

Filters whether to use the block editor to manage widgets.

Uses Description
get_theme_support()wp-includes/theme.php

Gets the theme support arguments passed when registering that support.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.
Used by Description
WP_Customize_Widgets::should_load_block_editor_scripts_and_styles()wp-includes/class-wp-customize-widgets.php

Tells the script loader to load the scripts and styles of custom blocks if the widgets block editor is enabled.
WP_Customize_Widgets::sanitize_widget_instance()wp-includes/class-wp-customize-widgets.php

Sanitizes a widget instance.
WP_Customize_Widgets::sanitize_widget_js_instance()wp-includes/class-wp-customize-widgets.php

Converts a widget instance into JSON-representable format.
WP_Customize_Widgets::enqueue_scripts()wp-includes/class-wp-customize-widgets.php

Enqueues scripts and styles for Customizer panel and export data to JavaScript.
WP_Customize_Widgets::customize_register()wp-includes/class-wp-customize-widgets.php

Registers Customizer settings and controls for all sidebars and widgets.

Changelog

Version Description
5.8.0 Introduced.