WordPress at a glance
function is not described

check_column() WP 1.0.0

Check column matches 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

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

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)
Table name
$col_name(string) (required)
Column name
$col_type(string) (required)
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

Code of check column: wp-admin/install-helper.php VER 5.1.1

<?php
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 ( ( $col_type != null ) && ( $row->Type != $col_type ) ) {
				++$diffs;
			}
			if ( ( $is_null != null ) && ( $row->Null != $is_null ) ) {
				++$diffs;
			}
			if ( ( $key != null ) && ( $row->Key != $key ) ) {
				++$diffs;
			}
			if ( ( $default != null ) && ( $row->Default != $default ) ) {
				++$diffs;
			}
			if ( ( $extra != null ) && ( $row->Extra != $extra ) ) {
				++$diffs;
			}
			if ( $diffs > 0 ) {
				return false;
			}
			return true;
		} // end if found our column
	}
	return false;
}