Фільтрування декількох спеціальних полів за допомогою 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-адресу API 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-адресу веб-сайту, щоб ми могли протестувати його за допомогою листоноші безпосередньо на вашому веб-сайті, оскільки для тестування його на localhost або будь-якому наявному веб-сайті WordPress знадобиться створення продуктового типу публікації та додавання метаполя тощо тощо. Привіт!


Дякую за Вашу відповідь, але я перевірив запит, як у запитанні поштара, і він не працював.
MinhTri

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

У нас немає productтаксономії. Це чудово працює! Не думати про обгорткового meta_queryвсередині filter:)
MinhTri

@Dan Я рада це почути. Я написав пост про це вчора, ви можете подумати над нею :) WordPress REST API з метаполями .
emilushi

1
Кілька речей, на деяких серверах AWS, використання [] як масиву вбиває запит. Ви повинні просто використовувати масив (), щоб бути безпечним і для тих, хто може скопіювати / вставити. Також, чи підтримує це продукт CPT або лише таксономію? І нарешті, чи потрібно санітувати мета-запит? Бачачи, що це було витягнуто, ви ризикуєте безпекою, приймаючи що-небудь, що постачає користувач?
jgraup

1

Ви можете це зробити без інтерфейсу відпочинку (наприклад, це фільтр моїх публікацій)

    $ paged = (get_query_var ('paged'))? get_query_var ('paged'): 1;
$ args = масив (
        'paged' => $ paged,
        'orderby' => 'дата', // сортування за даними у нас буде в любому випадку (але ви можете змінити / допрацювати це)
        'замовити' => 'DESC',
    );

    // створив массив $ args ['meta_query'] якщо вказана хотя за однією ціною або відменена чекбокс
    if (isset ($ _GET ['price_min']) || isset ($ _GET ['price_max']) || isset ($ _GET ['type']))
        $ args ['meta_query'] = array ('співвідношення' => 'І'); // І означає всі умови meta_query обов'язково виконуються


    if ($ тип) {
        $ args ['meta_query'] [] = масив (
            'ключ' => 'тип',
            'value' => $ type,
        );
    };

    if ($ план) {
        $ args ['meta_query'] [] = масив (
            'ключ' => 'план',
            'value' => $ план,
        );
    };

    якщо ($ room_num) {
        $ args ['meta_query'] [] = масив (
            'key' => 'room_num',
            'value' => $ room_num,
        );
    };

    if ($ etage) {
        $ args ['meta_query'] [] = масив (
            'key' => 'etage',
            'value' => $ etage,
        );
    };  

    if ($ price_min || $ price_max) {
        $ args ['meta_query'] [] = масив (
            'ключ' => "ціна",
            'value' => масив ($ price_min, $ price_max),
            'type' => 'числовий',
            'зіставити' => 'МІЖ
        );
    };  

    якщо ($ area_min || $ area_max) {
        $ args ['meta_query'] [] = масив (
            'ключ' => 'область',
            'value' => масив ($ area_min, $ area_max),
            'type' => 'числовий',
            'зіставити' => 'МІЖ
        );
    };

1
Дякую за вашу відповідь, але мені дуже цікаво робити це за допомогою REST API v2.
MinhTri

Ну, я думаю, мій варіант хороший, але якщо ви хочете ... Справа в тому, що мій метод не обмежений параметрами!
Ігор Федоров

1

У Wordpress 4.7 filterаргумент видалено.

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

Я ще не знайшов рішення зробити те ж саме, не встановлюючи плагін.

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.