Ultimate Guide to meta_query of WordPress WP

Query posts by a meta value
Get posts by multiple meta values
How to use "compare" parameter
"compare => between" for Dates
Multiple meta queries – get posts by multiple pairs of keys and values
Sort posts by meta values
Order by multiple meta keys and values

In this post I assume that you already have basic knowledge how to work with WP_Query class in WordPress. Before I begin, I want to show you some very simple examples. The similar examples you can find in WordPress Codex.

As you know all the posts have the metadata you can populate in "Custom fields" metabox (the metabox by the way can be hidden). So, for example, if you want to get a post with meta key show_on_homepage and meta value on, you can do it the following way:

$rd_args = array(
	'meta_key' => 'show_on_homepage',
	'meta_value' => 'on'
);
 
$rd_query = new WP_Query( $rd_args );

Otherwise, if you need to query all posts except the ones with this pair of meta key and value, you can use the following parameters:

$rd_args = array(
	'meta_key' => 'show_on_homepage',
	'meta_value' => 'on',
	'meta_compare' => '!='
);
 
$rd_query = new WP_Query( $rd_args );

Do not forget that all examples in this post are simplified, so, some of WP_Query parameters are missing, e.g posts_per_page or post_type.

If you are interested in other meta_compare parameter values, please look at "compare" parameter description below, because both of them accept the same values.

This was very very simple examples, just an introdution. But this post is about meta_query parameter. This parameter allows us to create a really cool post filters and search scripts.

Query Posts by a Meta Value

The simple example below allows you to get all the posts with a specific custom field value. Let’s just get all the posts with custom field name "color" and custom field value white.

// the meta_key 'color' with the meta_value 'white'
$rd_args = array(
	'meta_query' => array(
		array(
			'key' => 'color',
			'value' => 'white'
		)
	)
);
 
$rd_query = new WP_Query( $rd_args );

If you look at the post edit page (in admin area) in any post which matches the query, you will see the following in the "Custom Fields" section:

Let’s do the opposite thing – get all the posts except the ones with meta key "color" and meta value white:

$rd_args = array(
	'meta_query' => array(
		array(
			'key' => 'color',
			'value' => 'white',
			'compare' => '!='
		)
	)
);
 
$rd_query = new WP_Query( $rd_args );

Get Posts by Multiple Meta Values

Now let’s get all the posts with white OR green "color" custom field value:

// custom field name is color and custom field value is 'white' OR 'green'
$rd_args = array(
	'meta_query' => array(
		array(
			'key' => 'color',
			'value' => array('white','green'),
			'compare' => 'IN'
		)
	)
);
 
$rd_query = new WP_Query( $rd_args );

Get all the posts (products in online shop for example) except white products and green products:

$rd_args = array(
	'meta_query' => array(
		array(
			'key' => 'color',
			'value' => array('white','green'),
			'compare' => 'NOT IN'
		)
	)
);
 
$rd_query = new WP_Query( $rd_args );

How to use "compare" in meta_query

As you can see in example below and in further examples too, there is a compare parameter in every of them. Now I would like to show which values it can accept and what do they mean.

= (or not set) Equal to,
!= – Not equal to,
< – Less than,
<= – Less or equal to,
> – Greater than,

>= – Greater than or equal to, example:

// the product price in this example is 2000 or more than 2000:
$args = array(
	'meta_query' => array(
		array(
			'key' => 'price',
			'value' => 2000,
			'type' => 'numeric', // specify it for numeric values
			'compare' => '>='
		)
	)
);

LIKE – Allows to search in meta values for a specific string, in the example below the query returns all the posts where "first_name" name contains John, it can be also Johnny, Johnathan, somethingJohnsomething:
```
$args = array(
	'meta_query' => array(
		array(
			'key' => 'first_name',
			'value' => 'John',
			'compare' => 'LIKE'
		)
	)
);
```
Two more things: first – it is not case sensitive, second – wildcard symbols @ are not necessary.
NOT LIKE – similar to LIKE just works in an opposite way – meta value mustn’t contain the given string.
IN – posts meta value must contain one of the values of the given array, you can see the example above
NOT IN – meta values must not contain ANY of the values in the given array.

BETWEEN – post meta value should be between the given range of values, example:

// the product price is more than 2000 and less than 4000
$args = array(
	'meta_query' => array(
		array(
			'key' => 'price',
			'value' => array( 2000, 4000 ),
			'type' => 'numeric',
			'compare' => 'BETWEEN'
		)
	)
);

It can also work for dates, check the example below too.

NOT BETWEEN – not in a given range.
EXISTS (WordPress >= 3.5) – If meta value of a specific meta key exists or empty / null.
```
$args = array(
	'meta_query' => array(
		array(
			'key' => 'misha_key',
			'compare' => 'EXISTS'
		)
	)
);
```
So, actually it checks if a meta key exists, you do not even have to pass any value with this parameter.
NOT EXISTS (WordPress >= 3.5) – if a given meta key doesn’t exist at all

REGEXP (WordPress >= 3.7) – it allows you to compare meta values with regular expression, example:

$args = array(
	'meta_query' => array(
		array(
			'key' => 'misha_key',
			'value' => '^[0-9]*$', // "misha_key" must be only numbers
			'compare' => 'REGEXP'
		)
	)
);

NOT REGEXP (WordPress >= 3.7) – Similar to REGEXP but meta values must not match your given regular expression
RLIKE (WordPress >= 3.7) – it is the synonym to REGEXP

How to Use "compare => between" for Dates in meta_query

You can also use meta_query to check if a custom field is between two dates.

The most important thing you have to keep in mind is that your date format should be like YYYY-MM-DD or YYYY/MM/DD or something like that (year goes first, then month, then day, then time if you need it too). Check how it is stored in database – if it is stored in another format, for example days go first, then filtering won’t work for you until you change dates presence in database.

array(
	'key' => 'sale_day',
	'value' => array( '2018-01-01', '2018-01-09' ),
	'compare' => 'BETWEEN'
)

If the date is stored in UNIX time, example: 1543391233, everything became super simple:

array(
	'key' => 'sale_day',
	'value' => array( strtotime('2018-01-01'), strtotime('2018-01-09') ),
	'type' => 'numeric',
	'compare' => 'BETWEEN'
)

Multiple meta queries – get posts by multiple pairs of keys and values

Now I will show you how to combine posts by several (two or more) custom field values. First of all let me introduce you relation parameter which can accept two vaues – OR or AND (default).

// the 'color' is 'white' AND the 'price' is more than 2000 and less than 4000
$rd_query = new WP_Query( array(
	'meta_query' => array(
		'relation' => 'AND', // both of below conditions must match
		array(
			'key' => 'show_on_homepage',
			'value' => 'on'
		),
		array(
			'relation' => 'OR', // only 'color' OR 'price' must match
			array(
				'key' => 'color',
				'value' => 'white'
			),
			array(
				'key' => 'price',
				'value' => array( 2000, 4000 ),
				'type' => 'numeric',
				'compare' => 'BETWEEN'
			)
		)
	)
) );

As you can see, in meta_query above we used multiple relation.

How to Sort Posts by Meta Values ("orderby" and "order" parameters)

I will show you different examples of how you can order your posts by meta values. First of all, look at this simple code sample, where we don’t even use meta query:

$args = array(
	'meta_key' => 'misha_key',
	'orderby' => 'meta_value'
);

Now, let’s say that misha_key contains only numeric values, we can change our code for that case just a little bit.

$args = array(
	'meta_key' => 'misha_key',
	'orderby' => 'meta_value_num'
);

But how to use it together with meta query? Simple, just change our code the following way:

$args = array(
	'meta_query' => array(
		'misha_clause' => array(
			'key' => 'misha_key',
			'compare' => 'EXIST'
		)
	),
	'orderby' => 'misha_clause'
);

How to Order by Two and More Meta Keys

Yes, it is also possible since WordPress 4.2

$args = array(
	'meta_query' => array(
		'relation' => 'AND',
		'price_clause' => array(
			'key' => 'price',
			'value' => array( 2000, 4000 ),
			'type' => 'numeric',
			'compare' => 'BETWEEN'
		),
		'misha_clause' => array(
			'key' => 'misha_key',
			'compare' => 'EXISTS'
		), 
	),
	'orderby' => array(
		'price_clause' => 'ASC',
		'misha_clause' => 'DESC'
	),
);

So, first of all we order posts by price_clause ascending and then we order posts by misha_clause descending.

More about queries

Comments — 39

← Next comments

Jay C

How would I come about showing all post if meta value doesn’t exist.

In my case I am querying post based on dropdown selection. And based on your example, the script is working just fine. It loads the post based on meta value. But what if in the dropdown selection I have a show all option. How can I come about doing that?

Thanks!

Misha

Do you need to get posts with exact meta key and with any meta value?

Jay C.

Here is the code I’m working with right now:

<form method="get">
       <label>Day: </label>
    <select name="day" size="1" onchange="this.form.submit()">
        <option value="all" <?php if($selected_day == "all"){ print "selected='selected'"; } ?> >All</option>
        <option value="monday" <?php if($selected_day == "monday"){ print "selected='selected'"; } ?> >Monday</option>
        <option value="tuesday" <?php if($selected_day == "tuesday"){ print "selected='selected'"; } ?> >Tuesday</option>
        <option value="wednesday" <?php if($selected_day == "wednesday"){ print "selected='selected'"; } ?> >Wednesday</option>
    </select>
</form>

$query_day = '';
switch( $_GET['day'] ) {
    case 'saturday': $query_day = 'saturday'; break;
    case 'friday': $query_day = 'friday'; break;
    case 'thursday': $query_day = 'thursday'; break;
    case 'wednesday': $query_day = 'wednesday'; break;
    case 'tuesday': $query_day = 'tuesday'; break;
    case 'monday': $query_day = 'monday'; break;
    default: case 'all': $query_day = HOW DO I GET ALL  break;
}

$page = (get_query_var('paged')) ? get_query_var('paged') : 1;
 
// Build the args
$args = array(
	'post_type'	=> 'connect-groups',
	'posts_per_page' => 100,
	'meta_query' => array(
        array(
            'key'     => 'connect_group_day',
			'field'		=> 'slug',
			'value'		=>  $query_day,
        )
    )
);
// Query the posts
$posts = query_posts( $args );

So here I get posts with specific meta selected from the dropdown menu, but if the user selects ALL i want to grab from all terms that exist.

I think you need something like this:

$args = array(
	'post_type'	=> 'connect-groups',
	'posts_per_page' => 100,
	'meta_query' => array(
		array(
			'key'     => 'connect_group_day',
			'compare' => 'EXISTS' // WP 3.5 +
		)
	)
);

Juankql

thanks Misha, I try your code, but instead ‘orderby’=>’meta_value’ I used ‘orderby’=>’meta_value_num’ and it’s working perfect!!!! Thanks a lot for the answer.
Regards
Juankql
Juankql

Hi, i found this examples very good, but i have a doubt, what if i want to order by a metabox value. For example, I have a custom post type named team_member and this post-type have a metabox named order, later in the loop, i need query the post but ordering by this order that i defined in the metabox, How i could do this?
Thanks in advance.
Please sorry my english….
- Misha
  Hi,
  WP_Query supports the orderby parameter, so it should look like this:
  $args = array( 'meta_key'=>'key_of_the_metabox_field', 'orderby'=>'meta_value', 'order'=> 'ASC' // or DESC );
riteshiz

Thanks a lot !!!
- Misha
  
  You are welcome!
Salvatore Capolupo

Fine and useful examples, happy new year!
Ryan
Hi man,

This seems like some nice clear examples of the WP_Query. I was working with the WP_Meta_Query and wondered how it was possible to just query for all values under a particular meta key. Say for example you have a custom field called member_city, and many posts use this to give location informations such as “This user is from London”.

What I’m actually trying to do is kind of hard to explain. I’m trying to get all custom meta data from the database, i.e all the cities, then output them into an array which can be used to generate a drop down menu that users can then select from to search users by location. I also don’t want this to duplicate cities, i.e if two people are from London, I don’t want London in the list twice. I’m using WordPress Advanced Search by Growth Spark for my search.

I’m able to query the database and get an output such as:
INNER JOIN rm_postmeta ON (rm_posts.ID = rm_postmeta.post_id) AND ( (rm_postmeta.meta_key = 'member_city' AND CAST(rm_postmeta.meta_value AS CHAR) IN ('London')) )
I just don’t know how to extract that information, then get it into my drop down. Does this make sense to you? May be confusing without code examples and understanding of the site architecture.

Kurt

I’m trying to figure out how I would wrap a short code function around your code sample so that the admin could put in their own values to filter the meta content displayed on a page

function product_listing_function($atts) {
 
	 extract(shortcode_atts( array(
		'color' => '',
		'price' => '',
		), $atts
	)
);
}
add_shortcode( 'product_list', 'product_listing_function' );

[product_list color=”white” price=”100″]

I can’t seem to get the values to pass into the meta_query array? Could you please share an example of this.

Thank You

I hope it helps.

function product_listing_function($atts) {
	extract(shortcode_atts( array(
		'color' => '',
		'price' => '',
		), $atts
	)
	);
	$rd_args = array(
		'meta_query' => array(
			'relation' => 'AND',
			array(
				'key' => 'color',
				'value' => $color
			),
			array(
				'key' => 'price',
				'value' => $price,
				'type' => 'numeric'
			)
		)
	);
	$rd_query = new WP_Query( $rd_args );
}
 
add_shortcode( 'product_list', 'product_listing_function' );

Comments are closed

Ultimate Guide to meta_query – Get and Order Posts by Meta Values