WP_Query parameters for custom fields

If you have been following this series, you will understand the structure of WP_Query and how to use it to write custom queries. In order to be able to define what WP_Query gets from the database, you need to know what parameters you can use to query the data.

WP_Query There are a large number of possible parameters, which makes it very flexible. Since you can use it to query any content held in the wp_posts table, it has parameters for every permutation of the query you might want to run on the content.

In this tutorial, I will learn about the parameters of custom fields. But first, a quick refresher on how to write parameters in WP_Query .

Review how parameters in WP_Query work Before we begin, let's quickly review how parameters work in WP_Query . When you write a WP_Query in your theme or plugin, you need to include four main elements:

Query parameters, use the parameters that will be introduced in this tutorial The query itself cycle End: Close if and while tags and reset post data In practice, this will look something like the following:

<?php

$args = array( // Arguments for your query. );

// Custom query. $query = new WP_Query( $args );

// Check that we have query results. if ( $query->have_posts() ) {

// Start looping over the query results. while ( $query->have_posts() ) {

$query->the_post();

// Contents of the queried post results go here.

}

// Restore original post data. wp_reset_postdata();

?> These parameters tell WordPress what data to get from the database, which I will cover here. So what we're focusing on here is the first part of the code:

$args = array( // Arguments for your query. ); As you can see, the parameters are contained in an array. As you follow this tutorial, you'll learn how to code them.

Write your parameters The parameters in the array have a specific encoding method, as follows:

$args = array( 'parameter1' => 'value', 'parameter2' => 'value', 'parameter3' => 'value' ); You must enclose the parameters and their values in single quotes, use => between them, and separate them with commas. If you make this mistake, WordPress may not add all parameters to the query, otherwise you may see a white screen.

Custom field parameters Custom fields, also known as post metadata, can use a separate class named WP_Meta_Query . This means that if you just want to run a query on post metadata, you can use WP_Meta_Query or WP_Query (visit WP_Meta_Query ), whereas if you want to query on posts Metadata and other items (such as post type), use WP_Query .

The WP_Meta_Query class has been covered in detail elsewhere in this series, so I won't go into detail about it here, but the main difference between using this class versus WP_Query is WP_Query Allows you to create some simple parameters without using nested arrays.

Simple custom field query parameters Use WP_Query The main parameters for querying custom fields are as follows:

meta_key ( string ): Custom field key. meta_value ( String ): Custom field value. meta_value_num ( number ): Custom field value. meta_compare ( string ): Operator used to test 'meta_value' . Possible values are '=' , '!=' , ''>' , '>= ' , ', ', 'like' , 'dislike' , 'in' , 'Not between' , '' , 'Not between' , 'Does not exist' , 'REGEXP' , 'REGEXP' or 'RLIKE ' does not exist. The default value is '=' . Use these parameters for simple custom field queries. So for example to output posts with a custom field with key key1 (regardless of its value) you would use the following parameters:

$args = array( 'meta_key' => 'key1' ); This will return all posts with a custom field with the key key1 , no matter what the value is.

If you want to specify a value, you can add an extra parameter to this:

$args = array( 'meta_key' => 'key1', 'meta_value' => 'value1' ); This will return all posts with a custom field containing the key1 key and the value1 value.

Alternatively, you can use a custom field with a value of value1 to get all posts, regardless of the key. This can be useful when you have multiple custom field keys with duplicate values:

$args = array( 'meta_value' => 'value1' ); 正如您所看到的，您可以只查询自定义字段的键或值，而不必总是指定两者。

使用meta_compare参数 您可能已经注意到上面的 meta_compare 参数有很多潜在参数，并且它们的使用可能并不总是立即显而易见。让我们看一下您可能最常使用的那些：

= ：等于。这是默认设置，因此如果您不包含 meta_compare 参数，则 WP_Query 将使用此参数。 !+ : 不等于。 > : 大于。 >= : 大于或等于。 : 小于。 : 小于或等于。 LIKE ：这将忽略您使用的值的大小写，您还可以将其与通配符一起使用来查找与您要查找的值类似的值。 NOT LIKE ：工作方式与 LIKE 类似，但查询相反！ IN ：将其与“value”参数中的数组一起使用，以查找具有数组中一个或多个值的帖子。 BETWEEN ：与两个数值的数组（在 meta_value 参数中指定）一起使用，以查找自定义字段值在这些值之间（但不等于它们）的帖子。 NOT BETWEEN ：查询带有由 meta_value 参数指定的两个数值数组之外的自定义字段值的帖子。 让我们看一下该参数的一些示例用法。

首先，您可以使用 meta_compare 参数排除自定义字段键或值。因此，要获取除带有 key1 键的自定义字段之外的所有帖子，您可以使用以下命令：

$args = array( 'meta_key' => 'key1', 'meta_compare' => '!=' ); 您还可以使用 'NOT IN' 值作为 meta_compare 参数，该参数也可以与多个值的字符串一起使用：

$args = array( 'meta_key' => 'key1, key2', 'meta_compare' => 'NOT IN' ); 这将查询没有带有 key1 或 key2 值的自定义字段的帖子。如果您想要更具体，也许查询具有一个自定义字段而不是另一个自定义字段的帖子，您可以使用嵌套数组，我们很快就会介绍这一点。

上面的示例使用非数字值。您可以将 WP_Query 与具有数值的自定义字段一起使用，不仅可以获取具有该值的自定义字段的帖子，还可以获取具有更高或更低值的自定义字段的帖子。例如，如果您要查找高于或低于给定价格的商品，您可以在商店中使用此功能。

要查找自定义字段值高于给定数字的帖子，请使用如下内容：

$args = array( 'meta_key' => 'numkey', 'meta_value' => '100', 'meta_compare' => '>' ); 这将返回带有 numkey 键且值超过 100 的自定义字段的所有帖子。如果您想查询 100 或以上的值，您可以使用 'meta_compare' => '>=' 。

您还可以查找自定义字段的值介于您使用 BETWEEN 参数和数组指定的两个数字之间的帖子：

$args = array( 'meta_key' => 'numkey', 'meta_value' => array ( '100', '200' ), 'meta_compare' => 'BETWEEN' ); 这将找到 numkey 自定义字段中的值在 100 到 200 之间的所有帖子。

嵌套自定义字段查询 如果要查询多个自定义字段或使用多个运算符，可以使用嵌套数组。

它们采用以下结构：

$args = array( 'meta_query' => array( 'relation' => '', // Optional argument. array( // `meta_query` arguments go here. ) ) ); 在 WP_Query 中构建 'meta_query' 参数的方式与使用 WP_Meta_Query 类的方式完全相同，这将在本系列的后续教程中介绍，因此我不会在这里重复。

自 WordPress 4.1 版起，您还可以使用多层嵌套数组来创建更加复杂和精确的查询。这些看起来像这样：

$args = array( 'meta_query' => array( 'relation' => '', // Optional argument. array( 'relation' => '', array ( // First set of `meta_query` arguments go here. ), array ( // Second set of `meta_query` arguments go here. ) ) ) ); 这使您可以在查询中的不同级别使用不同的关系，例如查询在一个自定义字段键中包含某个值的帖子，或在另一个自定义字段键中查询两个值同时存在的帖子。 WP_Meta_Query 类教程（本系列的一部分）对此进行了更详细的介绍，并附有示例。

摘要 使用 WP_Query 类来查询帖子的元数据（或自定义字段）为您提供了很大的灵活性，多个潜在参数与多个运算符相结合，可以帮助您准确地查询数据库按照您想要的方式进行。

如果您只想在查询中使用帖子元数据参数（而不是将其与其他参数结合使用，例如对于帖子类型），您还可以使用 WP_Meta_Query 类，稍后将介绍该类在这个系列中。

WP_Query parameters for custom fields

Related articles