Cum se repară paginarea pentru bucle personalizate?

Problema

În mod implicit, în orice context dat, WordPress utilizează interogarea principală pentru a determina paginarea. Obiectul interogării principale este stocat în variabila globală $wp_query, care este folosită și pentru afișarea buclei principale de interogare:

if ( have_posts() ) : while ( have_posts() ) : the_post();

Când utilizezi o interogare personalizată, creezi un obiect de interogare complet separat:

$custom_query = new WP_Query( $custom_query_args );

Și acea interogare este afișată printr-o buclă separată:

if ( $custom_query->have_posts() ) : 
    while ( $custom_query->have_posts() ) : 
        $custom_query->the_post();

Dar funcțiile de paginare, inclusiv previous_posts_link(), next_posts_link(), posts_nav_link() și paginate_links(), își bazează rezultatul pe obiectul interogării principale, $wp_query. Acea interogare principală poate sau nu să fie paginată. Dacă contextul curent este un șablon de pagină personalizat, de exemplu, obiectul principal $wp_query va consta doar dintr-un singur post - cel al ID-ului paginii căreia i se atribuie șablonul de pagină personalizat.

Dacă contextul curent este un index de arhivă de un anumit tip, interogarea principală $wp_query poate consta din suficiente postări pentru a provoca paginare, ceea ce duce la următoarea parte a problemei: pentru obiectul principal $wp_query, WordPress va transmite un parametru paged către interogare, bazat pe variabila de interogare URL paged. Când interogarea este preluată, acel parametru paged va fi folosit pentru a determina care set de postări paginate să returneze. Dacă este apăsat un link de paginare afișat și este încărcată pagina următoare, interogarea ta personalizată nu va avea nicio modalitate de a ști că paginarea s-a schimbat.

Soluția

Transmiterea parametrului corect Paged către interogarea personalizată

Presupunând că interogarea personalizată folosește un array de argumente:

$custom_query_args = array(
    // Parametrii interogării personalizate merg aici
);

Va trebui să transmiți parametrul corect paged către array. Poți face acest lucru preluând variabila de interogare URL folosită pentru a determina pagina curentă, prin get_query_var():

get_query_var( 'paged' );

Apoi poți adăuga acel parametru în array-ul de argumente al interogării personalizate:

$custom_query_args['paged'] = get_query_var( 'paged' ) 
    ? get_query_var( 'paged' ) 
    : 1;

Notă: Dacă pagina ta este o pagină frontală statică, asigură-te că folosești page în loc de paged, deoarece o pagină frontală statică folosește page și nu paged. Iată ce ar trebui să ai pentru o pagină frontală statică:

$custom_query_args['paged'] = get_query_var( 'page' ) 
    ? get_query_var( 'page' ) 
    : 1;

Acum, când interogarea personalizată este preluată, va fi returnat setul corect de postări paginate.

Utilizarea obiectului de interogare personalizat pentru funcțiile de paginare

Pentru ca funcțiile de paginare să ofere rezultatul corect - adică linkuri anterioare/următoare/pagină relative la interogarea personalizată - WordPress trebuie forțat să recunoască interogarea personalizată. Acest lucru necesită un mic "hack": înlocuirea obiectului principal $wp_query cu obiectul de interogare personalizat, $custom_query:

Modificarea obiectului de interogare principal

1. Salvează obiectul de interogare principal: $temp_query = $wp_query
2. Anulează obiectul de interogare principal: $wp_query = NULL;

3. Înlocuiește interogarea personalizată în obiectul de interogare principal: $wp_query = $custom_query;

   $temp_query = $wp_query;
   $wp_query   = NULL;
   $wp_query   = $custom_query;
   

Acest "hack" trebuie făcut înainte de a apela orice funcții de paginare

Resetarea obiectului de interogare principal

După ce funcțiile de paginare au fost afișate, resetează obiectul de interogare principal:

$wp_query = NULL;
$wp_query = $temp_query;

Remedieri pentru funcțiile de paginare

Funcția previous_posts_link() va funcționa normal, indiferent de paginare. Ea determină doar pagina curentă și apoi afișează linkul pentru page - 1. Totuși, este necesară o remediere pentru ca next_posts_link() să funcționeze corect. Acest lucru se întâmplă deoarece next_posts_link() utilizează parametrul max_num_pages:

<?php next_posts_link( $label , $max_pages ); ?>

Ca și în cazul altor parametri de interogare, în mod implicit funcția va folosi max_num_pages pentru obiectul principal $wp_query. Pentru a forța next_posts_link() să țină cont de obiectul $custom_query, va trebui să transmiți max_num_pages către funcție. Poți prelua această valoare din obiectul $custom_query: $custom_query->max_num_pages:

<?php next_posts_link( 'Postări mai vechi' , $custom_query->max_num_pages ); ?>

Punând totul cap la cap

Următorul este un construct de bază al unei bucle de interogare personalizată cu funcții de paginare care funcționează corect:

// Definește parametrii interogării personalizate
$custom_query_args = array( /* Parametrii merg aici */ );

// Obține pagina curentă și adaugă la array-ul de parametri ai interogării personalizate
$custom_query_args['paged'] = get_query_var( 'paged' ) ? get_query_var( 'paged' ) : 1;

// Instanțiază interogarea personalizată
$custom_query = new WP_Query( $custom_query_args );

// Remediu pentru paginare
$temp_query = $wp_query;
$wp_query   = NULL;
$wp_query   = $custom_query;

// Afișează bucla interogării personalizate
if ( $custom_query->have_posts() ) :
    while ( $custom_query->have_posts() ) :
        $custom_query->the_post();
        // Aici intră conținutul buclei
    endwhile;
endif;
// Resetează datele postului
wp_reset_postdata();

// Paginarea buclei interogării personalizate
previous_posts_link( 'Postări mai vechi' );
next_posts_link( 'Postări mai noi', $custom_query->max_num_pages );

// Resetează obiectul de interogare principal
$wp_query = NULL;
$wp_query = $temp_query;

Anexă: Ce zici de query_posts()?

query_posts() pentru bucle secundare

Dacă folosești query_posts() pentru a afișa o buclă personalizată, în loc să instanțiezi un obiect separat pentru interogarea personalizată prin WP_Query(), atunci _doing_it_wrong() și vei întâmpina mai multe probleme (printre care și probleme de paginare). Primul pas pentru rezolvarea acestor probleme va fi conversia utilizării improprii a query_posts() la un apel corespunzător WP_Query().

Utilizarea query_posts() pentru modificarea buclei principale

Dacă vrei doar să modifici parametrii pentru interogarea buclei principale - cum ar fi schimbarea numărului de postări pe pagină sau excluderea unei categorii - poți fi tentat să folosești query_posts(). Dar tot nu ar trebui. Când folosești query_posts(), forțezi WordPress să înlocuiască obiectul de interogare principal. (WordPress face de fapt o a doua interogare și suprascrie $wp_query.) Problema, însă, este că face această înlocuire prea târziu în proces pentru a actualiza paginarea.

Soluția este să filtrezi interogarea principală înainte ca postările să fie preluate, prin hook-ul pre_get_posts.

În loc să adaugi asta în fișierul șablonului de categorie (category.php):

query_posts( array(
    'posts_per_page' => 5
) );

Adaugă următoarele în functions.php:

function wpse120407_pre_get_posts( $query ) {
    // Testează pentru indexul de arhivă al categoriei
    // și asigură-te că interogarea este interogarea principală
    // și nu o interogare secundară (cum ar fi un meniu de navigare
    // sau un widget de postări recente, etc.
    if ( is_category() && $query->is_main_query() ) {
        // Modifică numărul de postări pe pagină
        $query->set( 'posts_per_page', 5 ); 
    }
}
add_action( 'pre_get_posts', 'wpse120407_pre_get_posts' );

În loc să adaugi asta în fișierul șablonului indexului de blog (home.php):

query_posts( array(
    'cat' => '-5'
) );

Adaugă următoarele în functions.php:

function wpse120407_pre_get_posts( $query ) {
    // Testează pentru indexul principal de postări de blog
    // și asigură-te că interogarea este interogarea principală
    // și nu o interogare secundară (cum ar fi un meniu de navigare
    // sau un widget de postări recente, etc.
    if ( is_home() && $query->is_main_query() ) {
        // Exclude categoria cu ID-ul 5
        $query->set( 'category__not_in', array( 5 ) ); 
    }
}
add_action( 'pre_get_posts', 'wpse120407_pre_get_posts' );

În acest fel, WordPress va folosi obiectul $wp_query deja modificat pentru a determina paginarea, fără a fi necesară nicio modificare a șablonului.

Când să folosești ce funcție

Cercetează această întrebare și răspuns și această întrebare și răspuns pentru a înțelege cum și când să folosești WP_Query, pre_get_posts și query_posts().