$database->columnExists() method

Does the given column exist in given table?

Available since version 3.0.154.

Example

// Standard usage:
if($database->columnExists('pages', 'name')) {
  echo "The pages table has a 'name' column";
}

// You can also bundle table and column together:
if($database->columnExists('pages.name')) {
  echo "The pages table has a 'name' column";
}

$exists = $database->columnExists('pages', 'name', true);
if($exists) {
  // associative array with indexes: Name, Type, Null, Key, Default, Extra
  echo "The pages table has a 'name' column and here is verbose info: ";
  print_r($exists);
}

Usage

// basic usage
$bool = $database->columnExists(string $table);

// usage with all arguments
$bool = $database->columnExists(string $table, string $column = '', bool $getInfo = false);

Arguments

NameType(s)Description
tablestring

Specify table name (or table and column name in format "table.column").

column (optional)string

Specify column name (or omit or blank string if already specified in $table argument).

getInfo (optional)bool

Return array of column info (with type info, etc.) rather than true when exists? (default=false) Note that the returned array is raw MySQL values from a SHOW COLUMNS command.

Return value

bool array

Exceptions

Method can throw exceptions on error:

  • WireDatabaseException


$database methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull