分析 WordPress `gutenberg_is_classic_editor_enabled_in_settings()` 函数源码：如何判断经典编辑器是否被启用。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

同学们，早上好！今天咱们来聊聊WordPress里一个挺有趣的小函数 gutenberg_is_classic_editor_enabled_in_settings()，看看它是怎么判断经典编辑器是不是还在“当家作主”。这就像侦探破案一样，我们要抽丝剥茧，找到关键线索。

开场白：编辑器之争，经典与现代的碰撞

话说WordPress的世界里，编辑器一直是个热门话题。从最初的经典编辑器，到后来居上的Gutenberg块编辑器，它们之间既有竞争，也有合作。而gutenberg_is_classic_editor_enabled_in_settings() 这个函数，就像一个裁判，负责判断经典编辑器是否在设置里被“扶正”。

函数源码剖析：一步一步揭开真相

好了，废话不多说，咱们直接上代码！先来看看 gutenberg_is_classic_editor_enabled_in_settings() 函数的真面目：

<?php
/**
 * Checks whether the Classic Editor is enabled in settings.
 *
 * @return bool Whether the Classic Editor is enabled in settings.
 */
function gutenberg_is_classic_editor_enabled_in_settings() {
    return 'classic' === get_option( 'editor' );
}

是不是很简单？别看代码行数少，里面蕴含的信息可不少。

get_option( 'editor' )：获取关键设置

这个函数是整个判断的核心。get_option() 是 WordPress 提供的一个用于获取选项值的函数。在这里，它获取的是名为 'editor' 的选项的值。这个 'editor' 选项决定了当前站点使用的编辑器。
'classic' === ...：判断是否为经典编辑器

获取到 'editor' 选项的值之后，函数会将其与字符串 'classic' 进行比较。如果两者相等，说明站点设置中启用了经典编辑器，函数返回 true；否则，返回 false。

代码逻辑梳理：简单直接，一目了然

为了更清晰地理解这个函数的工作原理，咱们用流程图来表示一下：

graph LR
    A[开始] --> B{获取 'editor' 选项的值};
    B --> C{值是否等于 'classic'?};
    C -- 是 --> D[返回 true (经典编辑器已启用)];
    C -- 否 --> E[返回 false (经典编辑器未启用)];
    D --> F[结束];
    E --> F;

深入挖掘：'editor' 选项的来龙去脉

现在，咱们来深入了解一下 'editor' 这个选项。它存储在 WordPress 的 wp_options 表中，用于记录站点选择的编辑器类型。

可能的值：
- 'classic'：表示启用经典编辑器。
- 'block'：表示启用 Gutenberg 块编辑器。
- (可能还有其他插件自定义的值)
如何修改：
- 通过后台设置： 在 WordPress 后台的“设置” -> “撰写” 页面，可以找到编辑器选择的选项。
- 通过代码： 使用 update_option( 'editor', 'classic' ) 或 update_option( 'editor', 'block' ) 函数可以直接修改 'editor' 选项的值。
- 通过插件： 某些插件可能会自动修改 'editor' 选项的值，以强制启用或禁用经典编辑器。

应用场景：gutenberg_is_classic_editor_enabled_in_settings() 的用武之地

这个函数在实际开发中有很多用处。比如：

插件兼容性判断： 插件可以使用这个函数来判断当前站点是否启用了经典编辑器，然后根据情况加载不同的代码或样式。

<?php
if ( gutenberg_is_classic_editor_enabled_in_settings() ) {
    // 加载经典编辑器兼容的代码
    wp_enqueue_script( 'my-plugin-classic-editor', 'path/to/classic-editor.js', array( 'jquery' ), '1.0.0', true );
} else {
    // 加载 Gutenberg 块编辑器兼容的代码
    wp_enqueue_script( 'my-plugin-gutenberg', 'path/to/gutenberg.js', array( 'wp-blocks', 'wp-element' ), '1.0.0', true );
}

主题功能定制： 主题可以根据编辑器类型来调整页面布局或样式。

<?php
if ( gutenberg_is_classic_editor_enabled_in_settings() ) {
    // 经典编辑器下的页面布局
    echo '<div class="classic-editor-layout">';
    the_content();
    echo '</div>';
} else {
    // Gutenberg 块编辑器下的页面布局
    echo '<div class="gutenberg-layout">';
    the_content();
    echo '</div>';
}

条件加载资源： 在某些情况下，你可能只想在经典编辑器启用时加载某些特定的 CSS 或 JavaScript 文件。

<?php
function my_enqueue_scripts() {
    if ( gutenberg_is_classic_editor_enabled_in_settings() ) {
        wp_enqueue_style( 'my-classic-editor-style', get_template_directory_uri() . '/css/classic-editor.css' );
    }
}
add_action( 'wp_enqueue_scripts', 'my_enqueue_scripts' );

实战演练：编写一个简单的插件，根据编辑器类型显示不同的提示信息

为了更好地理解这个函数，咱们来编写一个简单的插件。这个插件会在文章编辑页面显示一个提示信息，告诉用户当前站点启用了哪种编辑器。

<?php
/**
 * Plugin Name: Editor Type Notifier
 * Description: Displays a message indicating the current editor type.
 * Version: 1.0.0
 * Author: Your Name
 */

function editor_type_notifier() {
    $editor_type = gutenberg_is_classic_editor_enabled_in_settings() ? 'Classic Editor' : 'Gutenberg Block Editor';
    echo '<div class="notice notice-info">';
    echo '<p>You are currently using the <strong>' . esc_html( $editor_type ) . '</strong>.</p>';
    echo '</div>';
}

add_action( 'admin_notices', 'editor_type_notifier' );

将这段代码保存为 editor-type-notifier.php 文件，然后上传到 WordPress 的 wp-content/plugins 目录下。激活插件后，在文章编辑页面就能看到相应的提示信息了。

避免误区：gutenberg_is_classic_editor_enabled_in_settings() 的局限性

虽然 gutenberg_is_classic_editor_enabled_in_settings() 函数很有用，但它也有一些局限性。

只能判断全局设置： 这个函数只能判断站点全局的编辑器设置。如果某个文章或页面单独启用了经典编辑器（通过 "Classic Editor" 块或者插件），这个函数是无法检测到的。
依赖于 'editor' 选项： 如果 'editor' 选项的值被篡改，或者被其他插件错误地设置，这个函数的结果可能会不准确。
不能判断 "Classic Editor" 插件是否激活： 即使站点设置中没有启用经典编辑器，如果安装并激活了 "Classic Editor" 插件，用户仍然可以在编辑文章时选择使用经典编辑器。gutenberg_is_classic_editor_enabled_in_settings() 不会告诉你 "Classic Editor" 插件是否激活。你需要使用 is_plugin_active( 'classic-editor/classic-editor.php' ) 来判断。

更全面的判断：考虑插件的影响

为了更准确地判断经典编辑器是否可用，我们需要考虑 "Classic Editor" 插件的影响。可以使用 is_plugin_active() 函数来判断插件是否激活。

<?php
include_once( ABSPATH . 'wp-admin/includes/plugin.php' );

function is_classic_editor_active() {
    if ( is_plugin_active( 'classic-editor/classic-editor.php' ) ) {
        return true;
    }

    return gutenberg_is_classic_editor_enabled_in_settings();
}

// 使用示例：
if ( is_classic_editor_active() ) {
    echo "经典编辑器可用";
} else {
    echo "经典编辑器不可用";
}

总结：小函数，大作用

gutenberg_is_classic_editor_enabled_in_settings() 函数虽然简单，但在 WordPress 开发中却扮演着重要的角色。它可以帮助我们判断站点是否启用了经典编辑器，从而更好地兼容不同的编辑器类型。

特性	描述
功能	判断 WordPress 全局设置中是否启用了经典编辑器。
依赖	依赖于 `wp_options` 表中的 `'editor'` 选项。
返回值	`true` (经典编辑器已启用) 或 `false` (经典编辑器未启用)。
局限性	只能判断全局设置，无法检测单个文章或页面的编辑器选择，也无法判断 "Classic Editor" 插件是否激活。
应用场景	插件兼容性判断、主题功能定制、条件加载资源等。
替代方案/补充	使用 `is_plugin_active( 'classic-editor/classic-editor.php' )` 判断 "Classic Editor" 插件是否激活。
重要性	在需要兼容经典编辑器和 Gutenberg 块编辑器的场景中非常重要。

希望今天的讲座能帮助大家更好地理解 gutenberg_is_classic_editor_enabled_in_settings() 函数。记住，掌握这些小技巧，才能在 WordPress 的世界里游刃有余！

发表回复 取消回复

发表回复取消回复