check_column

Advertisement

Summery Summery

Checks that database table column matches the criteria.

Syntax Syntax

check_column( string $table_name, string $col_name, string $col_type, bool $is_null = null, mixed $key = null, mixed $default = null, mixed $extra = null )

Description Description

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

Parameters Parameters

$table_name

(string) (Required) Database table name.

$col_name

(string) (Required) Table column name.

$col_type

(string) (Required) Table column type.

$is_null

(bool) (Optional) Check is null.

Default value: null

$key

(mixed) (Optional) Key info.

Default value: null

$default

(mixed) (Optional) Default value.

Default value: null

$extra

(mixed) (Optional) Extra value.

Default value: null

Return Return

(bool) True, if matches. False, if not matching.

Source Source

File: wp-admin/install-helper.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 ( ( 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;
}

Advertisement

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.