PHP-szűrők: a REST API válasza, találatai és jogosultsága
A bővítmény REST API-útvonalainak válaszát, találatait és engedélyezését módosító PHP-szűrők.
Ezek a szűrők a bővítmény REST API-útvonalaihoz tartoznak. A nevük a wp_grid_builder/rest_api/ előtaggal kezdődik.
| Szűrő | Mikor fut le | Argumentumok |
|---|---|---|
wp_grid_builder/rest_api/response |
A kérés válaszának visszaadása előtt. | $response, $request |
wp_grid_builder/rest_api/results |
A Fetch REST-útvonal bejegyzés-, kifejezés- vagy felhasználó-lekérdezése után. | $posts, $query, $params |
wp_grid_builder/rest_api/permission |
Az útvonalak jogosultság-ellenőrzésekor, a távoli hitelesítés után. | $proceed, $request |
A válasz formázása
Szekció neve “A válasz formázása”A rest_api/response a válasz visszaadása előtt fut le. A válasz formázására és módosítására használd.
| Argumentum | Típus | Leírás |
|---|---|---|
$response |
tömb | A válasz adatai. |
$request |
WP_REST_Request |
A kérés objektuma. |
function prefix_rest_api_response( $response, $request ) {
$response['my_data'] = 'néhány adat';
return $response;
}add_filter( 'wp_grid_builder/rest_api/response', 'prefix_rest_api_response', 10, 2 );A találatok formázása
Szekció neve “A találatok formázása”A rest_api/results a Fetch útvonal lekérdezése után fut le, és a lekérdezés eredményét formázhatod vele.
| Argumentum | Típus | Leírás |
|---|---|---|
$posts |
tömb | A WP_Query bejegyzései. |
$query |
WP_Query |
A lekérdezés példánya. |
$params |
tömb | A kért paraméterek. |
Példa: a találatok a WordPress saját REST-formátumában kerülnek vissza.
function prefix_rest_api_results( $posts, $query, $params ) {
$request = new WP_REST_Request(); $controller = new WP_REST_Posts_Controller( 'post' );
return array_map( function( $post ) use ( $controller, $request ) {
$data = $controller->prepare_item_for_response( $post, $request ); $post = $controller->prepare_response_for_collection( $data );
return $post;
}, $posts );}add_filter( 'wp_grid_builder/rest_api/results', 'prefix_rest_api_results', 10, 3 );Jogosultság
Szekció neve “Jogosultság”A rest_api/permission a bővítmény REST-útvonalainak jogosultság-ellenőrzésében fut le, miután a távoli hitelesítés beállította az aktuális felhasználót. Ezzel engedélyezheted vagy tilthatod az útvonalakat, és ellenőrizheted például a felhasználó jogosultságát.
Alapértelmezés szerint a bővítmény REST-útvonalai le vannak tiltva, ezért használathoz ezzel a szűrővel engedélyezned kell őket.
| Argumentum | Típus | Leírás |
|---|---|---|
$proceed |
logikai | Folytatódhat-e a kérés. |
$request |
WP_REST_Request |
A kérés objektuma. |
Példa: a Fetch útvonal csak a manage_options jogosultságú felhasználóknak érhető el.
function prefix_rest_permission( $proceed, $request ) {
if ( '/wpgb/v1/fetch' === $request->get_route() ) { $proceed = current_user_can( 'manage_options' ); }
return $proceed;
}add_filter( 'wp_grid_builder/rest_api/permission', 'prefix_rest_permission', 10, 2 );Készült: