wpdb::get_var( string|null $query = null, int $x, int $y )

Retrieve one variable from the database.


Description Description

Executes a SQL query and returns the value from the SQL result. If the SQL result contains more than one column and/or more than one row, this function returns the value in the column and row specified. If $query is null, this function returns the value in the specified column and row from the previous SQL result.


Parameters Parameters

$query

(string|null) (Optional) SQL query. Defaults to null, use the result from the previous query.

Default value: null

$x

(int) (Optional) Column of value to return. Indexed from 0.

$y

(int) (Optional) Row of value to return. Indexed from 0.


Top ↑

Return Return

(string|null) Database query result (as string), or null on failure


Top ↑

Source Source

File: wp-includes/wp-db.php

	public function get_var( $query = null, $x = 0, $y = 0 ) {
		$this->func_call = "\$db->get_var(\"$query\", $x, $y)";

		if ( $this->check_current_query && $this->check_safe_collation( $query ) ) {
			$this->check_current_query = false;
		}

		if ( $query ) {
			$this->query( $query );
		}

		// Extract var out of cached results based x,y vals
		if ( !empty( $this->last_result[$y] ) ) {
			$values = array_values( get_object_vars( $this->last_result[$y] ) );
		}

		// If there is a value return it else return null
		return ( isset( $values[$x] ) && $values[$x] !== '' ) ? $values[$x] : null;
	}

Top ↑

Changelog Changelog

Changelog
Version Description
0.71 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.