miércoles, 10 de febrero de 2016

Usando pre_get_posts en vez de query_posts en WordPress

Como ya sabemos hay varias manera de obtener los posts en WordPress:
Vamos a centrarnos en el primero, en el muy utilizado query_posts. Vemos que el codex de WordPress ya nos avisa que algo pasa con query_posts():
“Es preferible utilizar ‘pre_get_posts’ alterando el query principal usando is_main_query”
¿Por qué nos dice esto? Vamos a ver primero cómo funciona query_posts() y entenderemos enseguida el problema.

Cómo funciona query_posts()


Al usar query_posts() estamos diciéndole a WordPress que el trabajo que ha hecho recolectando toda la información del post no vale. Le cambiamos las normas del juego después de haber jugado y le decimos que vuelva a recolectar todos los datos pero en base a unos nuevos criterios que le damos.
Otra vez a recolectar todos los datos, y así cada vez que alguien nos visita (a no ser que hayáis tomado la precaución de cachear los datos con transients o similares). La incidencia en webs con poco tráfico puede ser irrelevante, pero en webs con mucho tráfico sí deberíamos tenerlo en cuenta.
Vamos a verlo en un ejemplo. Supongamos que tenemos un archivo de taxonomías para el que queremos que no salga la categoría 13 y que además nos muestre 8 resultados por página. Si hiciéramos antes del loop:

PHP
1
query_posts($query_string . "&cat=-13&posts_per_pag=8");
¿Qué sucedería? WordPress llegaría con todos los datos obtenidos de la base de datos, pero le decimos: vuelve por donde has venido, pero esta vez sin entradas de la categoría 13 y con 8 resultados por página.
¿Cómo le daríamos las instrucciones pertinentes a WordPress antes de que vaya a recoger los datos la primera vez? Con pre_get_posts.

Cómo funciona pre_get_posts

pre_get_posts nos da acceso al objeto $query por referencia (no necesitas declarar globales ni devolver un valor), y se usa de la manera siguiente:


PHP
1
<?php add_action( 'pre_get_posts', 'nombre_funcion' ); ?>
Donde “nombre_funcion” es el nombre de la función que se va a llamar. Esto deberíamos incluirlo en el archivo functions.php de nuestro tema o en un plugin. WordPress necesita crear el query antes de nada para saber qué plantilla (template) va a cargar, por lo que si pones pre_get_posts en una plantilla, como por ejemplo archive.php, será ya demasiado tarde.
Vamos a seguir con el ejemplo anterior. En nuestro archivo functions.php escribiríamos:

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
//////////////////////////////////////////////////////////////////////////////////////////
/// Cambiamos el query principal para las paginas de archivo de Taxonomias
function nuevo_query_tax( $query ) {
    // No afecte a los queries de Admin
    if( $query->is_admin == 1 ) {
        return;
    }
    // Si no es el query principal
    if( !$query->is_main_query() ) {
        return;
    }
    // Parar si no estamos en una pagina de archivo de taxonomias
    if( !$query->is_tax == 1 ) {
        return;
    }
    
    // Eliminamos la categoria 13
    $query->set( 'cat', '-13' );
    
    // Mostramos solo 8 resultados
    $query->set( 'posts_per_page', 8 );
    
}
// Cambiamos el query con pre_get_posts
add_action( 'pre_get_posts', 'nuevo_query_tax' );
Como veis con $query->set establecemos las nuevas condiciones (primero que no incluya la categoría 13 y luego que nos de 8 resultados). Pero, ¿para qué son los condicionales?
Usando pre_get_posts podemos estar afectando más de lo previsto, por eso nos cubrimos las espaldas:
– Este filtro afecta a los queries de las pantallas del administrador. Tenemos por lo tanto que asegurarnos de que nuestra modificación no afecta al administrador de WordPress. De ahí el primer condicional.
– A continuación nos aseguramos de que estamos afectando sólo al query principal, y no a otros queries como los del menú o los de ciertos widgets. Esto lo hacemos comprobando que $query->is_main_query().
– Por último comprobamos que las condiciones son adecuadas para nuestra modificación. Por ejemplo, si quieres que sólo ocurra en la home, el condicional sería $query->is_home(). En nuestro caso queremos asegurarnos de que estamos en la página de archivo de la taxonomía para aplicar el filtro.
Mas ejemplos:
Por ejemplo, si tenemos establecido un número determinado de artículos por página y queremos cambiarlo para ciertas categorías:

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//////////////////////////////////////////////////////////////////////////////////////////
/// Cambiamos el query para las categorias 44 y 34, para que haya 12 posts por pagina
/// y el query de la categoria categoria 31, para que haya 20 posts por pagina
function nuevo_query_tax( $query ) {
    if ( is_admin() || ! $query->is_main_query() )
        return;
    
    if(is_category(34,44)){  
        // Mostramos 13 resultados
        $query->set( 'posts_per_page', 13 );      
    }
    
    if(is_category(31)){
        // Mostramos 20 resultados
        $query->set( 'posts_per_page', 20 );      
    }    
    
}
// Cambiamos el query con pre_get_posts
add_action( 'pre_get_posts', 'nuevo_query_tax' );
Otro ejemplo, queremos que para cierta categoría salgan un cierto número de resultados pero sólo aquellos cuyo valor de un meta value cumpla alguna condición:

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
//////////////////////////////////////////////////////////////////////////////////////////
/// Cambiamos el query principal para la categoria 21 para que salgan 5 y solo aquellos en los que su meta_query custom_ganadores sea No
function nuevo_query_tax2( $query ) {
    if ( is_admin() || ! $query->is_main_query() )
        return;
    
    if(!is_category(21)) return;
    
    $query->set('meta_key', 'custom_ganadores');
    $query->set('meta_value', 'No');
    
    // Mostramos 5 resultados
    $query->set( 'posts_per_page', 5 );
    
}
// Cambiamos el query con pre_get_posts
add_action( 'pre_get_posts', 'nuevo_query_tax2' );


Publicado por
Etiquetas:

No hay comentarios.:

Publicar un comentario

Suscribirse a: Comentarios de la entrada (Atom)