Фильтрация нескольких пользовательских полей с помощью WP REST API 2


14

Я хочу фильтровать сообщения на основе нескольких пользовательских полей ACF с отношением AND. Что-то вроде этого:

$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?


Взгляните на этот пост и попробуйте создать свою функцию wordpress.stackexchange.com/questions/169408/…
emilushi

Ответы:


3

Это решение работает с get_items()в /lib/endpoints/class-wp-rest-posts-controller.phpиз v2 WP Rest API.


Во-первых, вы захотите построить GETаргументы, как для a 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')сделать его более удобным для чтения, когда вы добавляете его в URL-адрес JSON Rest API :

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, во-первых, вам нужно добавить meta_query в разрешенный rest_query, добавив эту функцию в вашу тему WordPress. 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' );

после этого вам нужно будет создать HTML-запрос с помощью этой функции на другом веб-сайте, который будет получать данные с веб-сайта WordPress.

$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);

Я изменяю массив полей, теперь он выглядит как аргументы вашего запроса. Закодированная строка запроса будет выглядеть так:

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

Если вы можете предоставить нам URL своего живого веб-сайта, чтобы мы могли протестировать его с помощью почтальона непосредственно на вашем веб-сайте, потому что для его тестирования на локальном хосте или на любом существующем сайте WordPress потребуется создать пользовательский тип поста, добавить мета-поля и т. Д.


Спасибо за ваш ответ, но я проверил с запросом, как в вопросе о Почтальоне, и он не работал.
MinhTri

@ Я внес некоторые улучшения в решение, значения фильтра совпадают с аргументами вашего запроса, включая пользовательский тип записи, который не был указан в предыдущем решении.
Эмилуши

У нас нет 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 ('ratio' => 'AND'); // И значит все условия meta_query должны отображаться


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

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

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

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

    if ($ price_min || $ price_max) {
        $ args ['meta_query'] [] = array (
            'key' => 'price',
            'value' => массив ($ price_min, $ price_max),
            'type' => 'numeric',
            'сравнить' => 'МЕЖДУ'
        );
    };  

    if ($ area_min || $ area_max) {
        $ args ['meta_query'] [] = array (
            'key' => 'area',
            'value' => массив ($ area_min, $ area_max),
            'type' => 'numeric',
            'сравнить' => 'МЕЖДУ'
        );
    };

1
Спасибо за ваш ответ, но мне действительно интересно делать это с REST API v2.
MinhTri

Ну, я думаю, мой вариант хорош, но если хотите ... Дело в том, что мой метод не ограничен параметрами!
Игорь Федоров

1

В Wordpress 4.7 filterаргумент был удален.

Вы можете активировать его, установив этот плагин, предоставленный командой Wordpress. Только после этого вы можете использовать одно из решений, предложенных в других ответах.

Я пока не нашел решения сделать то же самое без установки плагина.

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.