set_query_var( string $query_var, mixed $value )

Sets the value of a query variable in the WP_Query class.

Contents

Parameters
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes
- Feedback

Parameters

$query_var string Required: Query variable key.
$value mixed Required: Query variable value.

Source

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

function set_query_var( $query_var, $value ) {
	global $wp_query;
	$wp_query->set( $query_var, $value );
}

View on Trac View on GitHub

Uses

Uses
Uses	Description
WP_Query::set() wp-includes/class-wp-query.php	Sets the value of a query variable.

Used By

Used By
Used By	Description
build_comment_query_vars_from_block() wp-includes/blocks.php	Helper function that constructs a comment query vars array from the passed block properties.
wp_list_comments() wp-includes/comment-template.php	Displays a list of comments.
comments_template() wp-includes/comment-template.php	Loads the comment template specified in $file.

Changelog

Changelog
Version	Description
2.2.0	Introduced.

User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 11You must log in to vote on the helpfulness of this note

Contributed by stode — 6 years ago
One use case for this is to pass variable to template file when calling it with get_template_part().
```
// When calling a template with get_template_part()
set_query_var('my_form_id', 23);
get_template_part('my-form-template');
```
Now in you template you can then call it.
```
// Inside my-form-template.php
$my_form_id = get_query_var('my_form_id');
```
Log in to add feedback
Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by Anonymous User — 4 years ago
This is a way to pass variables to the called files.

On the a.php file:
```
$sample = 'a sample variable';
$year = 2019;

$arr = [
	'sample' =&gt; $sample,
	'year' =&gt; $year
];

set_query_var( 'multiVar', $arr );
get_template_part( 'b' );
get_template_part( 'c' );
```
On the b.php file:
```
$arr = get_query_var( 'multiVar' );
echo $arr['year']; // This will print out: 1995
```
On the c.php file:
```
$arr = get_query_var( 'multiVar' );
echo $arr['sample']; // This will print out: a sample variable
```
Top ↑
Feedback
- IMO: Using extract method can help readability, in my case allowed me not rename variables already in use. On the c.php file:
  
  extract( get_query_var( 'multiVar' ) ); echo $sample; // This will print out: a sample variable
  
  — By Ivo Vicente — 4 years ago
- extract() is regarded as a “terrible function” by WordPress coding standards; please do not use. list() is similar to extract(), and is much more readable. — By crstauf — 4 years ago
Log in to add feedback
Skip to note 3 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 jnlr — 4 weeks ago
To update examples and avoid spread of set_query_var() in recents projects.
Lot of them continue to use set_query_var() for passing args/vars to a template with get_template_part().
Since WordPress 5.5 (08/11/2020), think to use the $args third parameter to passed args to a template or a partial.
```
// No example here as this is not the appropriate page
But for example with get_template_part : https://developer.wordpress.org/reference/functions/get_template_part/#comment-4130
```
Doc about passing arguments to template files :
https://make.wordpress.org/core/2020/07/17/passing-arguments-to-template-files-in-wordpress-5-5/
Log in to add feedback

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