WordPress at Your Fingertips
function is not described

check_column() WP 1.0.0

Checks that database table column matches the criteria.

Uses the SQL DESC for retrieving the table info for the column. It will help understand the parameters, if you do more research on what column information is returned by the SQL statement. Pass in null to skip checking that criteria.

Column names returned from DESC table are case sensitive and are listed:

Field
Type
Null
Key
Default
Extra

No Hooks.

Return

true|false. True, if matches. False, if not matching.

Usage

check_column( $table_name, $col_name, $col_type, $is_null, $key, $default, $extra );
$table_name(string) (required)
Database table name.
$col_name(string) (required)
Table column name.
$col_type(string) (required)
Table column type.
$is_null(true|false)
Check is null.
Default: null
$key(mixed)
Key info.
Default: null
$default(mixed)
Optional.
Default: value
$extra(mixed)
Extra value.
Default: null

Notes

  • Global. wpdb. $wpdb WordPress database abstraction object.

Changelog

Since 1.0.0 Introduced.

Code of check_column() WP 5.8.2

function check_column( $table_name, $col_name, $col_type, $is_null = null, $key = null, $default = null, $extra = null ) {
	global $wpdb;

	$diffs   = 0;
	$results = $wpdb->get_results( "DESC $table_name" );

	foreach ( $results as $row ) {

		if ( $row->Field === $col_name ) {

			// Got our column, check the params.
			if ( ( null !== $col_type ) && ( $row->Type !== $col_type ) ) {
				++$diffs;
			}
			if ( ( null !== $is_null ) && ( $row->Null !== $is_null ) ) {
				++$diffs;
			}
			if ( ( null !== $key ) && ( $row->Key !== $key ) ) {
				++$diffs;
			}
			if ( ( null !== $default ) && ( $row->Default !== $default ) ) {
				++$diffs;
			}
			if ( ( null !== $extra ) && ( $row->Extra !== $extra ) ) {
				++$diffs;
			}

			if ( $diffs > 0 ) {
				return false;
			}

			return true;
		} // End if found our column.
	}

	return false;
}