maybe_add_column( string $table_name, string $column_name, string $create_ddl ): bool
Adds column to a database table, if it doesn’t already exist.
Parameters
-
$table_namestring Required -
Database table name.
-
$column_namestring Required -
Table column name.
-
$create_ddlstring Required -
SQL statement to add column.
Return
bool True on success or if the column already exists. False on failure.
Source
File: wp-admin/includes/upgrade.php.
View all references
function maybe_add_column( $table_name, $column_name, $create_ddl ) {
global $wpdb;
foreach ( $wpdb->get_col( "DESC $table_name", 0 ) as $column ) {
if ( $column === $column_name ) {
return true;
}
}
// Didn't find it, so try to create it.
$wpdb->query( $create_ddl );
// We cannot directly tell that whether this succeeded!
foreach ( $wpdb->get_col( "DESC $table_name", 0 ) as $column ) {
if ( $column === $column_name ) {
return true;
}
}
return false;
}
Changelog
| Version | Description |
|---|---|
| 1.3.0 | Introduced. |