wpdb::get_results( string $query = null, string $output = OBJECT )

Retrieve an entire SQL result set from the database (i.e., many rows)

Contents

Description Description

Executes a SQL query and returns the entire SQL result.

Parameters Parameters

$query

(string) (Optional) SQL query.

Default value: null

$output

(string) (Optional) Any of ARRAY_A | ARRAY_N | OBJECT | OBJECT_K constants. With one of the first three, return an array of rows indexed from 0 by SQL result row number. Each row is an associative array (column => value, ...), a numerically indexed array (0 => value, ...), or an object. ( ->column = value ), respectively. With OBJECT_K, return an associative array of row objects keyed by the value of each row's first column's value. Duplicate keys are discarded.

Default value: OBJECT

Top ↑

Return Return

(array|object|null) Database query results

Top ↑

Source Source

File: wp-includes/wp-db.php 

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

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

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

		$new_array = array();
		if ( $output == OBJECT ) {
			// Return an integer-keyed array of row objects
			return $this->last_result;
		} elseif ( $output == OBJECT_K ) {
			// Return an array of row objects with keys from column 1
			// (Duplicates are discarded)
			if ( $this->last_result ) {
				foreach ( $this->last_result as $row ) {
					$var_by_ref = get_object_vars( $row );
					$key        = array_shift( $var_by_ref );
					if ( ! isset( $new_array[ $key ] ) ) {
						$new_array[ $key ] = $row;
					}
				}
			}
			return $new_array;
		} elseif ( $output == ARRAY_A || $output == ARRAY_N ) {
			// Return an integer-keyed array of...
			if ( $this->last_result ) {
				foreach ( (array) $this->last_result as $row ) {
					if ( $output == ARRAY_N ) {
						// ...integer-keyed row arrays
						$new_array[] = array_values( get_object_vars( $row ) );
					} else {
						// ...column name-keyed row arrays
						$new_array[] = get_object_vars( $row );
					}
				}
			}
			return $new_array;
		} elseif ( strtoupper( $output ) === OBJECT ) {
			// Back compat for OBJECT being previously case insensitive.
			return $this->last_result;
		}
		return null;
	}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
0.71 Introduced.

Top ↑

Top ↑

Uses Uses

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

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

Perform a MySQL database query, using current database connection.

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/class-wp-debug-data.php: WP_Debug_Data::get_database_size()

Fetch the total size of all the database tables for the active database user.
wp-includes/ms-site.php: wp_is_site_initialized()

Checks whether a site is initialized.
wp-admin/includes/class-wp-privacy-requests-table.php: WP_Privacy_Requests_Table::get_request_counts()

Count number of requests for each status.
wp-includes/taxonomy.php: has_term_meta()

Get all meta data, including meta IDs, for the given term ID.
wp-includes/class-wp-term-query.php: WP_Term_Query::get_terms()

Get terms, based on query_vars.
wp-includes/taxonomy.php: _prime_term_caches()

Adds any terms from the given IDs to the cache that do not already exist in cache.
wp-includes/ms-network.php: _prime_network_caches()

Adds any networks from the given IDs to the cache that do not already exist in cache.
wp-includes/ms-site.php: _prime_site_caches()

Adds any sites from the given ids to the cache that do not already exist in cache.
wp-admin/includes/export.php: wxr_term_meta()

Output term meta XML tags for a given term object.
wp-includes/class-wp-term.php: WP_Term::get_instance()

Retrieve WP_Term instance.
wp-includes/comment.php: _prime_comment_caches()

Adds any comments from the given IDs to the cache that do not already exist in cache.
wp-includes/taxonomy.php: _wp_batch_split_terms()

Splits a batch of shared taxonomy terms.
wp-includes/wp-db.php: wpdb::get_table_charset()

Retrieves the character set for the given table.
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/install-helper.php: check_column()

Check column matches criteria.
wp-admin/export.php: export_date_options()

Create the date options fields for exporting a given post type.
wp-admin/includes/export.php: export_wp()

Generates the WXR export file for download.
wp-admin/includes/export.php: wxr_authors_list()

Output list of authors with posts
wp-admin/includes/deprecated.php: get_editable_authors()

Gets author users who can edit posts.
wp-admin/includes/deprecated.php: get_others_unpublished_posts()

Retrieves editable posts from other users.
wp-admin/includes/class-wp-list-table.php: WP_List_Table::months_dropdown()

Display a monthly dropdown for filtering items
wp-admin/includes/upgrade.php: pre_schema_upgrade()

Runs before the schema is upgraded.
wp-admin/includes/upgrade.php: upgrade_network()

Executes network-level upgrade routines.
wp-admin/includes/upgrade.php: get_alloptions_110()

Retrieve all options as it was for 1.2.
wp-admin/includes/upgrade.php: dbDelta()

Modifies the database based on specified SQL statements.
wp-admin/includes/user.php: get_users_drafts()

Retrieve the user’s drafts.
wp-admin/includes/template.php: parent_dropdown()

Print out option HTML elements for the page parents drop-down.
wp-admin/includes/media.php: media_upload_library_form()

Outputs the legacy media upload form for the media library.
wp-admin/includes/post.php: has_meta()

Get meta data for the given post ID.
wp-admin/includes/post.php: bulk_edit_posts()

Process the post data for the bulk editing of posts.
wp-admin/includes/class-wp-importer.php: WP_Importer::get_imported_comments()

Set array with imported comments from WordPress database
wp-admin/includes/class-wp-importer.php: WP_Importer::get_imported_posts()

Returns array with imported permalinks from WordPress database
wp-admin/includes/class-wp-importer.php: WP_Importer::count_imported_posts()

Return count of imported permalinks from WordPress database
wp-admin/includes/comment.php: get_pending_comments_num()

Get the number of pending comments on a post or posts
wp-includes/pluggable.php: cache_users()

Retrieve info for user lists to prevent multiple queries by get_userdata()
wp-includes/general-template.php: wp_get_archives()

Display archive links based on type and format.
wp-includes/general-template.php: get_calendar()

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

Get users for the site.
wp-includes/class-wp-query.php: WP_Query::get_posts()

Retrieves an array of posts based on query variables.
wp-includes/functions.php: wp_scheduled_delete()

Permanently delete comments or posts of any type that have held a status of ‘trash’ for the number of days defined in EMPTY_TRASH_DAYS.
wp-includes/functions.php: is_blog_installed()

Determines whether WordPress is already installed.
wp-includes/taxonomy.php: _pad_term_counts()

Add count of children to parent count.
wp-includes/taxonomy.php: clean_term_cache()

Will remove all of the term ids from the cache.
wp-includes/taxonomy.php: wp_delete_term()

Removes a term from the database.
wp-includes/option.php: wp_load_alloptions()

Loads and caches all autoloaded options, if available or all options.
wp-includes/option.php: wp_load_core_site_options()

Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used.
wp-includes/class-wp-user-query.php: WP_User_Query::query()

Execute the query, with the current variables.
wp-includes/user.php: count_many_users_posts()

Number of posts written by a list of users.
wp-includes/media.php: wp_enqueue_media()

Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.
wp-includes/post.php: _prime_post_caches()

Adds any posts from the given ids to the cache that do not already exist in cache
wp-includes/post.php: get_page_by_path()

Retrieves a page given its path.
wp-includes/post.php: get_pages()

Retrieve a list of pages (or hierarchical post type items).
wp-includes/post.php: wp_delete_post()

Trash or delete a post or page.
wp-includes/post.php: wp_trash_post_comments()

Moves comments for a post to the trash.
wp-includes/post.php: wp_count_posts()

Count number of posts of a post type and if user has permissions to view.
wp-includes/post.php: wp_count_attachments()

Count number of attachments for the mime type(s).
wp-includes/class-wp-rewrite.php: WP_Rewrite::page_uri_index()

Retrieves all page and attachments for pages URIs.
wp-includes/canonical.php: redirect_canonical()

Redirects incoming links to the proper URL based on the site url.
wp-includes/ms-deprecated.php: install_blog()

Install an empty blog.
wp-includes/ms-deprecated.php: get_admin_users_for_domain()

Get the admin for a domain/path combination.
wp-includes/bookmark.php: get_bookmarks()

Retrieves the list of bookmarks
wp-includes/ms-deprecated.php: get_blog_list()

Deprecated functionality to retrieve a list of all sites.
wp-includes/author-template.php: wp_list_authors()

List all the authors of the site, with several options available.
wp-includes/ms-blogs.php: get_last_updated()

Get a list of most recently updated blogs.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mt_getTrackbackPings()

Retrieve trackbacks sent to a given post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::pingback_ping()

Retrieves a pingback and registers it.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::pingback_extensions_getPingbacks()

Retrieve array of URLs that pingbacked the given URL.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::attach_uploads()

Attach upload to a post.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPageList()

Retrieve page list.
wp-includes/comment.php: get_comment_count()

Retrieves the total comment counts for the whole site or a single post.
wp-includes/meta.php: update_meta_cache()

Update the metadata cache for the specified objects.
Show 66 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note
    Contributed by fabianplaza —

    Example about how can you retrieve data from a table using get_results function:

    public function some_function($some_parameter) {
        global $wpdb;
        $results = $wpdb->get_results( 
                    $wpdb->prepare("SELECT count(ID) as total FROM {$wpdb->prefix}your_table_without_prefix WHERE some_field_in_your_table=%d", $some_parameter) 
                 );
}

    Please, note that I have used %d assuming that $some_parameter is a int value.

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