WordPress : récupération avancée des images d’un article

piouPiouM — Tue, 15 Sep 2009 00:11:27 +0000

De nombreux thèmes WordPress proposent, via un champ personnalisé, une gestion des miniatures à afficher sur la page d’accueil. Mais pourquoi contraindre ses rédacteurs à cette manipulation, qui, il faut le dire, est relativement lourde,surtout pour le néophyte¹. Le plus simple serait de recourir dans son thème à une fonction qui automatiserait la recherche de l’image à afficher en tant que thumbnail.

Évidemment, nous pouvons trouver au détour du web des fonctions au code douteux² qui vont se contenter de chercher la première image dans le contenu du billet.

Pourquoi ne pas étendre (et améliorer tant que nous y sommes =) ce type de fonction afin d’obtenir un outil de recherche d’images au sein d’un billet ? C’est ce que je vous propose ici.

Code source

Copiez le code qui suit dans le fichier functions.php de votre thème.

Télécharger wp-get_post_images.phps (1.62 Ko)

Fonctionnement

Petit retour sur ce code non commenté³, car, à la lecture aisée.

Recherche des images

La fonction get_post_images va effectuer une recherche d’image(s) dans les images jointes au billet cible si l’ordre de tri est différent à natural. En effet, cette option oblige à parser le contenu dans le sens de lecture de l’article, qui peut différer de l’ordre d’ajout des images dans sa bibliothèque de médias.
Notez que la recherche non naturelle prend directement en compte les ordres de tri.

Si la recherche échoue (ou si l’ordre de tri est défini à natural), le contenu du post est analysé. Seront considérées les images comportants une classe wp-image-(\d+). Si la recherche s’avère fructueuse, le tri est appliqué.

Finalement, get_post_images retournera le résultat de la recherche au format spécifié via le paramètre output. En cas d’échec, le booléen false est retourné.

Quid de la présentation ?

Le formatage et l’affichage des données est laissé à la discrétion du développeur. La présentation pourra ainsi évoluer indépendamment de la fonction.

Exemples d’utilisation

Récupérer les images triées par date (défaut)

Nous supposons ici que l’action se déroule dans la boucle puisque qu’aucun identifiant d’article n’a été fourni. Autrement, la valeur de retour sera FALSE.

 get_post_images(); ?>

Liste des images triées par date inverse

 get_post_images('order=DESC'); ?>

Liste des images triées par ordre d’arrivée dans le billet

 get_post_images('orderby=natural'); ?>

Récupération de la première image

 get_post_images('number=1'); ?>

Récupération de la première image (par contenu, forcé)

 get_post_images('number=1&orderby=natural'); ?>

Afficher la miniature de la première image d’un article

La fonction first_thumbnail qui suit affichera au format thumbnail la première image du billet ayant pour identifiant $post_id. Si ce dernier est omit, l’identifiant du billet en cours d’itération depuis la boucle sera utilisé.

/**
 * Display thumb of the first image from a post.
 *
 * @author Mehdi Kabab 
 * @copyright Copyright (C) 2009 Mehdi Kabab
 * @license http://www.gnu.org/licenses/gpl.html  GNU GPL version 3 or later
 *
 * @param  array $post_id Optional. Post ID.
 * @return bool False on failure.
 */
function first_thumbnail($post_id = null)
{
    $img = get_post_images("post_id=$post_id&number=1");
    if (false !== $img)
    {
        echo wp_get_attachment_link($img[0]->ID, 'thumbnail');
    }
    else
    {
        return false;
    }
}

Générer une miniature de la première image d’un article avec timthumb

La même fonction mais qui fait appel à timthumb pour générer une miniature aux dimensions arbitraires.

/**
 * Display a dynamic thumbnail of the first image from a post.
 *
 * The defaults are as follows:
 *     'post_id' - Default is null. Post ID.
 *     'h' - Default is null. Thumbnail height.
 *     'w' - Default is null. Thumbnail width.
 *     'q' - Default is null. Thumbnail quality.
 *     'zc' - Default is null. Zoom crop used for generates the thumbnail.
 *
 * @author Mehdi Kabab 
 * @copyright Copyright (C) 2009 Mehdi Kabab
 * @license http://www.gnu.org/licenses/gpl.html  GNU GPL version 3 or later
 *
 * @link http://code.google.com/p/timthumb/ Timthumb
 *
 * @param  array $args Optional. Overrides defaults.
 * @return bool False on failure.
 */
function first_thumbnail($args = array())
{
    $defaults = array(
        'post_id' => null,
        'h'  => null,
        'q'  => null,
        'w'  => null,
        'zc' => null,
    );
    $args    = wp_parse_args($args, $defaults);
    $post_id = $args['post_id'];
    $img     = get_post_images("post_id=$post_id&number=1");
    unset($args['post_id']);
 
    if (false !== $img)
    {
        $img = $img[0];
 
        if (null === $post_id)
        {
            if (in_the_loop())
            {
                global $post;
                $post_id = $post->ID;
            }
            else
            {
                if (isset($img->post_parent))
                {
                    $post_id = $img->post_parent;
                }
                else
                {
                    return false;
                }
            }
        }
        $query     = http_build_query($args, '', '&');
        $thumbnail = sprintf('',
            get_bloginfo('template_url', 'display') . '/timthumb.php', // customize timthumb url
            $img->guid,
            ($query) ? '&' . $query : '',
            (isset($args['w'])) ? " width=\"{$args['w']}\"" : '',
            (isset($args['h'])) ? " height=\"{$args['h']}\"" : ''
        );
 
        printf('%s',
            get_permalink($post_id),
            esc_attr(get_the_title($post_id)),
            $thumbnail
        );
    }
    else
    {
        return false;
    }
}

Ainsi, pour afficher une miniature de 260x120 pixels de la première image de l’article courant nous utiliserons :

 first_thumbnail('w=260&h=120'); ?>

Liste des paramètres

Voici la liste des paramètres acceptés par l’argument $args de la fonction get_post_images :

number
(integer) (optionnel) Le nombre maximal d’images à retourner. Par défaut à -1, retourne toutes les images.

order
(string) (optionnel) Ordre de tri. Les valeurs valides sont :

'ASC' - Croissant (du plus petit au plus grand). (Par défaut)
'DESC' - Décroissant (du plus grand au plus petit).

orderby
(string) (optionnel) Ordonner les images par l’une des valeurs qui suivent :

'date' - Trier selon la date de création. (Par Défaut)
'post_id' - Trier numériquement par l’ID des articles.
'natural' - Trier selon l’affichage des images dans le contenu de l’article.

output
(string) (optionnel) Le format de sortie.

OBJECT - Retourne un tableau d’objets instances de la classe stdClass. (Par défaut)
ARRAY_A - Retourne un tableau associatif (nom des champs => valeurs).
ARRAY_N - Retourne un tableau indexé numériquement de la valeur des champs.

post_id
(integer) (optionnel) L’identifiant de l’article à analyser. Par défaut à NULL, utilise celui du billet courant dans la boucle.

preserve_keys
(boolean) (optionnel) Préserver les clés retournées par l’API de WordPress, c.-à-d les identifiants des images. Par défaut à FALSE, le tableau résultat est indexé numériquement à partir de 0.

Historique des versions et changelog

1.0.0

Version initiale.

Continuez votre lecture sur des sujets similaires

uploader l’image, récupérer son URL relative donc en supprimer la racine du site, ajouter un champ personnalisé pour y renseigner l’URL précédemment copiée. ↩
franchement, que d’erreurs dans cette fonction qui a pourtant fait du bruit : la temporisation n’est d’aucune utilité, la globale $posts ne sert à rien, une Notice est générée lorsque l’article ne contient pas d’image, l’auteur de la fonction sait qu’il recherche 1 image alors pourquoi recourir à preg_match_all au lieu d’un simple preg_match ? C’est court donc c’est cool, c’est ça ? (‘o_o) ↩
vous pouvez me flageller ↩

piouPiouM's dev» Archives pour le tag recherche – piouPiouM's dev