Comment utiliser Masonry pour ajouter une grille de publication de style Pinterest dans WordPress

Ceci est une publication de Josh Pollock.

L’affichage des publications sous forme de grille, à la manière de Pinterest, est depuis un certain temps un design populaire pour les pages d’index des blogs WordPress. Il est populaire uniquement parce qu’il imite l’aspect du site de réseau social populaire, mais aussi parce qu’il utilise au mieux l’espace sur l’écran. Sur l’index d’un blog WordPress, elle permet à chaque publication d’être affichée à la taille qu’elle doit naturellement avoir, sans laisser d’espace supplémentaire.

Dans ce tutoriel, je vous montrerai comment utiliser la populaire Bibliothèque JavaScript Masonry pour créer des mises en page en grille en cascade pour l’index de votre blog, ainsi que pour les pages d’archives de votre thème. J’aborderai quelques problèmes que vous devez prendre en compte pour l’optimisation mobile et comment les résoudre.

Note : Il s’agit d’un tutoriel de niveau avancé pour ceux qui se sentent à l’aise pour modifier des thèmes WordPress et qui ont des connaissances suffisantes en HTML/CSS.

Étape par étape : Ajouter les bibliothèques nécessaires à votre thème

Mise à jour: WordPress 3.9 inclut désormais la dernière version de Masonry.

Tout d’abord, vous devez charger Masonry dans votre thème, en utilisant ce code :

if (! function_exists('slug_scripts_masonry') ) :
if ( ! is_admin() ) :
function slug_scripts_masonry() {
    wp_enqueue_script('masonry');
    wp_enqueue_style('masonry’, get_template_directory_uri().'/css/’);
}
add_action( 'wp_enqueue_scripts', 'slug_scripts_masonry' );
endif; //! is_admin()
endif; //! slug_scripts_masonry exists

Ce code charge simplement masonry et le rend disponible pour les fichiers de modèles de votre thème (voir notre guide sur la façon d’ajouter correctement des JavaScripts et des Styles dans WordPress). Notez également que nous n’ajoutons pas jQuery comme dépendance pour l’un ou l’autre. L’un des avantages de Masonry 3 est qu’il ne nécessite pas jQuery, mais peut être utilisé avec. D’après mon expérience, l’initialisation de Masonry sans jQuery est plus fiable et permet d’Aller à/au chargement de jQuery, ce qui peut aider à réduire les temps de chargement des pages et les problèmes de compatibilité.

Étape par étape : Initialiser le JavaScript

La fonction suivante définit Réglages, les conteneurs qui seront utilisés et s’assure que tout se passe dans le bon ordre. Masonry a besoin de calculer la taille de chacun des articles de la page afin de commander sa grille de façon dynamique. Un problème que j’ai rencontré avec Masonry dans de nombreux navigateurs est que Masonry calcule mal la hauteur des articles dont les images se chargent lentement, ce qui a pour effet de faire se chevaucher les articles. La solution consiste à utiliser imagesLoaded pour empêcher Masonry de calculer la mise en page jusqu’à ce que toutes les images soient chargées. Cela permet de garantir un dimensionnement correct.

Il s’agit de la fonction et de l’action qui produiront le script d’initialisation dans le pied de page :

if ( ! function_exists( 'slug_masonry_init' )) :
function slug_masonry_init() { ?>
<script>
    //set the container that Masonry will be inside of in a var
    var container = document.querySelector('#masonry-loop');
    //create empty var msnry
    var msnry;
    // initialize Masonry after all images have loaded
    imagesLoaded( container, function() {
        msnry = new Masonry( container, {
            itemSelector: '.masonry-entry'
        });
    });
</script>
<?php }
//add to wp_footer
add_action( 'wp_footer', 'slug_masonry_init' );
endif; // ! slug_masonry_init exists

La fonction est expliquée étape par étape avec des commentaires en ligne. La fonction JavaScript indique à Masonry de rechercher les articles de la classe « masonry-entry » dans un conteneur portant l’ID « masonry-loop » et de calculer la grille uniquement après le chargement des images. Nous définissons le conteneur extérieur avec querySelector et le conteneur intérieur avec itemSelector.

Étape par étape : Création de la boucle de masonry

Au lieu d’ajouter la Balise HTML pour Masonry directement à un Modèle, nous allons créer un élément de modèle séparé pour cela. Créez un nouveau fichier appelé « content-masonry.php » et ajoutez-le à votre thème. Cela vous permettra d’ajouter la boucle Masonry à autant de modèles différents que vous le souhaitez.

Dans votre nouveau fichier, vous ajouterez le code affiché ci-dessous. Le balisage est similaire à ce que vous verriez normalement pour toute prévisualisation de contenu. Vous pouvez le modifier comme bon vous semble, mais assurez-vous que l’élément le plus externe possède la classe « masonry-entry » que nous avons définie comme itemSelector dans la dernière étape.

<article class="masonry-entry" id="post-<?php the_ID(); ?>" <?php post_class(); ?> >
<?php if ( has_post_thumbnail() ) : ?>
    <div class="masonry-thumbnail">
        <a href="<?php the_permalink(' ') ?>" title="<?php the_title(); ?>"><?php the_post_thumbnail('masonry-thumb'); ?></a>
    </div><!--.masonry-thumbnail-->
<?php endif; ?>
    <div class="masonry-details">
        <h5><a href="<?php the_permalink(' ') ?>" title="<?php the_title(); ?>"><span class="masonry-post-title"> <?php the_title(); ?></span></a></h5>
        <div class="masonry-post-excerpt">
            <?php the_excerpt(); ?>
        </div><!--.masonry-post-excerpt-->
    </div><!--/.masonry-entry-details -->  
</article><!--/.masonry-entry-->

Cette balise a des classes pour chacune de ses parties, de sorte que vous pouvez ajouter une balise pour correspondre à votre thème. J’aime ajouter une jolie bordure légèrement arrondie à .masonry-entry. Une autre option intéressante est de ne pas ajouter de bordure à .masonry-entry, mais de lui donner une légère ombre. Cette option est particulièrement intéressante lorsque la miniature de la publication s’étend jusqu’à la bordure du conteneur, ce qui peut être réalisé en donnant à .masonry-thumbnail des marges externes et des marges internes de 0 dans toutes les directions. Vous voudrez ajouter tous ces styles dans un fichier appelé masonry.css dans le répertoire css de votre thème.

Étape par étape : Ajouter la boucle de masonry aux modèles

Maintenant que nous avons notre élément de modèle, vous pouvez l’utiliser dans n’importe quel modèle de votre thème. Vous pouvez l’ajouter à index.php, mais pas à category.php si vous ne voulez pas qu’elle soit utilisée pour les archives des catégories. Si vous voulez l’utiliser uniquement sur la page d’accueil de votre thème, lorsqu’elle est définie pour afficher les publications du blog, vous l’utiliserez dans home.php. Où que vous choisissiez, tout ce que vous avez à faire est d’envelopper votre boucle dans un conteneur avec l’ID « masonry-loop » et d’ajouter l’élément de modèle dans la boucle en utilisant get_template_part(). Confirmez-vous que le conteneur de la boucle de maçonnerie démarre avant while (have_posts() ).

Par exemple, voici la boucle principale de l’index.php de Twentythirteen :

<?php if ( have_posts() ) : ?>

    <?php /* The loop */ ?>
    <?php while ( have_posts() ) : the_post(); ?>
        <?php get_template_part( 'content', get_post_format() ); ?>
    <?php endwhile; ?>

    <?php twentythirteen_paging_nav(); ?>

<?php else : ?>
    <?php get_template_part( 'content', 'none' ); ?>
<?php endif; ?>

Et la voici modifiée pour utiliser notre boucle Masonry :

<?php if ( have_posts() ) : ?>
<div id="masonry-loop">
    <?php /* The loop */ ?>
    <?php while ( have_posts() ) : the_post(); ?>
        <?php get_template_part( 'content', 'masonry' ?>
    <?php endwhile; ?>
</div><!--/#masonry-loop-->
    <?php twentythirteen_paging_nav(); ?>

<?php else : ?>
    <?php get_template_part( 'content', 'none' ); ?>
<?php endif; ?>

Étape par étape : Définir les Réglages responsive des articles masonry

Vous pouvez définir la largeur de chaque article Masonry de plusieurs manières. Vous pouvez définir la largeur en utilisant un nombre de pixels lorsque vous initialisez Masonry. Je ne suis pas fan de cette méthode car j’utilise des thèmes responsive et cela nécessite des requêtes media complexes pour obtenir des résultats corrects sur les petits écrans. Pour les Réglages responsive, j’ai trouvé que la meilleure chose à faire est de définir une valeur de largeur pour .masonry-entry avec un pourcentage, basé sur le nombre d’articles que vous voulez dans une ligne et laisser Masonry faire le reste du calcul pour vous.

Tout ce qui est nécessaire est de diviser les 100 par le nombre d’articles que vous voulez définir le pourcentage dans une simple entrée dans le style.css de votre thème. Par exemple, si vous voulez quatre articles dans chaque ligne, vous pouvez le faire dans votre fichier masonry.css :

.masonry-entry{width:25%}

Étape par étape : Optimisation mobile

Nous pourrions nous arrêter ici, mais je ne pense pas que le résultat final fonctionne incroyablement bien sur les petits écrans de téléphone. Une fois que vous êtes satisfait de l’aspect de votre thème avec la nouvelle grille Masonry sur votre ordinateur, vérifiez-le sur votre téléphone. Si vous n’êtes pas satisfait de l’aspect de votre thème sur votre téléphone, vous devrez faire un peu de travail.

Je ne pense pas qu’il y ait assez de place sur l’écran d’un téléphone pour tout ce que nous avons ajouté à notre élément contenu-masonry du modèle. Deux bonnes solutions s’offrent à vous : raccourcir l’extrait pour les téléphones ou l’omettre complètement. Voici une fonction supplémentaire que vous pouvez ajouter au fichier functions.php de votre thème pour faire cela. Parce que je ne pense pas que ces questions soient un problème sur les tablettes, j’utilise une excellente extension Mobble dans tous les exemples de cette section pour effectuer uniquement les modifications sur les téléphones, pas sur les tablettes. Je vérifie également si Mobble est activé avant de l’utiliser et, si nécessaire, j’utilise la fonction de détection mobile plus générale wp_is_mobile qui est intégrée à WordPress.

if (! function_exists('slug_custom_excerpt_length') ) :
function slug_custom_excerpt_length( $length ) {
    //set the shorter length once
    $short = 10;
    //set long length once
    $long = 55;
    //if we can only set short excerpt for phones, else short for all mobile devices
    if (function_exists( 'is_phone') {
        if ( is_phone() ) {
            return $short;
        }
        else {
            return $long;
        }        
    }
    else {
        if ( wp_is_mobile() ) {
            return $short;
        }
        else {
            return $long;
        }
    }
}
add_filter( 'excerpt_length', 'slug_custom_excerpt_length', 999 );
endif; // ! slug_custom_excerpt_length exists

Comme vous pouvez le voir, nous commençons par stocker la longueur de l’extrait long et la longueur de l’extrait court dans des variables, puisque nous allons utiliser ces valeurs deux fois et que nous voulons être en mesure de les modifier à partir d’un seul endroit si nous en avons besoin ultérieurement. Ensuite, nous testons si nous pouvons utiliser la fonction is_phone() de Mobble. Si c’est le cas, nous définissons l’extrait court pour les téléphones et l’extrait long si nous ne le sommes pas. Après cela, nous faisons la même chose de base, mais en utilisant wp_is_mobile, qui affectera tous les appareils mobiles ,si is_phone() ne peut pas être utilisé. Avec un peu de chance, la partie else de cette fonction ne sera jamais utilisée, mais il est bon d’avoir une sauvegarde au cas où. Une fois la logique de longueur d’extrait définie, il ne reste plus qu’à crocheter la fonction avec le filtre excerpt_length.

Raccourcir l’extrait est une option, mais nous pouvons aussi l’éliminer complètement avec un processus simple. Voici une nouvelle version de content-masonry, avec l’intégralité de l’extrait supprimée sur les téléphones :

<article class="masonry-entry" id="post-<?php the_ID(); ?>" <?php post_class(); ?> >
<?php if ( has_post_thumbnail() ) : ?>
    <div class="masonry-thumbnail">
        <a href="<?php the_permalink(' ') ?>" title="<?php the_title(); ?>"><?php the_post_thumbnail('masonry-thumb'); ?></a>
    </div><!--.masonry-thumbnail-->
<?php endif; ?>
    <div class="masonry-details">
        <h5><a href="<?php the_permalink(' ') ?>" title="<?php the_title(); ?>"><span class="masonry-post-title"> <?php the_title(); ?></span></a></h5>
        <?php 
            //put the excerpt markup in variable so we don't have to repeat it multiple times.
            $excerpt = '<div class="masonry-post-excerpt">';
            $excerpt .= the_excerpt();
            $excerpt .= '</div><!--.masonry-post-excerpt-->';
//if we can only skip for phones, else skip for all mobile devices
            if (function_exists( 'is_phone') {
                if ( ! is_phone() ) {
                    echo $excerpt;
                }
            }
            else {
                if ( ! wp_is_mobile() ) {
                    echo $excerpt;
                }
            }
        ?>
    </div><!--/.masonry-entry-details -->  
</article><!--/.masonry-entry-->

Cette fois-ci, nous testons si nous ne sommes pas sur un appareil mobile ou un téléphone et si c’est le cas, nous renvoyons la partie extrait de notre boucle. Si nous sommes sur un téléphone/appareil mobile, nous ne faisons rien.

Une autre chose que vous pourriez vouloir faire est d’augmenter la largeur des articles Masonry, ce qui réduit le nombre d’articles dans une ligne, sur les appareils mobiles. Afin de le faire, nous allons ajouter un style en ligne différent à l’en-tête en fonction de la détection de l’appareil. Comme cette fonction utilise wp_add_inline_styles, elle dépendra d’une feuille de style spécifique. Dans ce cas, j’utilise masonry.css, ce que vous pourriez vouloir, pour garder vos styles de masonry séparés. Si vous ne l’utilisez pas, vous pouvez utiliser la Poignée d’une autre feuille de style déjà inscrite.

if ( ! function_exists ( 'slug_masonry_styles' ) ) :
function slug_masonry_styles() {
    //set the wide width
    $wide = '25%';
    //set narrow width
    $narrow = '50%';
    /**Determine value for $width**/
    //if we can only set narrow for phones, else narrow for all mobile devices
    if (function_exists( 'is_phone') {
        if ( is_phone() ) {
            $width = $narrow;
        }
        else {
            $width = $wide;
        }        
    }
    else {
        if ( wp_is_mobile() ) {
            $width = $narrow;
        }
        else {
            $width = $wide;
        }
    }
    /**Output CSS for .masonry-entry with proper width**/
    $custom_css = ".masonry-entry{width: {$width};}";
    //You must use the handle of an already enqueued stylesheet here.
    wp_add_inline_style( 'masonry', $custom_css );
}
add_action( 'wp_enqueue_scripts', 'slug_masonry_styles' );
endif; // ! slug_masonry_styles exists

Cette fonction interroge la feuille de style personnalisée, puis définit une valeur pour la largeur en utilisant ce qui devrait maintenant être une logique très familière. Ensuite, nous créons la variable $custom_css en passant la valeur de la largeur dans un bout de CSS d’apparence normale avec {$width}. Ensuite, nous utilisons wp_add_inline_style pour dire à WordPress d’imprimer nos styles inline dans l’en-tête chaque fois que la feuille de style Masonry est utilisée, puis nous croisons toute la fonction avec wp_enqueue_scripts et nous avons terminé.

Si vous choisissez de combiner vos styles Masonry dans une feuille de style existante, assurez-vous d’utiliser la Poignée de cette feuille de style avec wp_add_inline_style ou vos styles inline ne seront pas inclus. J’aime utiliser wp_add_inline_style parce que je mets généralement le crochet d’action pour la mise en file d’attente de Masonry dans une conditionnelle afin qu’il soit ajouté uniquement lorsque c’est nécessaire. Par exemple, si j’utilise Masonry uniquement sur l’index de mon blog et les pages d’archives, je ferais ceci :

if ( is_home() || is_archive() ) {
    add_action( 'wp_enqueue_scripts', 'slug_scripts_masonry' );
}

Ces derniers exemples devraient faire germer d’autres idées dans votre cerveau. Par exemple, vous pourriez utiliser une logique similaire pour Aller à/au tout sur un appareil mobile. Par ailleurs, wp_add_inline_style() est une fonction moins utilisée, mais très utile, car elle vous permet de définir par programme différents styles basés sur n’importe quel type de conditionnel. Elle peut vous permettre de changer radicalement le style de n’importe quel élément en se basant uniquement sur la détection de l’appareil, mais les modifications pourraient également être basées sur le Modèle utilisé, ou même si l’utilisateur est connecté ou non.

J’espère que vous verrez ces différentes modifications que j’apporte comme une opportunité de faire preuve de créativité. La masonry et les systèmes de grille en cascade similaires sont populaires depuis un certain temps maintenant, il est donc temps d’apporter de nouvelles touches à cette idée populaire. Affichez dans les commentaires vos idées pour utiliser Masonry dans un thème WordPress.

Homme à tout faire de WordPress, Josh Pollock écrit sur WordPress, développe des thèmes, est le community manager du Pods Framework et défend les solutions open source pour un design durable.