Langues : Anglais – 関数リファレンス/get the excerpt 日本語 (Ajoutez votre langue)

Description

Retourne l’extrait du message. Il s’agit soit d’un extrait fourni par l’utilisateur, qui est retourné inchangé, soit d’une version rognée et comptée en mots du contenu complet du post, générée automatiquement.

Les extraits générés automatiquement ont tous les shortcodes et les balises supprimés, ce qui signifie qu’il s’agit juste d’une chaîne non formatée qui ne verrait aucun saut de ligne dans toute forme de sortie, puisque les sauts de ligne réels dans le texte brut sont également supprimés.

Lorsqu’il est appelé par the_excerpt(), cela implique que les extraits auto-gen sont juste du texte brut avec des balises <p></p> enroulées autour, en gros.

Les extraits auto-gen ont une balise « more » qui leur est ajoutée. Cette balise est  » par défaut. Elle peut être modifiée par le filtre excerpt_more.

La longueur des mots par défaut est de 55 mots. Elle peut être modifiée par le filtre excerpt_length.

Usage

<?php $excerpt = get_the_excerpt( int|WP_Post $post ) ?>

Cette fonction doit être utilisée dans The Loop lorsqu’aucun paramètre $post ou ID n’est passé.

Si cette fonction est utilisée en dehors de The Loop et que le post n’a pas d’extrait personnalisé, cette fonction utilisera wp_trim_excerpt() pour générer un extrait. Cette fonction utilise get_the_content(), qui doit être utilisé avec The Loop et qui causera des problèmes si get_the_excerpt() est utilisé en dehors de The Loop. Afin d’éviter ces problèmes, utilisez setup_postdata() avant d’appeler get_the_excerpt() pour configurer l’objet global $post.

Paramètres

$post (integer|WP_Post) (facultatif) ID du post ou objet WP_Post. La valeur par défaut est globale $post. Défaut : null

Valeurs de retour

• Renvoie un extrait existant inchangé (par défaut) mais lui applique les filtres get_the_excerpt.
• Renvoie une version élaguée du contenu complet du post comme décrit, en lui appliquant en plus les filtres wp_trim_excerpt. ‘wp_trim_excerpt’ est enchaîné de ‘get_the_excerpt’, ce qui signifie que votre propre filtre get_the_excerpt sera appelé avant ou après le rognage en fonction de la priorité de votre filtre. S’il est appelé avant, votre paramètre $text sera une chaîne vide s’il n’y a pas d’extrait fourni par l’utilisateur, alors qu’il sera la version rognée de l’article complet s’il est appelé après. Dans ce dernier cas, il pourrait être utile ou plus significatif d’utiliser ‘wp_trim_excerpt’ puisqu’il a un deuxième paramètre vous donnant l’entrée non rognée à la fonction wp_trim_excerpt, ce qui signifie que ce deuxième paramètre est simplement le $post->post_excerpt brut.
• Pour les pages protégées par mot de passe, il renvoie une chaîne de caractères, qui a une valeur par défaut de « Il n’y a pas d’extrait parce que c’est un post protégé. » Ce texte peut être modifié dans la définition de la fonction.

Exemples

get_the_excerpt() peut être utilisé pour récupérer et stocker la valeur dans une variable, sans la sortir sur la page.

<?php$my_excerpt = get_the_excerpt();if ( '' != $my_excerpt ) {// Some string manipulation performed}echo $my_excerpt; // Outputs the processed value to the page?>

Utilisez get_the_excerpt() pour imprimer un extrait en spécifiant un nombre maximal de caractères.

<?phpthe_excerpt_max_charlength(140);function the_excerpt_max_charlength($charlength) {$excerpt = get_the_excerpt();$charlength++;if ( mb_strlen( $excerpt ) > $charlength ) {$subex = mb_substr( $excerpt, 0, $charlength - 5 );$exwords = explode( ' ', $subex );$excut = - ( mb_strlen( $exwords ) );if ( $excut < 0 ) {echo mb_substr( $subex, 0, $excut );} else {echo $subex;}echo '';} else {echo $excerpt;}}?>

Journal des changements

Depuis : 0.71