$database->getColumns() method

Get all columns from given table

By default returns array of column names. If verbose option is true then it returns an array of arrays, each having 'name', 'type', 'null', 'default', and 'extra' keys, indicating the column name, column type, whether it can be null, what it’s default value is, and any extra information, such as whether it is auto_increment. The verbose option also makes the return value indexed by column name (associative array).

Available since version 3.0.180.

Usage

// basic usage
$array = $database->getColumns(string $table);

// usage with all arguments
$array = $database->getColumns(string $table, $verbose = false);

Arguments

NameType(s)Description
tablestring

Table name or or table.column to get for specific column (when combined with verbose=true)

verbose (optional)bool, int, string

Include array of verbose information for each? (default=false)

  • Omit or false (bool) to just get column names.
  • True (bool) or 1 (int) to get a verbose array of information for each column, indexed by column name.
  • 2 (int) to get raw MySQL column information, indexed by column name (added 3.0.182).
  • 3 (int) to get column types as used in a CREATE TABLE statement (added 3.0.185).
  • Column name (string) to get verbose array only for only that column (added 3.0.182).

Return value

array


$database methods and properties

API reference based on ProcessWire core version 3.0.185

Twitter updates

  • ProcessWire 3.0.192 (dev branch) contains 11 issue fixes and 5 pull requests, over 20 commits— More
    7 January 2022
  • ProcessWire 3.0.191 core updates: updates to the installer and the profile exporter module— More
    24 December 2021
  • This week ProcessWire went on a diet, trimming the core size from 15.5 MB down to 7.5 MB by moving optional site profiles into their own GitHub repos— More
    17 December 2021

Latest news

  • ProcessWire Weekly #401
    In the 401st issue of ProcessWire Weekly we'll cover the latest core updates, check out a brand new module called Lister Native Date Format, and more. Read on!
    Weekly.pw / 15 January 2022
  • ProcessWire 3.0.190 core updates
    ProcessWire 3.0.190 has 15 commits relative to 3.0.189 and contains a mixture of issue resolutions and feature additions. This post covers them all, in addition to updates for the PageAutosave and ProFields Table modules.
    Blog / 3 December 2021
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani