Tovább a tartalomhoz

PHP-szűrők: a rács lekérdezése, beállításai és objektumai

A rács lekérdezési argumentumait, beállításait, objektumait és beágyazott szkriptjét módosító PHP-szűrők, valamint a jogosultság szűrője.

Ezek a PHP-szűrők a rács (grid) működését alakítják. A nevük a wp_grid_builder/ előtaggal kezdődik, a kódot a gyermektéma functions.php fájljába vagy egy saját bővítménybe írd.

Szűrő Mikor fut le Argumentumok
wp_grid_builder/grid/query_args A rács lekérdezése előtt. $query_args, $grid_id
wp_grid_builder/grid/settings Minden alkalommal, amikor a rács beállításait lekérdezi a bővítmény. $settings
wp_grid_builder/grid/the_object Miután egy elem (bejegyzés, kifejezés vagy felhasználó) be lett állítva a ciklusban. $object
wp_grid_builder/grid/inline_script Miután az oldalon lévő összes rács beágyazott JavaScriptje elkészült. $script
wp_grid_builder/user_capability Minden jogosultság-ellenőrzéskor. $capability

A grid/query_args a rács lekérdezése előtt fut le, és a WP_Query, WP_Term_Query vagy WP_User_Query argumentumait módosíthatod vele.

Csak a bővítménnyel épített rácsokra hat. Egyedi és archívum-lekérdezésnél a WordPress pre_get_posts műveletét használd.

Argumentum Típus Leírás
$query_args tömb A lekérdezés argumentumai.
$grid_id egész szám A rács azonosítója.

A rács szűrés (a szűrők kirajzolása és frissítése) közben Ajax-kérésben is lekérdeződik. Ezért az aktuális bejegyzés azonosítóját ilyenkor a hivatkozó oldal (referer) címéből kell kinyerni, nem a globális $post változóból. Az alábbi példák ezt használják.

function grid_query_exclude_current_post( $query_args, $grid_id ) {
global $post;
if ( 1 === $grid_id ) {
$referer = wp_get_referer();
$post_id = wp_doing_ajax() ? url_to_postid( $referer ) : $post->ID;
$query_args['post__not_in'] = [ $post_id ];
}
return $query_args;
}
add_filter( 'wp_grid_builder/grid/query_args', 'grid_query_exclude_current_post', 10, 2 );

Egyedi mezőben tárolt bejegyzések megjelenítése

Szekció neve “Egyedi mezőben tárolt bejegyzések megjelenítése”

Az egyedi mező a megjelenítendő bejegyzések azonosítóit tárolja, a lekérdezés a post__in feltételt használja.

function grid_query_include_post_ids( $query_args, $grid_id ) {
global $post;
if ( 1 === $grid_id ) {
$referer = wp_get_referer();
$post_id = wp_doing_ajax() ? url_to_postid( $referer ) : $post->ID;
$query_args['post__in'] = (array) get_post_meta( $post_id, 'custom_field_name', true );
}
return $query_args;
}
add_filter( 'wp_grid_builder/grid/query_args', 'grid_query_include_post_ids', 10, 2 );

Egyetlen bejegyzés oldalán a bejegyzéssel azonos kategóriájú (vagy más megadott taxonómiájú) bejegyzéseket listázza. Ha a bejegyzésnek nincs kifejezése, a post__in értéke [ 0 ], így a rács üres marad.

function grid_query_related_posts( $query_args, $grid_id ) {
global $post;
if ( 1 !== $grid_id ) {
return $query_args;
}
$taxonomy = 'category';
$post_id = wp_doing_ajax() ? url_to_postid( wp_get_referer() ) : $post->ID;
$terms = get_the_terms( $post_id, $taxonomy );
if ( is_wp_error( $terms ) || empty( $terms ) ) {
$query_args['post__in'] = [ 0 ];
} else {
$query_args['post__not_in'] = [ $post_id ];
$query_args['tax_query'] = [
[
'taxonomy' => $taxonomy,
'terms' => wp_list_pluck( $terms, 'term_id' ),
],
];
}
return $query_args;
}
add_filter( 'wp_grid_builder/grid/query_args', 'grid_query_related_posts', 10, 2 );
function grid_query_related_products( $query_args, $grid_id ) {
global $post;
if ( 1 !== $grid_id || ! function_exists( 'wc_get_product' ) ) {
return $query_args;
}
$referer = wp_get_referer();
$post_id = wp_doing_ajax() ? url_to_postid( $referer ) : $post->ID;
$product = wc_get_product( $post_id );
if ( empty( $product ) ) {
$product_ids = [];
} else {
$posts_per_page = isset( $query_args['posts_per_page'] ) ? $query_args['posts_per_page'] : 4;
$product_ids = wc_get_related_products( $post_id, $posts_per_page, $product->get_upsell_ids() );
}
$query_args['post_type'] = [ 'product' ];
$query_args['post__in'] = empty( $product_ids ) ? [ 0 ] : $product_ids;
return $query_args;
}
add_filter( 'wp_grid_builder/grid/query_args', 'grid_query_related_products', 10, 2 );

WooCommerce: keresztértékesítési termékek

Szekció neve “WooCommerce: keresztértékesítési termékek”
function grid_query_cross_sell_products( $query_args, $grid_id ) {
global $post;
if ( 1 !== $grid_id || ! function_exists( 'wc_get_product' ) ) {
return $query_args;
}
$referer = wp_get_referer();
$post_id = wp_doing_ajax() ? url_to_postid( $referer ) : $post->ID;
$product = wc_get_product( $post_id );
$product_ids = empty( $product ) ? [] : $product->get_cross_sell_ids();
$query_args['post_type'] = [ 'product' ];
$query_args['post__in'] = empty( $product_ids ) ? [ 0 ] : $product_ids;
return $query_args;
}
add_filter( 'wp_grid_builder/grid/query_args', 'grid_query_cross_sell_products', 10, 2 );

WooCommerce: felárazott (upsell) termékek

Szekció neve “WooCommerce: felárazott (upsell) termékek”
function grid_query_upsell_products( $query_args, $grid_id ) {
global $post;
if ( 1 !== $grid_id || ! function_exists( 'wc_get_product' ) ) {
return $query_args;
}
$referer = wp_get_referer();
$post_id = wp_doing_ajax() ? url_to_postid( $referer ) : $post->ID;
$product = wc_get_product( $post_id );
$product_ids = empty( $product ) ? [] : $product->get_upsell_ids();
$query_args['post_type'] = [ 'product' ];
$query_args['post__in'] = empty( $product_ids ) ? [ 0 ] : $product_ids;
return $query_args;
}
add_filter( 'wp_grid_builder/grid/query_args', 'grid_query_upsell_products', 10, 2 );
function grid_query_on_sale_products( $query_args, $grid_id ) {
if ( 1 === $grid_id && function_exists( 'wc_get_product_ids_on_sale' ) ) {
$query_args['post__in'] = wc_get_product_ids_on_sale();
}
return $query_args;
}
add_filter( 'wp_grid_builder/grid/query_args', 'grid_query_on_sale_products', 10, 2 );

A grid/settings minden alkalommal lefut, amikor a rács beállításait lekérdezi a bővítmény a rács kirajzolása vagy frissítése (szűrés) előtt. Dinamikusan módosíthatod a rács beállításait, így ugyanazt a rácsot különböző oldalakon eltérő viselkedéssel használhatod.

Argumentum Típus Leírás
$settings tömb A rács beállításai.

Példa: az 1-es azonosítójú rácshoz új kártyaméret-szabály 1140 képpontos böngészőszélességtől.

function prefix_grid_settings( $settings ) {
if ( 1 === $settings['id'] ) {
$settings['card_sizes'][] = [
'browser' => 1140, // böngészőszélesség
'columns' => 4, // oszlopok száma
'height' => 240, // kártyamagasság
'gutter' => 28, // térköz
'ratio' => [ // képarány
'x' => 4,
'y' => 3,
],
];
}
return $settings;
}
add_filter( 'wp_grid_builder/grid/settings', 'prefix_grid_settings' );

A grid/the_object azután fut le, hogy egy elem (bejegyzés, kifejezés vagy felhasználó) be lett állítva a ciklusban, a WP_Query, WP_Term_Query vagy WP_User_Query után. Az elem tulajdonságait (cím, kivonat stb.) módosíthatod vele.

Argumentum Típus Leírás
$object objektum Az aktuális elem adatai a ciklusban.

A példákban a wpgb_get_grid_settings() adja a rács beállításait, ebből az id alapján szűrhetsz egy adott rácsra.

Egy egyedi mező a kép azonosítóját tárolja. Az ACF és a Meta Box képmezőjével működik (ismétlő, klón és csoport mezővel nem), és minden olyan mezőbővítménnyel, amely a kép azonosítóját menti.

function set_custom_card_thumbnail( $object ) {
$grid = wpgb_get_grid_settings();
if ( 1 !== $grid->id ) {
return $object;
}
$image_id = get_post_meta( $object->ID, 'custom_field_name', true );
if ( ! empty( $image_id ) ) {
$object->post_thumbnail = $image_id;
}
return $object;
}
add_filter( 'wp_grid_builder/grid/the_object', 'set_custom_card_thumbnail' );

Az egyedi mező a képek azonosítóit tárolja (ACF vagy Meta Box galériamező, ismétlő, klón és csoport nélkül).

function set_custom_card_gallery( $object ) {
$grid = wpgb_get_grid_settings();
if ( 1 !== $grid->id ) {
return $object;
}
$image_ids = get_post_meta( $object->ID, 'custom_field_name', true );
if ( empty( $image_ids ) ) {
return $object;
}
$object->post_format = 'gallery';
$object->post_media = [
'format' => 'gallery',
'sources' => $image_ids,
];
// A bélyegkép a galéria első képe.
$object->post_thumbnail = reset( $image_ids );
return $object;
}
add_filter( 'wp_grid_builder/grid/the_object', 'set_custom_card_gallery' );

Az egyedi mező a (saját tárhelyen lévő) videó URL-jét tárolja.

function set_custom_card_video( $object ) {
$grid = wpgb_get_grid_settings();
if ( 1 !== $grid->id ) {
return $object;
}
$video_url = get_post_meta( $object->ID, 'custom_field_name', true );
if ( empty( $video_url ) ) {
return $object;
}
$object->post_format = 'video';
$object->post_media = [
'format' => 'video',
'type' => 'hosted',
'sources' => [ $video_url ],
];
return $object;
}
add_filter( 'wp_grid_builder/grid/the_object', 'set_custom_card_video' );

A grid/inline_script azután fut le, hogy az oldalon lévő összes rács beágyazott JavaScriptje elkészült. Módosíthatod, vagy teljesen el is távolíthatod, ha nagyobb irányítást szeretnél, vagy a rácsokat a saját szkriptedből indítod.

Argumentum Típus Leírás
$script szöveg A rácsok beágyazott JavaScriptje.
function prefix_inline_script( $script ) {
// Üres szöveg: nincs beágyazott szkript.
return '';
}
add_filter( 'wp_grid_builder/grid/inline_script', 'prefix_inline_script', 10, 1 );

A user_capability minden olyan művelet előtt lefut, amely a felhasználó szerepkörét vagy jogosultságát ellenőrzi. Ez dönti el, hogy ki érheti el és szerkesztheti, törölheti, importálhatja a bővítmény adatait. Az alapértelmezett jogosultság a manage_options.

Argumentum Típus Leírás
$capability szöveg Az alapértelmezett jogosultság (manage_options).

Példa: a szerkesztők (editor) is kezelhetik a bővítményt.

function prefix_set_user_capability( $capability ) {
if ( current_user_can( 'editor' ) ) {
$capability = 'editor';
}
return $capability;
}
add_filter( 'wp_grid_builder/user_capability', 'prefix_set_user_capability', 10, 1 );

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