Filtrando vários campos personalizados com a API 2 do WP REST

14

Quero filtrar postagens com base em vários campos personalizados do ACF com relação AND. Algo assim:

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

Eu posso até ter mais filtros. Como posso convertê-los em filtros REST API 2?

Sohrab Taee
fonte
Dê uma olhada neste post e tentar criar a sua função wordpress.stackexchange.com/questions/169408/...
emilushi

Respostas:

3

Esta solução funciona com get_items()in /lib/endpoints/class-wp-rest-posts-controller.phpdo v2 WP Rest API.


Primeiro, você deseja construir os GETargumentos como faria para a new WP_Query(). A maneira mais fácil de fazer isso é com 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 );

Produzirá algo como:

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

O qual, se você quiser legível, também poderá usar as ferramentas do Chrome e decodeURIComponent('your-query-here')facilitar a leitura quando a inserir no URL da API JSON Rest :

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]==

Nota: Para usar seu tipo de postagem personalizado, você colocaria productantes?

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


Portanto, você tem sua consulta, mas precisamos instruir o WP sobre como lidar com algumas coisas:

  1. Incluindo Suporte REST para o Tipo de Postagem Customizado product
  2. Permitindo os argumentos da consulta meta_query
  3. Análise 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 );
jgraup
fonte
2

Aqui está um teste que eu fiz no Localhost:

Por razões de segurança, a meta consulta não é permitida no WP Api. Primeiro, você deve adicionar meta_query a rest_query permitido, adicionando esta função ao seu tema 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' );

depois disso, você precisará criar a consulta html usando esta função no outro site que obterá os dados do site 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);

Eu mudo a matriz de campos para que a aparência agora seja dos seus argumentos de consulta. A cadeia de consulta codificada terá a seguinte aparência:

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

Ao usar urldecode(), que neste caso será: urldecode('http://yourwordpreswebssite.com/wp-json/wp/v2/posts?' . $field_string);você terá um URL como este:

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

Se você pode nos fornecer o URL do seu site ativo, para que possamos testá-lo usando o carteiro diretamente em seu site, porque para testá-lo no host local ou em qualquer site WordPress existente será necessário criar um tipo de postagem personalizado do produto e adicionar campos meta, etc.

emilushi
fonte
Obrigado pela sua resposta, mas eu testei com a consulta como na pergunta do Postman e não funcionou.
MinhTri 26/05
@ Dan fiz algumas melhorias na solução, os valores do filtro são os mesmos dos argumentos da sua consulta, incluindo o tipo de postagem personalizado que não foi especificado na solução anterior.
Emilushi 26/05
Nós não temos producttaxonomia. Funciona muito bem! Não pensar embrulho meta_querydentro filter:)
MinhTri
@ Dan Estou feliz em ouvir isso. Eu escrevi um post sobre o assunto ontem, você pode compartilhá-lo :) API REST do WordPress com metadados .
Emilushi # 26/16
1
Em alguns servidores da AWS, usar [] como uma matriz matará a solicitação. Você deve apenas usar array () para ser seguro e para aqueles que podem copiar / colar. Além disso, isso suporta o produto CPT ou apenas a taxonomia? E, por último, você precisa higienizar a meta_query? Vendo que foi puxado, você corre um risco de segurança ao aceitar qualquer coisa que um usuário forneça?
jgraup
1

Você pode fazer isso sem a API Rest Rest assim (é o meu filtro de postagens)

    $ paged = (get_query_var ('paginado'))? get_query_var ('paginado'): 1;
$ args = matriz (
        'paginado' => $ paginado,
        'orderby' => 'date', // data de publicação e início da sessão (em caso de necessidade / alteração)
        'order' => 'DESC',
    );

    // informa que $ args ['meta_query'] permite que você altere o nome de uma nova classe de consulta.
    if (isset ($ _GET ['preço_min']) || isset ($ _GET ['preço_max']) || isset ($ _GET ['tipo']))
        $ args ['meta_query'] = array ('relação' => 'AND'); // E criar uma meta_query para criar uma meta_query


    if ($ type) {
        $ args ['meta_query'] [] = matriz (
            'chave' => 'tipo',
            'value' => $ type,
        );
    };

    if ($ plan) {
        $ args ['meta_query'] [] = matriz (
            'chave' => 'plano',
            'value' => $ plan,
        );
    };

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

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

    if ($ price_min || $ price_max) {
        $ args ['meta_query'] [] = matriz (
            'key' => 'preço',
            'value' => array ($ price_min, $ price_max),
            'type' => 'numérico',
            'compare' => 'ENTRE'
        );
    };  

    if ($ area_min || $ area_max) {
        $ args ['meta_query'] [] = matriz (
            'chave' => 'área',
            'value' => array ($ area_min, $ area_max),
            'type' => 'numérico',
            'compare' => 'ENTRE'
        );
    };
Igor Fedorov
fonte
1
Obrigado pela sua resposta, mas estou realmente curioso em fazê-lo com a API REST v2.
MinhTri 25/05
Bem, acho que minha variante é boa, mas se você quiser ... O fato de meu método não se limitar aos parâmetros!
Igor Fedorov 25/05
1

No Wordpress 4.7, o filterargumento foi removido.

Você pode reativá-lo instalando este plugin fornecido pela equipe do Wordpress. Somente depois disso você poderá usar uma das soluções propostas nas outras respostas.

Ainda não encontrei uma solução para fazer o mesmo sem instalar o plugin.

Michele Fortunato
fonte