wpdb::get_row( string|null $query = null, string $output = OBJECT, int $y = 0 ): array|object|null|void
- Since
- 0.71
- Source
wp-includes/class-wpdb.php:3057
Description
Executes a SQL query and returns the row from the SQL result.
Compatibility
- WordPress
- since 0.71
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$querystring|nulloptional- SQL query.Default:
null $outputstringoptional- 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.Default:
OBJECT $yintoptional- Row to return. Indexed from 0. Default 0.Default:
0
Return value
array|object|null|void- Database query result in format specified by $output or null on failure.
Performance profile
How much work a call to wpdb::get_row() 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
- Scaling
- Constant
- Instructions
- 14–49
- Plugin surface
- None
- Called by
- 1
Reaches the database via wpdb::get_row().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 86.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- sqldatabase query
wpdb::get_row()this function does it
What one call costs · 11 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wpdb::get_row() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 14 | none |
| always | 23–35 | ->query() |
| always | 27–41 | ->check_safe_collation(), ->query() |
isset($y) && $y | 37 | ->query(), get_object_vars() |
isset($y) && $output !== false | 41–43 | ->query(), strtoupper() |
isset($y) && $output !== false | 41 | ->query(), strtoupper(), ->print_error() |
isset($y) && $y | 41–43 | ->check_safe_collation(), ->query(), get_object_vars() |
isset($y) && $y | 43 | ->query(), get_object_vars(), array_values() |
isset($y) && $output !== false | 45–49 | ->check_safe_collation(), ->query(), strtoupper() |
isset($y) && $output !== false | 45–47 | ->check_safe_collation(), ->query(), strtoupper(), ->print_error() |
isset($y) && $y | 47–49 | ->check_safe_collation(), ->query(), get_object_vars(), array_values() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 86 instructions, 14–49 executed per call, 12 branches. The work does not change between versions.
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 3
- wpdb::check_safe_collation()Checks if the query is accessing a collation considered safe on the current version of MySQL.
- wpdb::query()Performs a database query, using current database connection.
- wpdb::print_error()Prints SQL/DB error.
Used by · 1
- wpdb::strip_invalid_text()Strips any invalid characters based on value/charset pairs.
Source code
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' ); } }Changelog
Introduced in 0.71. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
array|object|null|void to array|object|null.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 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.