WP REST API 2を使用して複数のカスタムフィールドをフィルタリングする


14

AND関係のある複数のacfカスタムフィールドに基づいて投稿をフィルタリングしたい。このようなもの:

$args = array(
        'post_type'  => 'product',
        'meta_query' => array(
            'relation' => 'AND',
            array(
                'key'     => 'color',
                'value'   => 'blue',
                'compare' => '=',
            ),
            array(
                'key'     => 'price',
                'value'   => array( 20, 100 ),
                'type'    => 'numeric',
                'compare' => 'BETWEEN',
            ),
        ),
    );

さらにフィルターがあるかもしれません。これらをREST API 2フィルターに変換するにはどうすればよいですか?


回答:


3

このソリューションは、と連携get_items()して/lib/endpoints/class-wp-rest-posts-controller.phpv2 WP Rest API


最初に、の場合とGET同様に引数を作成しますnew WP_Query()。これを行う最も簡単な方法はhttp_build_query()です。

$args = array (
    'filter' => array (
        'meta_query' => array (
            'relation' => 'AND',
            array (
                'key'     => 'color',
                'value'   => 'blue',
                'compare' => '=',
            ),
            array (
                'key'     => 'test',
                'value'   => 'testing',
                'compare' => '=',
            ),
        ),
    ),
);
$field_string = http_build_query( $args );

次のようなものが生成されます。

filter%5Bmeta_query%5D%5Brelation%5D=AND&filter%5Bmeta_query%5D%5B0%5D%5Bkey%5D=color&filter%5Bmeta_query%5D%5B0%5D%5Bvalue%5D=blue&filter%5Bmeta_query%5D%5B0%5D%5Bcompare%5D=%3D&filter%5Bmeta_query%5D%5B1%5D%5Bkey%5D=test&filter%5Bmeta_query%5D%5B1%5D%5Bvalue%5D=testing&filter%5Bmeta_query%5D%5B1%5D%5Bcompare%5D=%3D

読みやすくしたい場合は、Chromeツールを使用decodeURIComponent('your-query-here')して、JSON Rest API URLに挿入するときに読みやすくすることもできます

https://demo.wp-api.org/wp-json/wp/v2/product?filter[meta_query][relation]=AND&filter[meta_query][0][key]=color&filter[meta_query][0][value]=blue&filter[meta_query][0][compare]==&filter[meta_query][1][key]=test&filter[meta_query][1][value]=testing&filter[meta_query][1][compare]==

注:カスタム投稿タイプを使用するには、product前に配置します?

/wp-json/wp/v2/<custom-post-type>?filter[meta_query]


クエリはありますが、WPにいくつかの処理方法を指示する必要があります。

  1. カスタム投稿タイプのRESTサポートの追加 product
  2. クエリ引数の許可 meta_query
  3. 構文解析 meta_query

// 1) Add CPT Support <product>


function wpse_20160526_add_product_rest_support() {
    global $wp_post_types;

    //be sure to set this to the name of your post type!
    $post_type_name = 'product';
    if( isset( $wp_post_types[ $post_type_name ] ) ) {
        $wp_post_types[$post_type_name]->show_in_rest = true;
        $wp_post_types[$post_type_name]->rest_base = $post_type_name;
        $wp_post_types[$post_type_name]->rest_controller_class = 'WP_REST_Posts_Controller';
    }
}

add_action( 'init', 'wpse_20160526_add_product_rest_support', 25 );


// 2) Add `meta_query` support in the GET request

function wpse_20160526_rest_query_vars( $valid_vars ) {
    $valid_vars = array_merge( $valid_vars, array(  'meta_query'  ) ); // Omit meta_key, meta_value if you don't need them
    return $valid_vars;
}

add_filter( 'rest_query_vars', 'wpse_20160526_rest_query_vars', PHP_INT_MAX, 1 );


// 3) Parse Custom Args

function wpse_20160526_rest_product_query( $args, $request ) {

    if ( isset( $args[ 'meta_query' ] ) ) {

        $relation = 'AND';
        if( isset($args['meta_query']['relation']) && in_array($args['meta_query']['relation'], array('AND', 'OR'))) {
            $relation = sanitize_text_field( $args['meta_query']['relation'] );
        }
        $meta_query = array(
            'relation' => $relation
        );

        foreach ( $args['meta_query'] as $inx => $query_req ) {
        /*
            Array (

                [key] => test
                [value] => testing
                [compare] => =
            )
        */
            $query = array();

            if( is_numeric($inx)) {

                if( isset($query_req['key'])) {
                    $query['key'] = sanitize_text_field($query_req['key']);
                }
                if( isset($query_req['value'])) {
                    $query['value'] = sanitize_text_field($query_req['value']);
                }
                if( isset($query_req['type'])) {
                    $query['type'] = sanitize_text_field($query_req['type']);
                }
                if( isset($query_req['compare']) && in_array($query_req['compare'], array('=', '!=', '>','>=','<','<=','LIKE','NOT LIKE','IN','NOT IN','BETWEEN','NOT BETWEEN', 'NOT EXISTS')) ) {
                    $query['compare'] = sanitize_text_field($query_req['compare']);
                }
            }

            if( ! empty($query) ) $meta_query[] = $query;
        }

        // replace with sanitized query args
        $args['meta_query'] = $meta_query;
    }

    return $args;
}
add_action( 'rest_product_query', 'wpse_20160526_rest_product_query', 10, 2 );

2

Localhostで行ったテストは次のとおりです。

セキュリティ上の理由から、WP Apiではメタクエリは許可されていません。まず、wordpressテーマにこの関数を追加して、許可されたrest_queryにmeta_queryを追加する必要があります functions.php

function api_allow_meta_query( $valid_vars ) {

  $valid_vars = array_merge( $valid_vars, array( 'meta_query') );
  return $valid_vars;
}
add_filter( 'rest_query_vars', 'api_allow_meta_query' );

その後、WordPress Webサイトからデータを取得する他のWebサイトでこの関数を使用して、HTMLクエリを作成する必要があります。

$curl = curl_init();
$fields = array (
  'filter[meta_query]' => array (
    'relation' => 'AND',
      array (
        'key' => 'color',
        'value' => 'blue',
        'compare' => '='
      ),
      array (
        'key' => 'price',
        'value' => array ( 20, 100 ),
        'type' => 'numeric',
        'compare' => 'BETWEEN'
      ),
    ),
  );

$field_string = http_build_query($fields);

curl_setopt_array($curl, array (
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => 'http://yourwordpreswebssite.com/wp-json/wp/v2/posts?' . $field_string
  )
);

$result = curl_exec($curl);

echo htmlentities($result);

クエリ引数のように見えるように、fields配列を変更します。エンコードされたクエリ文字列は次のようになります。

http://yourwordpreswebssite.com/wp-json/wp/v2/posts?filter%5Btaxonomy%5D=product&filter%5Bmeta_query%5D%5Brelation%5D=AND&filter%5Bmeta_query%5D%5B0%5D%5Bkey%5D=color&filter%5Bmeta_query%5D%5B0%5D%5Bvalue%5D=blue&filter%5Bmeta_query%5D%5B0%5D%5Bcompare%5D=%3D&filter%5Bmeta_query%5D%5B1%5D%5Bkey%5D=price&filter%5Bmeta_query%5D%5B1%5D%5Bvalue%5D%5B0%5D=20&filter%5Bmeta_query%5D%5B1%5D%5Bvalue%5D%5B1%5D=100&filter%5Bmeta_query%5D%5B1%5D%5Btype%5D=numeric&filter%5Bmeta_query%5D%5B1%5D%5Bcompare%5D=BETWEEN

を使用urldecode()すると、この場合は次のようになります。urldecode('http://yourwordpreswebssite.com/wp-json/wp/v2/posts?' . $field_string);次のようなURLになります。

http://yourwordpreswebssite.com/wp-json/wp/v2/posts?filter[taxonomy]=product&filter[meta_query][relation]=AND&filter[meta_query][0][key]=color&filter[meta_query][0][value]=blue&filter[meta_query][0][compare]==&filter[meta_query][1][key]=price&filter[meta_query][1][value][0]=20&filter[meta_query][1][value][1]=100&filter[meta_query][1][type]=numeric&filter[meta_query][1][compare]=BETWEEN

ライブWebサイトのURLを提供して、ウェブサイトで直接postmanを使用してテストできる場合、localhostまたは既存のWordPressサイトでテストするには、製品のカスタム投稿タイプを作成し、メタフィールドなどを追加する必要があります。


回答いただきありがとうございますが、Postmanの質問のようにクエリでテストしましたが、うまくいきませんでした。
-MinhTri

@Dan iはソリューションにいくつかの改良を加えました。フィルター値はクエリ引数と同じで、以前のソリューションでは指定されていなかったカスタム投稿タイプを含みます。
エミルシ

product分類法はありません。うまくいきます!meta_query内部の折り返しについて考えていませんでしたfilter:)
MinhTri

@ダン私はそれを聞いてうれしいです。私は昨日、それについての投稿を書きました、あなたはそれを共有することを検討するかもしれません:) WordPress REST APIとメタフィールド
エミルシ

1
[]を配列として使用する一部のAWSサーバーでは、リクエストが強制終了されます。array()を使用するだけで、安全になり、コピー/貼り付けが可能になります。また、これはCPT製品をサポートしていますか、それとも分類のみですか?最後に、meta_queryをサニタイズする必要がありますか?それが引っ張られたことを見て、ユーザーが提供するものを受け入れることによってセキュリティリスクを実行しますか?
jgraup

1

このようにREST APIなしでそれを行うことができます(私の投稿フィルターです)

    $ paged =(get_query_var( 'paged'))?get_query_var( 'paged'):1;
$ args = array(
        'paged' => $ paged、
        'orderby' => 'date'、//сортировкаподатеунасбудетвлюбомслучае(новыможетеизменить/доработатьэто)
        'order' => 'DESC'、
    );

    // $ args ['meta_query']создаёммассивеслиуказанахотябыоднаценаилиотмеченчекбокс
    if(isset($ _GET ['price_min'])|| isset($ _GET ['price_max'])|| isset($ _GET ['type']))
        $ args ['meta_query'] = array( 'relation' => 'AND'); //そして、meta_queryдолжнывыполнятьсяを使用してmeta_queryを実行します


    if($ type){
        $ args ['meta_query'] [] = array(
            「キー」=>「タイプ」、
            'value' => $ type、
        );
    };

    if($ plan){
        $ args ['meta_query'] [] = array(
            「キー」=>「計画」、
            'value' => $ plan、
        );
    };

    if($ room_num){
        $ args ['meta_query'] [] = array(
            'key' => 'room_num'、
            '値' => $ room_num、
        );
    };

    if($ etage){
        $ args ['meta_query'] [] = array(
            'key' => 'etage'、
            'value' => $ etage、
        );
    };  

    if($ price_min || $ price_max){
        $ args ['meta_query'] [] = array(
            「キー」=>「価格」、
            'value' => array($ price_min、$ price_max)、
            「タイプ」=>「数値」、
            '比較' => 'BETWEEN'
        );
    };  

    if($ area_min || $ area_max){
        $ args ['meta_query'] [] = array(
            「キー」=>「エリア」、
            'value' => array($ area_min、$ area_max)、
            「タイプ」=>「数値」、
            '比較' => 'BETWEEN'
        );
    };

1
ご回答ありがとうございます。しかし、REST API v2でそれを行うことに本当に興味があります。
-MinhTri

まあ、私のバリアントは良いと思いますが、あなたが望むなら...私の方法はパラメータに限定されないという事実!
イゴールフェドロフ

1

Wordpress 4.7では、filter引数が削除されました。

Wordpressチームが提供するこのプラグインをインストールすると再アクティブ化できます。その後のみ、他の回答で提案されたソリューションのいずれかを使用できます。

プラグインをインストールせずに同じことを行うソリューションはまだ見つかりませんでした。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.