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

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

Parameters

$table_namestringrequired: Database table name.
$create_ddlstringrequired: 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;

	foreach ( $wpdb->get_col( 'SHOW TABLES', 0 ) as $table ) {
		if ( $table === $table_name ) {
			return true;
		}
	}

	// Didn't find it, so try to create it.
	// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- No applicable variables for this query.
	$wpdb->query( $create_ddl );

	// We cannot directly tell whether this succeeded!
	foreach ( $wpdb->get_col( 'SHOW TABLES', 0 ) as $table ) {
		if ( $table === $table_name ) {
			return true;
		}
	}

	return false;
}

View all references View on Trac View on GitHub

Uses	Description
wpdb::esc_like()`wp-includes/class-wpdb.php`	First half of escaping for `LIKE` special characters `%` and `_` before preparing for SQL.
wpdb::query()`wp-includes/class-wpdb.php`	Performs a database query, using current database connection.
wpdb::get_col()`wp-includes/class-wpdb.php`	Retrieves one column from the database.
wpdb::get_var()`wp-includes/class-wpdb.php`	Retrieves one value from the database.
wpdb::prepare()`wp-includes/class-wpdb.php`	Prepares a SQL query for safe execution.

Show 2 more Show less

Changelog

Version	Description
1.0.0	Introduced.

User Contributed Notes

Skip to note 3 content

fintot 7 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 6You 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 7 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.