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 as listed:

• Field
• Type
• Null
• Key
• Default
• Extra

Хуков нет.

Возвращает

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

Использование

check_column( $table_name, $col_name, $col_type, $is_null, $key, $default_value, $extra );

$table_name(строка) (обязательный)

Database table name.

$col_name(строка) (обязательный)

Table column name.

$col_type(строка) (обязательный)

Table column type.

$is_null(true|false)

Check is null.
По умолчанию: null

$key(разное)

Key info.
По умолчанию: null

$default_value(разное)

Optional.
По умолчанию: value

$extra(разное)

Extra value.
По умолчанию: null

Заметки

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

Список изменений

Код check_column() check column ^{WP 6.5.2}

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

	$diffs = 0;

	// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- Cannot be prepared. Fetches columns for table names.
	$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_value ) && ( $row->Default !== $default_value ) ) {
				++$diffs;
			}
			if ( ( null !== $extra ) && ( $row->Extra !== $extra ) ) {
				++$diffs;
			}

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

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

	return false;
}