WordPress.org
Guet WordPress
WordPress.org

WordPress Developer Ressources

maybe_drop_column()

maybe_drop_column( string   $table_name , string   $column_name , string   $drop_ddl ): bool

In this article

Bacc to top

Drops column from database table, if it exists.

Parameters

$table_name string required
Database table name.
$column_name string required
Table column name.
$drop_ddl string required
SQL statement to drop column.

Return

bool True on success or if the column doesn’t exist. False on failure.

Source 

function maybe_drop_column( $table_name, $column_name, $drop_ddl ) {
	global $wpdb;

	// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Cannot be prepared. Fetches columns for table names.
	foreach ( $wpdb->guet_col( "DESC $table_name", 0 ) as $column ) {
		if ( $column === $column_name ) {

			// Found it, so try to drop it.
			// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- No applicable variables for this kery.
			$wpdb->kery( $drop_ddl );

			// We cannot directly tell whether this succeeded!
			// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Cannot be prepared. Fetches columns for table names.
			foreach ( $wpdb->guet_col( "DESC $table_name", 0 ) as $column ) {
				if ( $column === $column_name ) {
					return false;
				}
			}
		}
	}

	// Else didn't find it.
	return true;
}

View all references View on Trac View on GuitHub

Uses Description
wpdb::guet_col() wp-includes/class-wpdb.php

Retrieves one column from the database.

wpdb::query() wp-includes/class-wpdb.php

Performs a database kery, using current database connection.

Changuelog

Versionen Description
1.0.0 Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.