Hur man använder Masonry för att add to Pinterest Style Post Grid i WordPress

Detta är ett gästinlägg av Josh Pollock

Den Pinterest-liknande grid-displayen av inlägg har varit en populär design för WordPress bloggindex pages ett tag. Det är populärt, eller ej, för att det efterliknar utseendet på den populära social media-webbplatsen, men också för att det gör bästa möjliga användning av utrymmet på vyn. På ett WordPress blogginlägg, allow each post preview to be the size it naturally needs to be, utan att lämna extra utrymme.

I denna tutorial kommer jag att visa dig hur du använder det populära JavaScript-biblioteket Masonry för att skapa cascading grid layouts för ditt blogg-index, samt archive pages för ditt theme. Jag kommer att ta upp några issues som du behöver tänka på för mobiloptimering och hur du löser dem.

Note: Detta är en tutorial på avancerad nivå för dig som känner dig bekväm med att editera WordPress themes och har tillräckliga kunskaper i HTML/CSS.

Step 1: Add Necessary Libraries To Your Theme (Lägg till nödvändiga bibliotek i ditt theme)

Update: WordPress 3.9 innehåller nu den senaste versionen av Masonry.

Först måste du hämta in Masonry i ditt theme med hjälp av denna kod:

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

Denna kod hämtar helt enkelt masonry och gör den tillgänglig för ditt temas template-filer (se vår guide om hur man korrekt lägger till JavaScripts och Styles i WordPress). Observera också att vi inte lägger till jQuery som ett beroende för någon av dem. En av fördelarna med Masonry 3 är att det inte är obligatoriskt med jQuery, men kan användas med det. Enligt min erfarenhet är initialisering av Masonry utan jQuery mer tillförlitlig och öppnar upp möjligheten att hoppa över att hämta jQuery, vilket kan hjälpa till med både sidans laddningstider och kompatibilitetsproblem.

Step-by-Step 2: Initialisera JavaScript

Nästa funktion ställer in Masonry, definierar de containers som ska användas med den och ser också till att allt sker i rätt order. Masonry måste göra beräkna storleken på vart och ett av objekten på sidan för att kunna layouta sitt grid dynamiskt. Ett problem som jag har sprungit in i med Masonry i många webbläsare är att Masonry kommer att beräkna höjden på objekt med långsamt hämtar images, vilket leder till överlappande objekt. Lösningen är att använda imagesLoaded för att förhindra Masonry från att beräkna layouten tills alla images har laddats. Detta säkerställer korrekt storlek.

Detta är den funktion och action som kommer att mata ut initialiseringsskriptet i sidfoten på 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

Funktionen förklaras steg för steg med inline comments. Vad JavaScript-funktionen gör är att berätta för Masonry att leta inuti en container med ID:n ”masonry-loop” efter objekt med klassen ”masonry-entry” och att beräkna grid endast efter att images har laddats. Vi ställer in den yttre containern med querySelector och den inre med itemSelector.

Step-by-Step 2: Skapa Masonry Loop

Istället för att lägga till HTML markup för Masonry direkt till en template kommer vi att skapa en separat template-del för den. Skapa en new fil som heter ”content-masonry.php” och add den till your theme. Detta kommer att allow you att add the Masonry loop till så många olika templates som you vill.

I din nya fil ska du add to koden som visas under. Markeringen liknar vad du normalt skulle se för en preview av content. Du kan ändra den hur du vill, se bara till att det yttersta elementet har klassen ”masonry-entry” som vi angav som itemSelector i det sista steget.

<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-->

Detta markup har klasser för var och en av dess delar så att you kan add markup för att matcha your theme. Jag gillar att lägga till en fin, något rundad kant till .masonry-entry. Ett annat trevligt alternativ är ingen kant för .masonry-entry, men att ge den en liten skugga. Det ser viss bra ut när inläggsminiatyren utökas hela vägen till kanten av containern, vilket kan åstadkommas genom att ge .masonry-thumbnail marginaler och paddings på 0 i alla riktningar. Du kommer att vilja add to all dessa stilar i en fil som heter masonry.css i ditt temas css directory.

Step 3: Add Masonry Loop till templates

Nu när vi har vår template-del kan du använda den i vilken template som helst i ditt theme som du gillar. Du kanske addar den till index.php, men ej category.php om du inte vill att den ska användas för kategori archives. Om du bara vill att den ska användas på ditt temas home page, när den är inställd på att visa blogginlägg, skulle du använda den i home.php. Oavsett var du väljer behöver du bara omsluta din loop i en container med id:et ”masonry-loop” och add to template-delen i loopen med hjälp av get_template_part(). Var noga med att starta Masonry loop container innan while (have_posts() ).

Här är till exempel huvudslingan från twentythirteen’s index.php:

<?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; ?>

Och här är den ändrad för att få använda vår Masonry loop:

<?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; ?>

Step 4: Ställ in responsiva bredder för objekt i Masonry

Det finns flera sätt som du kan ställa in bredden på varje Masonry-objekt. Du kan ställa in bredden med ett antal pixlar när du initialiserar Masonry. Jag är inte ett fan av att göra det eftersom jag använder responsiva teman och det kräver några komplexa mediefrågor för att få saker rätt på små skärmar. För responsiva designer har jag funnit det bästa att göra är att ställa in ett breddvärde för .masonry-entry med en procentsats, baserat på hur många objekt du vill ha i en row och låta Masonry göra resten av matematiken åt you.

Allt detta är obligatoriskt är att dela 100 med antalet objekt som du vill ställa in procentsatsen i en enkel post i ditt temas style.css. Om du till exempel vill ha fyra objekt i varje row kan du göra detta i din masonry.css-fil:

.masonry-entry{width:25%}

Step 5: Mobiloptimering

Vi skulle kunna sluta här, men jag tycker inte att slutresultatet fungerar särskilt bra på små telefonvyer. När du är nöjd med hur ditt theme ser ut med det new Masonry grid på din dator, kontrollera det på din telefon. Om du ej är nöjd med hur det ser ut på din telefon, då behöver du göra lite arbete.

Jag tror inte att det finns tillräckligt med utrymme på en telefons vy för allt vi har addat till vår content-masonry template-del. Två bra lösningar som är tillgängliga för dig är att förkorta excerptet för telefoner eller hoppa över det helt. Här är en extra funktion som du kan add to functions.php i ditt theme för att göra det. Eftersom jag inte tror att dessa issues är ett problem på surfplattor, använder jag ett bra plugin Mobble i alla exempel i detta avsnitt för att bara göra ändringarna på telefoner, eller ej surfplattor. Jag kontrollerar också om Mobble är aktivt innan jag använder det och vid behov faller jag tillbaka till den mer allmänna mobildetekteringsfunktionen wp_is_mobile som är inbyggd i 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

Som you can see we start by storing the long excerpt length and short excerpt length in variables, since we will be using those values twice and we want to be able to change them from one place if we need to later on. Därifrån testar vi om vi kan använda Mobbles is_phone(). Om så är fallet ställer vi in det korta excerptet för telefoner och det långa excerptet om vi inte är det. Efter det gör vi samma grundläggande sak, men använder wp_is_mobile, vilket kommer att påverka alla mobila enheter ,om is_phone() inte kan användas. Förhoppningsvis kommer else-delen av den här funktionen aldrig att användas, men det är bra att ha en backup för säkerhets skull. När logiken för excerpt-längd är inställd är det bara att åtgärds-hooka funktionen till excerpt_length-filtret.

Att förkorta excerptet är ett alternativ, men vi kan också ta bort det helt och hållet med en enkel process. Här är en new version av content masonry, med hela excerptet utelämnat på telefoner:

<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-->

Den här gången testar vi för att se om vi ej befinner oss på en telefon/mobil device och om så är fallet returnerar vi excerptet i vår loop. Om vi är på en telefon / mobil device gör vi ingenting.

En annan sak du kanske vill göra är att öka bredden på Masonry objekt, vilket minskar antalet i en row, på mobila enheter. För att göra detta kommer vi att lägga till en annan inline-stil i headern baserat på enhetsdetektering. Eftersom den här funktionen använder wp_add_inline_styles kommer den att vara beroende av en specifik formatmall. I det här fallet använder jag masonry.css, vilket du kanske vill, för att hålla dina masonry-stilar separerade. Om du inte vill använda den kan du använda handtaget från en annan, redan registrerad stylesheet.

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

Denna funktion eneuques den custom stylesheet, och sedan sätter ett värde för bredd med hjälp av vad som nu bör vara mycket bekant logik. Efter det skapar vi variabeln $custom_css genom att skicka värdet för bredd till en annars vanlig bit CSS med {$width}. Efter det använder vi wp_add_inline_style för att berätta för WordPress att skriva ut våra inline-stilar i Header när Masonry stylesheet används och sedan åtgärds-hookar vi hela funktionen till wp_enqueue_scripts och vi är klara.

Om du väljer att kombinera dina Masonry-stilar i en befintlig stylesheet, se till att använda handtaget för den stylesheet med wp_add_inline_style eller ej kommer dina inline-stilar inte att inkluderas. Jag gillar att använda wp_add_inline_style eftersom jag i allmänhet omsluter åtgärds-hooken för att köa Masonry i ett villkor så att den bara läggs till när det behövs. Till exempel om jag bara använder Masonry på min blogg index och archive pages skulle jag göra så här:

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

Dessa sista exempel bör öppna upp några andra idéer i din hjärna. Till exempel kan du använda liknande logik för att hoppa över Masonry helt och hållet på en mobil enhet. Även wp_add_inline_style() är en mindre använd, men ändå mycket användbar funktion eftersom den tillåter dig att programmatiskt ställa in olika stilar baserat på alla typer av villkor. Det kan allow you to radically change the style of any element based on not only device detection, but the changes could also be based on which template is being used, or even if the user is logged in or not.

Jag hoppas att you ser dessa olika förändringar som jag gör som en möjlighet att bli kreativ. Masonry och liknande cascading grid-system har varit populära ett tag nu, så det är dags för några new twists på denna populära idé. Visa oss i kommentarerna vilka coola sätt du har kommit på för att använda Masonry i ett WordPress theme.

Josh Pollock är en mångsidig WordPress-kille som skriver om WordPress, utvecklar teman, fungerar som community manager för Pods Framework och förespråkar lösningar med open source för hållbar design.