各位未来的WordPress大神们，晚上好！我是今晚的客座讲师，咱们今晚来聊聊WordPress源码里一个相当重要的、却又经常被开发者忽略的函数：dbDelta()。
这个函数，说白了，就是个数据库表结构“自动档”工具。你只要告诉它你想要的表长什么样，它就会帮你创建表（如果不存在），或者修改表（如果结构不匹配）。但这个“自动档”背后，隐藏着一些相当精巧的正则解析逻辑。不了解这些，你可能就会觉得它有时候挺“智能”，有时候又让你摸不着头脑。
所以，今晚咱们就来扒一扒 dbDelta() 的源码，重点研究它如何使用正则来解析和处理数据库表结构定义。
一、dbDelta() 是个啥？为啥要学它？
dbDelta() 函数，定义在 wp-admin/includes/upgrade.php 文件中。它的主要作用是：
- 创建数据库表： 如果指定的表不存在，
dbDelta()会根据提供的 SQL 语句创建它。 - 更新数据库表： 如果表已经存在，但结构（字段、索引等）与提供的 SQL 语句不匹配，
dbDelta()会尝试修改表结构，使其符合要求。
为啥要学它？
- 开发插件/主题： 如果你的插件或主题需要自定义数据库表，
dbDelta()是一个非常方便的工具。 - 理解 WordPress 的底层机制： 了解
dbDelta()的工作原理，有助于你更深入地理解 WordPress 的数据库管理机制。 - 解决疑难杂症： 当你遇到数据库表结构相关的错误时，对
dbDelta()的了解可以帮助你快速定位问题。 - 提高代码质量： 更好的理解 WordPress 的数据库 Schema 升级机制。
二、dbDelta() 的基本用法
dbDelta() 的基本用法很简单：
require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
$sql = "CREATE TABLE {$wpdb->prefix}my_table (
id mediumint(9) NOT NULL AUTO_INCREMENT,
time datetime DEFAULT '0000-00-00 00:00:00' NOT NULL,
name varchar(255) NOT NULL,
PRIMARY KEY (id)
);";
dbDelta( $sql );这段代码会尝试创建或更新名为 wp_my_table 的数据库表（wp_ 是数据库表前缀）。
注意：
dbDelta()接收一个包含 SQL 语句的字符串作为参数。- SQL 语句必须包含
CREATE TABLE语句。 - SQL 语句必须以分号
;结尾。 - 表名必须使用
$wpdb->prefix前缀，以便在不同的 WordPress 安装中保持一致。
三、dbDelta() 源码剖析：步步惊心
现在，让我们深入 dbDelta() 的源码，看看它到底是如何工作的。
function dbDelta( $queries, $execute = true ) {
global $wpdb;
// 1. 准备工作
if ( ! is_array( $queries ) ) {
$queries = explode( ";n", $queries );
}
$queries = array_filter( $queries );
// 2. 获取已安装表的结构
$existing_tables = $wpdb->get_col( 'SHOW TABLES', 0 );
$all_results = array();
// 3. 遍历 SQL 语句
foreach ( $queries as $query ) {
$query = trim( $query );
if ( empty( $query ) ) {
continue;
}
// 4. 解析表名
preg_match( '/CREATE TABLE `?([^` ]*)`?/i', $query, $matches );
if ( empty( $matches ) ) {
continue;
}
$table_name = $matches[1];
// 5. 表是否已存在？
if ( in_array( $table_name, $existing_tables ) ) {
// 表已存在，需要更新
$results = maybe_add_column( $query, $table_name );
if ( $execute ) {
foreach ( $results as $r ) {
$wpdb->query( $r );
}
}
} else {
// 表不存在，创建
if ( $execute ) {
$wpdb->query( $query );
}
$results = array( sprintf( /* translators: 1: Table name. 2: Database query. */ __( 'Table %1$s created. Query: %2$s' ), '<code>' . esc_html( $table_name ) . '</code>', '<code>' . esc_html( $query ) . '</code>' ) );
}
$all_results = array_merge( $all_results, (array) $results );
}
return $all_results;
}代码解读：
-
准备工作：
- 如果传入的
$queries不是数组，则使用explode( ";n", $queries )将其分割成数组。注意，这里的分隔符是;加上一个换行符n。 - 使用
array_filter()过滤掉空语句。
- 如果传入的
-
获取已安装表的结构：
$wpdb->get_col( 'SHOW TABLES', 0 )获取数据库中所有表的名称，并存储在$existing_tables数组中。
-
遍历 SQL 语句：
- 循环遍历
$queries数组，处理每条 SQL 语句。
- 循环遍历
-
解析表名：
-
关键点： 使用
preg_match( '/CREATE TABLE?([^]*)?/i’, $query, $matches )` 从 SQL 语句中提取表名。CREATE TABLE: 匹配CREATE TABLE字符串。`?: 匹配一个可选的反引号。允许表名被反引号包裹，也可以不包裹。([^]): 这才是重点！这是一个捕获组，匹配除了反引号和空格之外的任意字符，零次或多次。[^]表示“除了反引号和空格之外的任何字符”，`` 表示“零次或多次”。`?: 再次匹配一个可选的反引号。/i: 表示不区分大小写。
-
如果匹配成功，表名将被存储在
$matches[1]中。
-
-
表是否已存在？
- 使用
in_array( $table_name, $existing_tables )检查表是否已经存在。 - 如果表已存在，则调用
maybe_add_column()函数来更新表结构。 - 如果表不存在，则执行
CREATE TABLE语句来创建表。
- 使用
四、maybe_add_column()：更新表结构的核心
maybe_add_column() 函数是 dbDelta() 中最复杂的部分。它负责比较现有表的结构与期望的结构，并执行必要的 ALTER TABLE 语句来更新表结构。
function maybe_add_column( $new_table_sql, $table_name ) {
global $wpdb;
$cqueries = array();
// 1. 获取当前表的结构
$old_columns = $wpdb->get_results( "DESCRIBE {$table_name}", ARRAY_A );
// 2. 解析新的表结构
preg_match_all( '/ns*`([^`]+)`s+([^,]+)(?:,s*)?n/ms', $new_table_sql, $matches, PREG_SET_ORDER );
$table_fields = array();
foreach ( $matches as $match ) {
$table_fields[ $match[1] ] = $match[2];
}
// 3. 遍历新的字段
foreach ( $table_fields as $field => $field_def ) {
$add_field = true;
foreach ( $old_columns as $old_col ) {
if ( $field === $old_col['Field'] ) {
// 4. 字段已存在，比较字段定义
$add_field = false;
// 5. 构建 ALTER TABLE 语句
$alter_query = "ALTER TABLE {$table_name} CHANGE COLUMN `{$field}` `{$field}` {$field_def}";
// 6. 获取当前字段的完整定义
$current_field_def = get_column_definition( $table_name, $field );
// 7. 比较字段定义
if ( strtolower( trim( $current_field_def ) ) != strtolower( trim( $field_def ) ) ) {
// 8. 字段定义不匹配，执行 ALTER TABLE 语句
$cqueries[] = $alter_query;
}
break;
}
}
// 9. 字段不存在，添加字段
if ( $add_field ) {
$cqueries[] = "ALTER TABLE {$table_name} ADD COLUMN `{$field}` {$field_def}";
}
}
// 10. 处理索引（省略，较为复杂，涉及更多正则）
// ...
return $cqueries;
}代码解读：
-
获取当前表的结构：
$wpdb->get_results( "DESCRIBE {$table_name}", ARRAY_A )获取当前表的结构，包括字段名、字段类型、键等信息。
-
解析新的表结构：
-
关键点： 使用
preg_match_all( '/ns*([^]+)s+([^,]+)(?:,s*)?n/ms’, $new_table_sql, $matches, PREG_SET_ORDER )` 从新的 SQL 语句中提取字段名和字段定义。ns*: 匹配一个换行符，后面跟着零个或多个空白字符。`([^`]+)`: 匹配一个反引号，后面跟着一个或多个非反引号字符（字段名），再跟着一个反引号。s+: 匹配一个或多个空白字符。([^,]+): 匹配一个或多个非逗号字符（字段定义）。(?:,s*)?: 匹配一个可选的逗号，后面跟着零个或多个空白字符。(?:...)表示一个非捕获组。n: 匹配一个换行符。/ms:m表示多行模式，s表示点号.可以匹配换行符。
-
这个正则稍微复杂，但它的目的是从
CREATE TABLE语句中提取出每个字段的名称和类型定义。
-
-
遍历新的字段：
- 循环遍历新的字段，检查它们是否已经存在于当前表中。
-
字段已存在，比较字段定义：
- 如果字段已经存在，则需要比较新的字段定义和当前字段的定义。
-
构建 ALTER TABLE 语句：
$alter_query = "ALTER TABLE {$table_name} CHANGE COLUMN{$field}`{$field}{$field_def}";` 构建 ALTER TABLE 语句，用于修改字段定义。
-
获取当前字段的完整定义：
get_column_definition( $table_name, $field )获取当前字段的完整定义。这个函数内部也包含一些正则解析的逻辑，用于从SHOW CREATE TABLE语句中提取字段定义。
-
比较字段定义：
- 使用
strtolower( trim( $current_field_def ) ) != strtolower( trim( $field_def ) )比较新的字段定义和当前字段的定义。注意，这里使用了strtolower()和trim()函数，以忽略大小写和空白字符的差异。
- 使用
-
字段定义不匹配，执行 ALTER TABLE 语句：
- 如果字段定义不匹配，则执行 ALTER TABLE 语句来更新字段定义。
-
字段不存在，添加字段：
- 如果字段不存在，则执行 ALTER TABLE 语句来添加字段。
-
处理索引：
maybe_add_column()函数还包含处理索引的逻辑，但这部分更加复杂，涉及更多的正则解析，这里为了简化，省略了。
五、get_column_definition()：获取字段定义的幕后英雄
get_column_definition() 函数负责获取当前表中指定字段的完整定义。它的实现方式是执行 SHOW CREATE TABLE 语句，然后使用正则解析结果。
function get_column_definition( $table, $column ) {
global $wpdb;
$create_table = $wpdb->get_row( $wpdb->prepare( 'SHOW CREATE TABLE `%s`', $table ), ARRAY_A );
if ( empty( $create_table['Create Table'] ) ) {
return '';
}
$create_table_sql = $create_table['Create Table'];
preg_match( "/`{$column}` ([^,n]+)/", $create_table_sql, $matches );
if ( isset( $matches[1] ) ) {
return $matches[1];
}
return '';
}代码解读：
-
执行
SHOW CREATE TABLE语句：$wpdb->get_row( $wpdb->prepare( 'SHOW CREATE TABLE%s', $table ), ARRAY_A )执行SHOW CREATE TABLE语句，获取表的创建语句。
-
正则解析：
-
关键点： 使用
preg_match( "/{$column}([^,n]+)/", $create_table_sql, $matches )从创建语句中提取字段定义。`{$column}`: 匹配字段名，字段名被反引号包裹。([^,n]+): 匹配一个或多个非逗号和非换行符字符（字段定义）。
-
-
返回字段定义：
- 如果匹配成功，则返回字段定义。
六、正则解析的威力与局限
通过以上分析，我们可以看到，dbDelta() 函数的核心在于使用正则解析 SQL 语句，提取表名、字段名、字段定义等信息。
正则解析的优点：
- 灵活性： 正则表达式可以匹配各种复杂的模式，使得
dbDelta()可以处理各种不同的 SQL 语句。 - 高效性： 正则表达式引擎通常经过高度优化，可以快速地匹配字符串。
正则解析的局限：
- 复杂性： 正则表达式本身可能非常复杂，难以理解和维护。
- 鲁棒性： 正则表达式可能无法处理所有可能的 SQL 语句，特别是当 SQL 语句的格式不规范时。
- 安全性： 如果正则表达式编写不当，可能会导致安全漏洞，例如正则表达式拒绝服务攻击（ReDoS）。
七、dbDelta() 的注意事项与最佳实践
-
SQL 语句必须规范：
dbDelta()依赖于正则解析，因此 SQL 语句必须符合一定的规范。例如，表名和字段名应该使用反引号包裹，字段定义应该完整。 -
dbDelta()不会删除字段或表：dbDelta()只会添加或修改字段，不会删除字段或表。如果需要删除字段或表，需要手动执行 SQL 语句。 -
dbDelta()可能会导致数据丢失： 在修改字段定义时，dbDelta()可能会导致数据丢失。例如，如果将一个INT类型的字段修改为VARCHAR类型，可能会导致数据截断。因此，在修改字段定义时，务必谨慎。 -
建议使用版本控制： 使用版本控制系统（例如 Git）来管理数据库表结构定义。这样可以方便地回滚到之前的版本，避免意外的数据丢失。
-
谨慎处理索引：
dbDelta()处理索引的逻辑比较复杂，容易出错。建议手动创建和管理索引。 -
避免过度依赖
dbDelta()：dbDelta()只是一个辅助工具，不应该过度依赖它。对于复杂的数据库表结构更新，建议手动编写 SQL 脚本。
八、总结
dbDelta() 函数是 WordPress 中一个非常重要的数据库管理工具。它使用正则解析 SQL 语句，自动创建和更新数据库表结构。虽然 dbDelta() 使用起来很方便，但了解其工作原理，特别是其正则解析的细节，对于编写高质量的 WordPress 插件和主题至关重要。希望今天的讲座能帮助大家更深入地理解 dbDelta() 函数，并在实际开发中更好地使用它。
好了，今天的分享就到这里，感谢大家的参与！希望下次有机会再和大家一起探讨 WordPress 的源码。