wpdb::get_table_charset( string $table ): string|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$tablestring

Table name.

Return value

string|WP_Error

Table character set, WP_Error object if it couldn't be found.

Performance profile

How much work a call to wpdb::get_table_charset() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->get_results().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

14–74

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 133.

Plugin surface

1 hook

Third-party callbacks on 'pre_get_table_charset' run inside this call, and their cost is not bounded by anything here.

Called by

4

4 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->get_results()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wpdb::get_table_charset() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while wpdb::get_table_charset() runs, in this order:

1. 1
   apply_filters( pre_get_table_charset )filterline 3291 (+15 into the body)

   Filters the table charset value before the DB is checked.

Uses · 4

• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• wpdb::get_results()Retrieves an entire SQL result set from the database (i.e., many rows).
• WP_Error::__construct()Initializes the error.

Used by · 4

• wpdb::check_safe_collation()Checks if the query is accessing a collation considered safe.
• wpdb::get_col_charset()Retrieves the character set for the given column.
• wpdb::get_col_length()Retrieves the maximum string length allowed in a given column.
• wpdb::strip_invalid_text_from_query()Strips any invalid characters from the query.

Source code

View on Trac ↗View on GitHub ↗

3276	protected function get_table_charset( $table ) {3277		$tablekey = strtolower( $table );3278 3279		/**3280		 * Filters the table charset value before the DB is checked.3281		 *3282		 * Returning a non-null value from the filter will effectively short-circuit3283		 * checking the DB for the charset, returning that value instead.3284		 *3285		 * @since 4.2.03286		 *3287		 * @param string|WP_Error|null $charset The character set to use, WP_Error object3288		 *                                      if it couldn't be found. Default null.3289		 * @param string               $table   The name of the table being checked.3290		 */3291		$charset = apply_filters( 'pre_get_table_charset', null, $table );3292		if ( null !== $charset ) {3293			return $charset;3294		}3295 3296		if ( isset( $this->table_charset[ $tablekey ] ) ) {3297			return $this->table_charset[ $tablekey ];3298		}3299 3300		$charsets = array();3301		$columns  = array();3302 3303		$table_parts = explode( '.', $table );3304		$table       = '`' . implode( '`.`', $table_parts ) . '`';3305		$results     = $this->get_results( "SHOW FULL COLUMNS FROM $table" );3306		if ( ! $results ) {3307			return new WP_Error( 'wpdb_get_table_charset_failure', __( 'Could not retrieve table charset.' ) );3308		}3309 3310		foreach ( $results as $column ) {3311			$columns[ strtolower( $column->Field ) ] = $column;3312		}3313 3314		$this->col_meta[ $tablekey ] = $columns;3315 3316		foreach ( $columns as $column ) {3317			if ( ! empty( $column->Collation ) ) {3318				list( $charset ) = explode( '_', $column->Collation );3319 3320				$charsets[ strtolower( $charset ) ] = true;3321			}3322 3323			list( $type ) = explode( '(', $column->Type );3324 3325			// A binary/blob means the whole query gets treated like this.3326			if ( in_array( strtoupper( $type ), array( 'BINARY', 'VARBINARY', 'TINYBLOB', 'MEDIUMBLOB', 'BLOB', 'LONGBLOB' ), true ) ) {3327				$this->table_charset[ $tablekey ] = 'binary';3328				return 'binary';3329			}3330		}3331 3332		// utf8mb3 is an alias for utf8.3333		if ( isset( $charsets['utf8mb3'] ) ) {3334			$charsets['utf8'] = true;3335			unset( $charsets['utf8mb3'] );3336		}3337 3338		// Check if we have more than one charset in play.3339		$count = count( $charsets );3340		if ( 1 === $count ) {3341			$charset = key( $charsets );3342		} elseif ( 0 === $count ) {3343			// No charsets, assume this table can store whatever.3344			$charset = false;3345		} else {3346			// More than one charset. Remove latin1 if present and recalculate.3347			unset( $charsets['latin1'] );3348			$count = count( $charsets );3349			if ( 1 === $count ) {3350				// Only one charset (besides latin1).3351				$charset = key( $charsets );3352			} elseif ( 2 === $count && isset( $charsets['utf8'], $charsets['utf8mb4'] ) ) {3353				// Two charsets, but they're utf8 and utf8mb4, use utf8.3354				$charset = 'utf8';3355			} else {

Changelog

Introduced in 4.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wpdb.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.