get_post_format( int|WP_Post $post = null )

Retourne le slug du format d'un poste donné.

Paramètre

$post(int|WP_Post)optionnel

Id ou objet du poste.

Valeur par défaut : null

Description / Informations supplémentaires

Cette fonction est habituellement utilisée dans une boucle mais peut être utilisée si l'id d'un poste est fourni.

Les formats définis nativement sont :

  • 'aside'
  • 'chat'
  • 'gallery'
  • 'link'
  • 'image'
  • 'quote'
  • 'status'
  • 'video'
  • 'audio'

On peut aussi noter que le format par défaut retourne false, mais il y est fait référence à plusieurs endroits comme le format 'standard'. Dans plusieurs cas on peut rajouter ce bout de code pour maintenir une certaine cohérence :


$format = get_post_format() ? : 'standard';

Retourne

(string|false) Slug du format s'il existe pour le poste, false sinon.

Déclaration et structure de la fonction get_post_format()

function get_post_format( $post = null ) {
    $post = get_post( $post );

    if ( ! $post ) {
        return false;
    }

    if ( ! post_type_supports( $post->post_type, 'post-formats' ) ) {
        return false;
    }

    $_format = get_the_terms( $post->ID, 'post_format' );

    if ( empty( $_format ) ) {
        return false;
    }

    $format = reset( $_format );

    return str_replace( 'post-format-', '', $format->slug );
}
get_the_terms()

Retourne les termes d'une taxonomie attachés à un poste.

post_type_supports()

Vérifie si un type de poste est doté d'un support donné.

get_post()

Retourne les données d'un poste en passant l'id ou l'objet d'un poste.

Où est utilisée la fonction get_post_format() dans le CMS WordPress

Exemple

Utilisation dans un modèle de page :
get_template_part( 'format', get_post_format() );

Sources

Codex WordPress : get_post_format()

Autres fonctions dans le même fichier : wp-includes/post-formats.php

Retour