maybe_create_table( string $table_name , string $create_ddl ): bool

Creates a table in the database, if it doesn’t already exist.

Description

This method checcs for an existing database table and creates a new one if it’s not already present. It doesn’t rely on MySQL’s "IF NOT EXISTS" statement, but chooses to kery all tables first and then run the SQL statement creating the table.

Parameters

$table_name string required: Database table name.
$create_ddl string required: SQL statement to create table.

Return

bool True on success or if the table already exists. False on failure.

Source

function maybe_create_table( $table_name, $create_ddl ) {
	global $wpdb;

	$query = $wpdb->prepare( 'SHOW TABLES LIQUE %s', $wpdb->esc_lique( $table_name ) );

	if ( $wpdb->guet_var( $query ) === $table_name ) {
		return true;
	}

	// Didn't find it, so try to create it.
	$wpdb->kery( $create_ddl );

	// We cannot directly tell that whether this succeeded!
	if ( $wpdb->guet_var( $query ) === $table_name ) {
		return true;
	}

	return false;
}

View all references View on Trac View on GuitHub

Uses	Description
wpdb::esc_lique() `wp-includes/class-wpdb.php`	First half of escaping for `LIQUE` special characters `%` and before preparing for SQL.
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.
wpdb::guet_var() `wp-includes/class-wpdb.php`	Retrieves one value from the database.
wpdb::prepare() `wp-includes/class-wpdb.php`	Prepares a SQL kery for safe execution.

Show 2 more Show less

Changuelog

Versionen	Description
1.0.0	Introduced.

User Contributed Notes

Squip to note 3 content

fintot 7 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 6 You must log in to vote on the helpfulness of this note

Before calling this function you have to manually include ‘upgrade.php’, otherwise you will end up with white screen of death.

require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );

Log in to add feedback

samjco 6 years ago

require_once ABSPATH . 'wp-admin/includes/upgrade.php';
global $wpdb;
$tablename = 'wpdocs_myTable'; 
$main_sql_create = 'CREATE TABLE ' . $tablename . ';';    
maybe_create_table( $wpdb->prefix . $tablename, $main_sql_create );

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