Tovább a tartalomhoz

REST API-útvonalak

A bővítmény két egyéni REST API-útvonala fejlesztőknek: lekérés és keresés.

A bővítmény két egyéni REST API-útvonalat kínál fejlesztőknek, a szűrők és a tartalom frontenden való kezeléséhez. Az útvonalakkal lekérheted a szűrők beállításait és lehetőségeit, vagy rákereshetsz egy szűrő lehetőségeire.

Az REST API-útvonalak alapból le vannak tiltva, mert a jogosultság-visszahívás false értéket ad. Az engedélyezéshez, illetve egyedi jogosultságok megadásához használd ezt a PHP-szűrőt:

add_filter(
'wp_grid_builder/rest_api/permission',
function( $allowed, $request ) {
return true;
},
10,
2
);

A jogosultság az alkalmazás környezetétől függ.

A lekérési útvonal a lekérdezési argumentumok és a szűrőparaméterek alapján adja vissza a szűrők adatait. Ez egy POST útvonal, a törzse egy JSON szöveg. A következő argumentumokat kell a kérés törzsében szövegként átadnod:

Argumentum Típus Leírás
lang szöveg A lekérdezett nyelv (nem kötelező)
facets objektum A lekérendő szűrők
source_type szöveg A lekérdezendő objektumtípus (post_type, term, user)
query_args objektum A lekérdezési argumentumok

JavaScriptből például így kérheted le az útvonal tartalmát:

fetch(
'//example.com/wp-json/wpgb/v1/fetch',
{
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify(
{
facets: {
facet_slug_1: [ 'value_1', 'value_2' ],
facet_slug_2: [ 'value_1' ],
facet_slug_3: [],
facet_slug_4: [],
},
source_type: 'post_type',
query_args: {
post_type: 'post',
posts_per_page: 10,
},
}
),
}
)
.then( response => response.json() )
.then( response => console.log( response ) );

A kérés ilyen választ ad:

{
facets: {
1: {
name: 'Categories',
slug: 'facet_slug_1',
type: 'checkbox',
selected: [ 'value_1', 'value_2' ],
choices: [
{
name: 'Value 1',
value: 'value_1',
parent_id: 0,
term_id: 1,
count: 10,
},
{
name: 'Value 2',
value: 'value_2',
parent_id: 0,
term_id: 2,
count: 8,
},
{…},
],
settings: {
hierarchical: 0,
show_less_label: '- Show less',
show_more_label: '+ Show more',
},
},
2: {…},
3: {…},
4: {…},
},
results: [
{…},
{…},
],
total: 3000
}

A válasz három részből áll: a facets a szűrők adatait és lehetőségeit, a results a találatokat, a total az összes találat számát tartalmazza.

A keresési útvonal hasonló a lekérési útvonalhoz, de egy szűrő azonosítója alapján a szűrő lehetőségei között keres. Jól használható például automatikus kiegészítő listához vagy aszinkron kombinált mezőhöz. A következő argumentumokat kell a kérés törzsében szövegként átadnod:

Argumentum Típus Leírás
lang szöveg A lekérdezett nyelv (nem kötelező)
facets objektum A tartalom szűréséhez használt szűrők
source_type szöveg A lekérdezendő objektumtípus (post_type, term, user)
query_args objektum A lekérdezési argumentumok
search objektum A szűrő azonosítója, amelyben keres, és a keresett szöveg

A szűrő lehetőségeire JavaScriptből például így kereshetsz:

fetch(
'//example.com/wp-json/wpgb/v1/search', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify(
{
facets: {
facet_slug_1: [ 'value_1', 'value_2' ],
facet_slug_2: [ 'value_1' ],
},
source_type: 'post_type',
query_args: {
post_type: 'post',
posts_per_page: 10,
},
search: {
facet: 'facet_slug_3',
string: 'shirt',
},
}
),
} )
.then( response => response.json() )
.then( response => console.log( response ) );

A kérés a keresett szűrő lehetőségeinek tömbjét adja vissza:

[
{
name: 'Overshirt',
value: 'overshirt',
parent_id: 0,
term_id: 3,
count: 34,
},
{
name: 'Flannel Shirt',
value: 'flannel-shirt',
parent_id: 0,
term_id: 8,
count: 12,
},
{…},
]

Az REST API-útvonalakhoz PHP-műveletek és -szűrők tartoznak, amelyekkel a kéréseket és a válaszok formátumát módosíthatod:

  • wp_grid_builder/rest_api/permission
  • wp_grid_builder/rest_api/callback
  • wp_grid_builder/rest_api/results
  • wp_grid_builder/rest_api/response

Készült:

Tiszteletben tartjuk a magánszférádat

Sütiket használunk a böngészési élmény javítására és a forgalom elemzésére. Az analitika csak akkor indul, ha engeded. Adatvédelmi irányelvek, Sütitájékoztató.

Sütibeállítások