WordPress at Your Fingertips
function is not described

maybe_add_column() WP 1.3.0

Adds column to a database table, if it doesn't already exist.

No Hooks.

Return

true|false. True on success or if the column already exists. False on failure.

Usage

maybe_add_column( $table_name, $column_name, $create_ddl );
$table_name(string) (required)
Database table name.
$column_name(string) (required)
Table column name.
$create_ddl(string) (required)
SQL statement to add column.

Notes

  • Global. wpdb. $wpdb WordPress database abstraction object.

Changelog

Since 1.3.0 Introduced.

Code of maybe_add_column() WP 5.8.2

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;
}