is_post_type_archive( string|string[] $post_types = '' )

Détermine si la requête est pour une page d'archive de type de poste personnalisé.

Paramètre

$post_types(string|string[])optionnel

Type de poste ou tableau de types de poste à vérifier.

Valeur par défaut : ''

Description / Informations supplémentaires

Pour plus d'informations sur cette fonction ou d'autres similaires, voir l'article Conditional Tags sur le Manuel du développeur de thème.

Retourne

(bool) True si la requête est pour une page d'archive de type de poste existante.

Déclaration et structure de la fonction is_post_type_archive()

function is_post_type_archive( $post_types = '' ) {
    global $wp_query;

    if ( ! isset( $wp_query ) ) {
        _doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
        return false;
    }

    return $wp_query->is_post_type_archive( $post_types );
}
__()

Retourne la traduction d'un texte.

_doing_it_wrong()

Marque quelque chose comme étant incorrectement appelée.

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

Exemples

Si la page actuelle est une archive de type de poste personnalisé, afficher le titre de cette archive :
if ( is_post_type_archive() ) {
    echo '<h1>'.post_type_archive_title().'</h1>';
}
Modifier la requête pour la page d'archive de type de poste personnalisé :
function my_function( $query ){
    if ( is_post_type_archive( 'my_custom_post_type' ) ) {
         // Code ici ...
    }
}
add_action( 'pre_get_posts', 'my_function' );

Sources

Codex WordPress : is_post_type_archive()

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

Retour