阐述 WordPress `get_theme_mod()` 和 `set_theme_mod()` 函数的源码：如何管理主题定制器选项。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

好吧，各位技术控们，欢迎来到今天的 WordPress 主题定制器选项管理“脱口秀”！今天的主角就是 get_theme_mod() 和 set_theme_mod() 这对好基友，它们是 WordPress 主题定制器背后的两大功臣。准备好，我们要深入挖掘它们的源码，看看它们是如何协同工作，让你的主题定制选项变得井井有条的。

Part 1: 故事的开始：定制器选项的存储

首先，我们要明白，WordPress 的主题定制器选项并不是凭空产生的，它们需要一个地方来存放。这个地方就是 wp_options 数据表。你可以把它想象成一个巨大的 Excel 表格，用来存储各种各样的 WordPress 设置，包括我们的主题定制选项。

wp_options 表格的关键字段如下：

字段名	数据类型	描述
option_id	bigint(20) unsigned	唯一ID，自增长。
option_name	varchar(191)	选项名，例如 `'theme_mods_your-theme-slug'`。
option_value	longtext	选项值，经过序列化的数据。
autoload	varchar(20)	是否自动加载。 `yes` 表示每次加载 WordPress 时都会加载此选项， `no` 则表示只有在需要时才加载。主题定制选项通常设置为 `no`，以提高性能。

注意 option_name 字段。对于主题定制选项，WordPress 会使用一个特定的命名约定：'theme_mods_' . get_stylesheet()。其中 get_stylesheet() 函数会返回当前主题的 slug（主题目录名）。例如，如果你的主题目录名是 my-awesome-theme，那么主题定制选项的 option_name 将会是 theme_mods_my-awesome-theme。

option_value 字段存储的是一个序列化的 PHP 数组。这个数组包含了你所有主题定制选项的值。序列化是一种将复杂的数据结构（如数组或对象）转换为字符串的过程，这样才能方便地存储在数据库中。

Part 2: get_theme_mod()：主题定制选项的“取款机”

get_theme_mod() 函数的作用很简单：根据选项名，从 wp_options 表格中取出对应的值。让我们来看看它的源码（简化版）：

function get_theme_mod( $name, $default = false ) {
    $theme = wp_get_theme();
    $mods = get_option( 'theme_mods_' . $theme->get_stylesheet() );

    if ( is_array( $mods ) && isset( $mods[ $name ] ) ) {
        return maybe_unserialize( $mods[ $name ] );
    }

    return $default;
}

让我们一步步分析：

获取主题对象: $theme = wp_get_theme(); 这一行获取当前主题的 WP_Theme 对象，包含了主题的各种信息，例如主题名称、版本、目录等等。
构建选项名: $theme->get_stylesheet() 获取当前主题的 slug，然后将其与 'theme_mods_' 前缀拼接起来，构建出完整的选项名。
从数据库中获取选项: get_option( 'theme_mods_' . $theme->get_stylesheet() ) 使用 WordPress 内置的 get_option() 函数，从 wp_options 表格中获取指定选项名的值。这个值是一个序列化的 PHP 数组。
检查选项是否存在: if ( is_array( $mods ) && isset( $mods[ $name ] ) ) 首先检查从数据库中取出的值是否是一个数组，然后检查数组中是否存在指定名称 $name 的键。 $name 就是你想要获取的特定主题定制选项的名称。
反序列化并返回: return maybe_unserialize( $mods[ $name ] ); 如果选项存在，使用 maybe_unserialize() 函数将序列化的值反序列化成 PHP 数据，然后返回。 maybe_unserialize() 函数会智能地判断数据是否需要反序列化，如果数据本身不是序列化的，它会直接返回原始数据。
返回默认值: return $default; 如果选项不存在，则返回你指定的默认值 $default。这个默认值非常重要，它可以确保即使某个主题定制选项没有被设置，你的主题也能正常运行。

举个栗子:

假设你的主题有一个定制选项叫做 header_text_color，你想获取它的值，并且设置默认值为 #000000（黑色）。你可以这样使用 get_theme_mod() 函数：

$header_text_color = get_theme_mod( 'header_text_color', '#000000' );
echo 'Header text color: ' . esc_attr( $header_text_color ); // 输出: Header text color: #000000 或者你设置的其他颜色

Part 3: set_theme_mod()：主题定制选项的“存款机”

set_theme_mod() 函数的作用是设置或更新 wp_options 表格中的主题定制选项。让我们看看它的源码（同样是简化版）：

function set_theme_mod( $name, $value ) {
    $theme = wp_get_theme();
    $mods = get_option( 'theme_mods_' . $theme->get_stylesheet() );

    if ( ! is_array( $mods ) ) {
        $mods = array();
    }

    $mods[ $name ] = $value;

    return update_option( 'theme_mods_' . $theme->get_stylesheet(), $mods );
}

让我们分解一下：

获取主题对象: $theme = wp_get_theme(); 与 get_theme_mod() 相同，获取当前主题的 WP_Theme 对象。
构建选项名: $theme->get_stylesheet() 获取当前主题的 slug，然后将其与 'theme_mods_' 前缀拼接起来，构建出完整的选项名。
获取现有选项: get_option( 'theme_mods_' . $theme->get_stylesheet() ) 尝试从 wp_options 表格中获取现有的主题定制选项。
如果选项不存在，创建一个新的数组: if ( ! is_array( $mods ) ) { $mods = array(); } 如果 get_option() 函数没有找到任何选项（例如，这是你第一次设置主题定制选项），就创建一个新的空数组 $mods。
更新选项值: $mods[ $name ] = $value; 将新的选项值 $value 赋值给 $mods 数组中对应的 $name 键。
更新数据库: return update_option( 'theme_mods_' . $theme->get_stylesheet(), $mods ); 使用 WordPress 内置的 update_option() 函数，将更新后的 $mods 数组序列化后存储到 wp_options 表格中。 update_option() 函数会自动处理插入或更新操作：如果选项不存在，它会插入一条新的记录；如果选项已经存在，它会更新现有的记录。

举个栗子:

假设你想将 header_text_color 设置为 #FF0000（红色）。你可以这样使用 set_theme_mod() 函数：

set_theme_mod( 'header_text_color', '#FF0000' );

这条语句会将 header_text_color 的值更新为 #FF0000。下次你调用 get_theme_mod( 'header_text_color' ) 时，它将返回 #FF0000。

Part 4: remove_theme_mod()：主题定制选项的“回收站”

还有一个函数，虽然不常用，但也很重要，那就是 remove_theme_mod()。它的作用是删除一个主题定制选项。源码如下：

function remove_theme_mod( $name ) {
    $theme = wp_get_theme();
    $mods = get_option( 'theme_mods_' . $theme->get_stylesheet() );

    if ( is_array( $mods ) && isset( $mods[ $name ] ) ) {
        unset( $mods[ $name ] );
        return update_option( 'theme_mods_' . $theme->get_stylesheet(), $mods );
    }

    return false;
}

分析：

获取主题对象和选项名: 步骤与 get_theme_mod() 和 set_theme_mod() 相同。
检查选项是否存在: if ( is_array( $mods ) && isset( $mods[ $name ] ) ) 确保要删除的选项确实存在。
删除选项: unset( $mods[ $name ] ); 使用 PHP 的 unset() 函数从 $mods 数组中删除指定的键。
更新数据库: return update_option( 'theme_mods_' . $theme->get_stylesheet(), $mods ); 将更新后的 $mods 数组（现在已经缺少了被删除的选项）序列化后存储到 wp_options 表格中。

举个栗子:

如果你想删除 header_text_color 选项，你可以这样使用 remove_theme_mod() 函数：

remove_theme_mod( 'header_text_color' );

Part 5: 最佳实践和注意事项

使用默认值: 在使用 get_theme_mod() 时，务必提供一个合理的默认值。这样可以确保你的主题在没有设置特定选项时也能正常工作。
数据清洗和验证: 在使用 set_theme_mod() 设置选项值之前，最好对数据进行清洗和验证。例如，如果你希望用户输入一个颜色值，你应该验证这个值是否是有效的十六进制颜色代码。
避免过度使用: 虽然 get_theme_mod() 和 set_theme_mod() 非常方便，但过度使用它们可能会降低性能。尽量将主题定制选项存储在主题的配置文件中，只有在用户通过定制器修改选项时才使用 set_theme_mod() 更新数据库。
考虑使用 Transients API: 对于一些计算量大的主题定制选项，可以考虑使用 WordPress 的 Transients API 来缓存结果，以提高性能。
主题切换: 当用户切换主题时，WordPress 会自动加载新主题的定制选项。但是，如果新主题没有定义与旧主题相同的定制选项，那么旧选项的值将会被保留在数据库中，但不会被使用。这可能会导致数据库中存在一些“垃圾”数据。你可以使用 remove_theme_mods() 函数来清除旧主题的定制选项。

Part 6: 总结

get_theme_mod(), set_theme_mod(), 和 remove_theme_mod() 这三个函数构成了 WordPress 主题定制器选项管理的核心。它们通过操作 wp_options 数据表，让你能够方便地存储和检索主题定制选项的值。理解它们的源码和使用方法，可以帮助你更好地开发 WordPress 主题，并为用户提供更加灵活和强大的定制体验。

好了，今天的“脱口秀”就到这里。希望大家对 WordPress 主题定制器选项管理有了更深入的理解。记住，掌握了这些工具，你就能让你的主题更加个性化，更加用户友好。祝大家编程愉快！

发表回复 取消回复

发表回复取消回复