剖析 `get_option()` 和 `update_option()` 函数的源码，它们是如何管理全局配置数据的？ - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

大家好，欢迎来到今天的源码剖析小课堂！今天我们要聊聊 get_option() 和 update_option() 这对黄金搭档，看看它们是如何在后台默默地管理着我们网站的全局配置数据的。准备好咖啡，让我们一起深入了解 WordPress 的 Options API 吧！

1. Options API：全局配置的管家

首先，我们得明白 Options API 是什么。简单来说，它就是 WordPress 提供的一套用于存储和检索全局配置数据的接口。这些配置数据可以是网站标题、描述、主题设置、插件配置等等。想象一下，它就像一个巨大的配置数据库，方便我们随时存取各种全局设置。

那么，为什么要用 Options API 呢？原因很简单：

持久化存储： 数据存储在数据库中，即使服务器重启也不会丢失。
全局访问： 任何地方都可以通过 get_option() 函数获取配置数据。
方便管理： WordPress 提供了 update_option()、add_option() 和 delete_option() 等函数，方便我们增删改查配置数据。
安全性： WordPress 会对 Options API 进行安全处理，防止恶意攻击。

2. get_option()：取数小能手

get_option() 函数的作用就是根据给定的 option name，从数据库中取出对应的 option value。我们先来看看它的源码（简化版，省略了一些过滤器和缓存相关的代码）：

function get_option( string $option, mixed $default = false ) {
    global $wpdb;

    $option = trim( $option );
    if ( empty( $option ) ) {
        return false;
    }

    // 尝试从缓存中获取
    $cache_value = wp_cache_get( $option, 'options' );
    if ( false !== $cache_value ) {
        return $cache_value;
    }

    $row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );

    if ( is_object( $row ) ) {
        $value = $row->option_value;

        // Unserialize data if necessary.
        if ( 'yes' === get_option( 'auto_serialize' ) ) {
            $value = maybe_unserialize( $value );
        } else {
            $value = stripslashes_deep( $value );
        }

        wp_cache_set( $option, $value, 'options' );

        return $value;
    }

    return $default;
}

让我们一步一步地解读这段代码：

函数签名： get_option( string $option, mixed $default = false )。它接受两个参数：
- $option：要获取的 option name，字符串类型。
- $default：如果 option 不存在，返回的默认值，默认为 false。
参数校验： $option = trim( $option ); 和 if ( empty( $option ) ) { return false; }。首先去除 option name 前后的空格，然后判断 option name 是否为空，如果为空则直接返回 false。
缓存机制： wp_cache_get( $option, 'options' )。WordPress 使用缓存来提高性能。wp_cache_get() 函数尝试从缓存中获取 option value。如果缓存中存在，则直接返回缓存值。
数据库查询： $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) )。如果缓存中没有找到，则需要从数据库中查询。这里使用了 $wpdb->prepare() 函数来防止 SQL 注入攻击。
数据反序列化： maybe_unserialize( $value )。如果 option value 是序列化的数据（例如数组或对象），则需要使用 maybe_unserialize() 函数将其反序列化。
缓存更新： wp_cache_set( $option, $value, 'options' )。将从数据库中获取的 option value 存入缓存，以便下次快速访问。
返回结果： 如果数据库中找到了对应的 option，则返回 option value；否则返回 $default。

表格总结 get_option() 函数流程

步骤	代码片段	描述
1	`$option = trim( $option );` `if ( empty( $option ) ) { return false; }`	参数校验：去除 option name 前后的空格，并判断 option name 是否为空。
2	`$cache_value = wp_cache_get( $option, 'options' );` `if ( false !== $cache_value ) { return $cache_value; }`	缓存读取：尝试从缓存中获取 option value，如果缓存中存在，则直接返回缓存值。
3	`$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );`	数据库查询：如果缓存中没有找到，则从数据库中查询 option value。
4	`if ( is_object( $row ) ) { ... }`	数据处理：如果数据库中找到了对应的 option，则对 option value 进行反序列化（如果需要），并将其存入缓存。
5	`return $value;`	返回结果：返回 option value。
6	`return $default;`	返回默认值：如果数据库中没有找到对应的 option，则返回 `$default`。

3. update_option()：存数大管家

update_option() 函数的作用是更新数据库中指定 option name 的 option value。如果 option name 不存在，则会创建一个新的 option。我们再来看看它的源码（同样是简化版）：

function update_option( string $option, mixed $value, string $autoload = null ) {
    global $wpdb;

    $option = trim( $option );
    if ( empty( $option ) ) {
        return false;
    }

    $old_value = get_option( $option );

    if ( $value === $old_value ) {
        return false;
    }

    $value = sanitize_option( $option, $value );
    $value = wp_slash( maybe_serialize( $value ) ); // Serialize data if necessary.

    $row = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->options WHERE option_name = %s", $option ) );

    if ( is_object( $row ) ) {
        // Option already exists, update it.
        $result = $wpdb->update(
            $wpdb->options,
            array( 'option_value' => $value ),
            array( 'option_name' => $option )
        );

        if ( $result ) {
            wp_cache_delete( $option, 'options' );
        }
    } else {
        // Option does not exist, add it.
        $result = $wpdb->insert(
            $wpdb->options,
            array(
                'option_name'  => $option,
                'option_value' => $value,
                'autoload'     => $autoload,
            )
        );
    }

    if ( $result ) {
        wp_cache_delete( $option, 'options' );
    }

    return true;
}

同样，我们来解读这段代码：

函数签名： update_option( string $option, mixed $value, string $autoload = null )。它接受三个参数：
- $option：要更新的 option name，字符串类型。
- $value：要更新的 option value，任意类型。
- $autoload：是否在 WordPress 启动时自动加载该 option，默认为 null。
参数校验： $option = trim( $option ); 和 if ( empty( $option ) ) { return false; }。同样，首先去除 option name 前后的空格，然后判断 option name 是否为空。
判断是否需要更新： $old_value = get_option( $option ); 和 if ( $value === $old_value ) { return false; }。首先获取旧的 option value，然后判断新的 option value 是否与旧的 option value 相同。如果相同，则无需更新，直接返回 false。
数据处理： $value = sanitize_option( $option, $value ); 和 $value = wp_slash( maybe_serialize( $value ) );。首先使用 sanitize_option() 函数对 option value 进行安全过滤，然后使用 maybe_serialize() 函数对 option value 进行序列化（如果需要），最后使用 wp_slash() 函数对反斜杠进行转义，防止反斜杠被错误地解释。
判断 Option 是否存在： $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->options WHERE option_name = %s", $option ) )。通过查询数据库判断 option name 是否已经存在。
更新或插入数据： 如果 option name 已经存在，则使用 $wpdb->update() 函数更新 option value；否则使用 $wpdb->insert() 函数插入一条新的 option。
缓存清理： wp_cache_delete( $option, 'options' )。更新或插入数据后，需要清理缓存，以便下次访问时获取最新的 option value。
返回结果： 如果更新或插入数据成功，则返回 true。

表格总结 update_option() 函数流程

步骤	代码片段	描述
1	`$option = trim( $option );` `if ( empty( $option ) ) { return false; }`	参数校验：去除 option name 前后的空格，并判断 option name 是否为空。
2	`$old_value = get_option( $option );` `if ( $value === $old_value ) { return false; }`	判断是否需要更新：获取旧的 option value，并判断新的 option value 是否与旧的 option value 相同。如果相同，则无需更新。
3	`$value = sanitize_option( $option, $value );` `$value = wp_slash( maybe_serialize( $value ) );`	数据处理：对 option value 进行安全过滤、序列化（如果需要）和反斜杠转义。
4	`$row = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->options WHERE option_name = %s", $option ) );`	判断 Option 是否存在：通过查询数据库判断 option name 是否已经存在。
5	`if ( is_object( $row ) ) { ... } else { ... }`	更新或插入数据：如果 option name 已经存在，则更新 option value；否则插入一条新的 option。
6	`wp_cache_delete( $option, 'options' );`	缓存清理：清理缓存，以便下次访问时获取最新的 option value。
7	`return true;`	返回结果：返回 `true` 表示更新或插入数据成功。

4. 数据库表结构

Options API 使用 WordPress 的 wp_options 数据表来存储配置数据。该表包含以下字段：

字段名	数据类型	描述
option_id	bigint(20) UNSIGNED	主键，自增长。
option_name	varchar(191)	option name，唯一索引。
option_value	longtext	option value，存储配置数据。
autoload	varchar(20)	是否在 WordPress 启动时自动加载该 option，取值为 `yes` 或 `no`。如果设置为 `yes`，则会在 WordPress 启动时将该 option 加载到内存中，以提高访问速度。但是，如果 autoload 的 option 太多，会降低 WordPress 的启动速度。因此，只有真正需要频繁访问的 option 才应该设置为 `yes`。

5. 使用示例

让我们来看一些使用 get_option() 和 update_option() 的示例：

// 获取网站标题
$site_title = get_option( 'blogname' );
echo '网站标题：' . $site_title;

// 更新网站描述
update_option( 'blogdescription', '欢迎来到我的博客！' );

// 添加一个新的 option
add_option( 'my_custom_option', 'Hello World!', '', 'yes' );

// 获取自定义 option
$my_option = get_option( 'my_custom_option' );
echo '自定义 Option：' . $my_option;

6. 最佳实践

在使用 Options API 时，需要注意以下几点：

Option name 的唯一性： Option name 必须是唯一的，否则可能会导致数据冲突。
数据安全： 使用 sanitize_option() 函数对 option value 进行安全过滤，防止 XSS 攻击。
性能优化： 避免存储过大的数据，尽量使用缓存机制。
Autoload 的使用： 只有真正需要频繁访问的 option 才应该设置为 yes。
避免过度使用： 不要将所有数据都存储在 options 表中，对于大量的数据，应该使用自定义数据表。

7. 总结

get_option() 和 update_option() 是 WordPress Options API 中最常用的两个函数。它们负责从数据库中读取和更新全局配置数据。理解它们的源码和使用方法，可以帮助我们更好地开发 WordPress 主题和插件。

希望今天的讲解对你有所帮助！下次再见！

发表回复 取消回复

发表回复取消回复