maybe_add_column

Advertisement

Summery Summery

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

Syntax Syntax

maybe_add_column( string $table_name, string $column_name, string $create_ddl )

Parameters Parameters

$table_name

(Required) Database table name.

$column_name

(Required) Table column name.

$create_ddl

(Required) SQL statement to add column.

Return Return

(bool) True on success or if the column already exists. False on failure.

Source Source

File: wp-admin/install-helper.php

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

Advertisement

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Advertisement

Leave a Reply