WP_Query::get( string $query_var, mixed $default_value = '' ): mixed

Retrieves the value of a query variable.

Contents

Parameters

$query_var string Required
Query variable key.
$default_value mixed Optional
Value to return if the query variable is not set.

Default: ''

Top ↑

Return

mixed Contents of the query variable.

Top ↑

Source

File: wp-includes/class-wp-query.php. View all references 

public function get( $query_var, $default_value = '' ) {
	if ( isset( $this->query_vars[ $query_var ] ) ) {
		return $this->query_vars[ $query_var ];
	}

	return $default_value;
}

View on Trac View on GitHub

Top ↑

Top ↑

Used By

Used By
Used By Description
WP_Query::generate_postdata() wp-includes/class-wp-query.php

Generate post data.
WP_Query::is_feed() wp-includes/class-wp-query.php

Is the query for a feed?
WP_Query::get_queried_object() wp-includes/class-wp-query.php

Retrieves the currently queried object.
WP_Query::is_post_type_archive() wp-includes/class-wp-query.php

Is the query for an existing post type archive page?
get_query_var() wp-includes/query.php

Retrieves the value of a query variable in the WP_Query class.
get_body_class() wp-includes/post-template.php

Retrieves an array of the class names for the body element.
Show 1 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
3.9.0 The $default_value argument was introduced.
1.5.0 Introduced.

Top ↑

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: 0You must log in to vote on the helpfulness of this note
    Contributed by Sabrina Zeidan —

    Check if it’s Custom post type query: 

     
if ( 'recipe' === $query->get( 'post_type' ) ) { 
	//do your stuff 
}

    Usage scenario: if it’s a query for CPT recipe, it’s not the main query, it’s not admin -> say Hello! before it starts

    add_action( 'loop_start', 'wpdocs_recipes_loop_start' ); 
function wpdocs_recipes_loop_start( $query ){
	if ( !$query->is_main_query() && 'recipe' === $query->get( 'post_type' ) && ! is_admin() ) {
		echo "Hello!";  	
	}
}

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