如何在WordPress自定义插件激活时自动创建SQL数据表？

现有代码存在的问题 #

• 字段约束拼写错误：Event_Date字段的非空约束写为NOT NUll，正确拼写应为NOT NULL，语法错误会直接导致SQL执行失败
• 自增字段规则错误：Counter_Value字段错误使用不存在的关键字AUTO_DECREMENT，且MySQL单表仅允许一个自增字段，ID已经设为自增主键，该字段无需设置自增属性
• 数据类型参数错误：int类型的显示宽度最大支持11，代码中int(25)、int(56)属于无效参数，部分数据库版本会直接抛出异常
• 激活钩子执行风险：将建表和插数据两个逻辑分别挂载到激活钩子，可能出现插数据执行时表还未创建完成的问题
• 不符合dbDelta语法规范：WordPress内置的dbDelta函数对SQL格式要求严格，每个字段定义前需要保留2个空格缩进，否则可能无法正确解析执行

修复后完整代码 #

global $PICF_db_version;
$PICF_db_version = '1.0';
register_activation_hook( __FILE__, 'PICFCounter_install' );

function PICFCounter_install () {       
    global $wpdb;
    global $PICF_db_version;
    $table_name = $wpdb->prefix . "picfcounter"; // 统一小写命名避免跨系统大小写敏感问题
    $charset_collate = $wpdb->get_charset_collate();

    // 检查表是否已存在
    if($wpdb->get_var( "show tables like '$table_name'") != $table_name) {
        $sql = "CREATE TABLE $table_name (
          ID int(11) NOT NULL auto_increment,
          City varchar(55) DEFAULT '' NOT NULL,
          Event_Date date NOT NULL,
          Counter_Value int(11) NOT NULL,
          PRIMARY KEY (ID)
        ) $charset_collate;";
        
        require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
        dbDelta( $sql );

        // 存储插件版本号方便后续版本升级判断
        add_option( 'PICF_db_version', $PICF_db_version );

        // 建表成功后直接调用插入初始数据逻辑，避免执行顺序异常
        PICFCounter_install_data();
    }
}

function PICFCounter_install_data() {
    global $wpdb;
    $table_name = $wpdb->prefix . "picfcounter";
    $city = 'Calgary';
    $date = '2022-01-11';
    $counter = 25;
    
    $wpdb->insert( 
        $table_name, 
        array( 
            'City' => $city,
            'Event_Date' => $date,
            'Counter_Value' => $counter
        ) 
    );
}

操作注意事项 #

• 激活插件前先删除后台已安装的错误版本插件，清除残留数据后重新上传激活
• 如需排查SQL错误，可以在dbDelta执行后添加echo $wpdb->last_error;打印具体错误信息
• 生产环境使用建议增加异常判断，避免建表失败时插入数据抛出PHP错误

内容的提问来源于stack exchange，提问作者Spineless