wpdb::get_row( string|null $query = null, string $output = OBJECT, int $y ): array|object|null|void

Retrieves one row from the database.


Description

Executes a SQL query and returns the row from the SQL result.


Top ↑

Parameters

$query string|null Optional
SQL query.

Default: null

$output string Optional
The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to an stdClass object, an associative array, or a numeric array, respectively.

Default: OBJECT

$y int Optional
Row to return. Indexed from 0.

Top ↑

Return

array|object|null|void Database query result in format specified by $output or null on failure.


Top ↑

Source

File: wp-includes/wp-db.php. View all references

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

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

		$this->query( $query );
	} else {
		return null;
	}

	if ( ! isset( $this->last_result[ $y ] ) ) {
		return null;
	}

	if ( OBJECT === $output ) {
		return $this->last_result[ $y ] ? $this->last_result[ $y ] : null;
	} elseif ( ARRAY_A === $output ) {
		return $this->last_result[ $y ] ? get_object_vars( $this->last_result[ $y ] ) : null;
	} elseif ( ARRAY_N === $output ) {
		return $this->last_result[ $y ] ? array_values( get_object_vars( $this->last_result[ $y ] ) ) : null;
	} elseif ( OBJECT === strtoupper( $output ) ) {
		// Back compat for OBJECT being previously case-insensitive.
		return $this->last_result[ $y ] ? $this->last_result[ $y ] : null;
	} else {
		$this->print_error( ' $db->get_row(string query, output type, int offset) -- Output type must be one of: OBJECT, ARRAY_A, ARRAY_N' );
	}
}


Top ↑

Changelog

Changelog
Version Description
0.71 Introduced.

Top ↑

User Contributed Notes

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