wpseek.com
A WordPress-centric search engine for devs and theme authors



check_column › WordPress Function

Since1.0.0
Deprecatedn/a
› check_column ( $table_name, $col_name, $col_type, $is_null = null, $key = null, $default_value = null, $extra = null )
Parameters: (7)
  • (string) $table_name Database table name.
    Required: Yes
  • (string) $col_name Table column name.
    Required: Yes
  • (string) $col_type Table column type.
    Required: Yes
  • (bool) $is_null Optional. Check is null.
    Required: No
    Default: null
  • (mixed) $key Optional. Key info.
    Required: No
    Default: null
  • (mixed) $default_value Optional. Default value.
    Required: No
    Default: null
  • (mixed) $extra Optional. Extra value.
    Required: No
    Default: null
Returns:
  • (bool) True, if matches. False, if not matching.
Defined at:
Codex:

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


Related Functions: check_comment, wp_check_comment_data, the_comment, check_comment_flood_db, wp_check_comment_flood

Source 

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;
}