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

Retrieves one row from the database.

Description

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

Parameters

$query

(string|null) (Optional) SQL query.

Default value: 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 value: OBJECT

$y

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

Return

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

Source

File: wp-includes/wp-db.php 

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

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

		if ( $query ) {
			$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' );
		}
	}

Uses

Uses Description
wp-includes/wp-db.php: wpdb::check_safe_collation()

Checks if the query is accessing a collation considered safe on the current version of MySQL.
wp-includes/wp-db.php: wpdb::query()

Performs a MySQL database query, using current database connection.
wp-includes/wp-db.php: wpdb::print_error()

Prints SQL/DB error.

Used By

Used By Description
wp-includes/post.php: wp_delete_attachment_files()

Deletes all files that belong to the given attachment.
wp-includes/class-wp-site.php: WP_Site::get_instance()

Retrieves a site from the database by its ID.
wp-includes/class-wp-network.php: WP_Network::get_instance()

Retrieve a network from the database by its ID.
wp-includes/class-wp-comment.php: WP_Comment::get_instance()

Retrieves a WP_Comment instance.
wp-includes/option.php: delete_network_option()

Removes a network option by name.
wp-includes/option.php: get_network_option()

Retrieves a network’s option value based on the option name.
wp-includes/wp-db.php: wpdb::strip_invalid_text()

Strips any invalid characters based on value/charset pairs.
wp-admin/includes/upgrade.php: maybe_convert_table_to_utf8mb4()

If a table only contains utf8 or utf8mb4 columns, convert it to utf8mb4.
wp-admin/includes/network.php: allow_subdirectory_install()

Allow subdirectory installation.
wp-includes/class-wp-user.php: WP_User::get_data_by()

Return only the main user fields
wp-includes/general-template.php: get_calendar()

Display calendar with days that have posts as links.
wp-includes/deprecated.php: delete_usermeta()

Remove user meta data.
wp-includes/deprecated.php: update_usermeta()

Update metadata of user.
wp-includes/taxonomy.php: wp_insert_term()

Add a new term to the database.
wp-includes/taxonomy.php: term_exists()

Determines whether a taxonomy term exists.
wp-includes/option.php: delete_option()

Removes option by name. Prevents removal of protected WordPress options.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/user.php: count_users()

Count number of users who have each of the user roles.
wp-includes/class-wp-post.php: WP_Post::get_instance()

Retrieve WP_Post instance.
wp-includes/post.php: wp_delete_attachment()

Trash or delete an attachment.
wp-includes/post.php: wp_delete_post()

Trash or delete a post or page.
wp-includes/ms-functions.php: get_most_recent_post_of_user()

Get a user’s most recent post.
wp-includes/ms-functions.php: global_terms()

Maintains a canonical list of terms by syncing terms created for each blog with the global terms table.
wp-includes/ms-functions.php: wpmu_activate_signup()

Activate a signup.
wp-includes/ms-functions.php: wpmu_validate_user_signup()

Sanitize and validate data required for a user sign-up.
wp-includes/ms-functions.php: wpmu_validate_blog_signup()

Processes new site registrations.
wp-includes/bookmark.php: get_bookmark()

Retrieve Bookmark data
wp-includes/ms-blogs.php: get_blog_details()

Retrieve the details for a blog from the blogs table and blog options.
wp-includes/meta.php: get_metadata_by_mid()

Retrieves metadata by meta ID.

Changelog

Version Description
0.71 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wpdb/get_row