get_body_class( string $class = '' )
Récupère un tableau de classes CSS pour la balise HTML body.
Paramètre
$class(string) (Optionnel) Une chaîne de classes CSS séparées par des espaces ou un tableau de classes à ajouter à la liste par défaut.
Valeur par défaut : ''
Retourne
(array) Un tableau de noms de classe
Structure de la fonction get_body_class()
Définie dans le fichier wp-includes/post-template.php à la ligne 608 :
function get_body_class( $class = '' ) {
global $wp_query;
$classes = array();
if ( is_rtl() ) {
$classes[] = 'rtl';
}
if ( is_front_page() ) {
$classes[] = 'home';
}
if ( is_home() ) {
$classes[] = 'blog';
}
if ( is_privacy_policy() ) {
$classes[] = 'privacy-policy';
}
if ( is_archive() ) {
$classes[] = 'archive';
}
if ( is_date() ) {
$classes[] = 'date';
}
if ( is_search() ) {
$classes[] = 'search';
$classes[] = $wp_query->posts ? 'search-results' : 'search-no-results';
}
if ( is_paged() ) {
$classes[] = 'paged';
}
if ( is_attachment() ) {
$classes[] = 'attachment';
}
if ( is_404() ) {
$classes[] = 'error404';
}
if ( is_singular() ) {
$post_id = $wp_query->get_queried_object_id();
$post = $wp_query->get_queried_object();
$post_type = $post->post_type;
if ( is_page_template() ) {
$classes[] = "{$post_type}-template";
$template_slug = get_page_template_slug( $post_id );
$template_parts = explode( '/', $template_slug );
foreach ( $template_parts as $part ) {
$classes[] = "{$post_type}-template-" . sanitize_html_class( str_replace( array( '.', '/' ), '-', basename( $part, '.php' ) ) );
}
$classes[] = "{$post_type}-template-" . sanitize_html_class( str_replace( '.', '-', $template_slug ) );
} else {
$classes[] = "{$post_type}-template-default";
}
if ( is_single() ) {
$classes[] = 'single';
if ( isset( $post->post_type ) ) {
$classes[] = 'single-' . sanitize_html_class( $post->post_type, $post_id );
$classes[] = 'postid-' . $post_id;
// Post Format.
if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
$post_format = get_post_format( $post->ID );
if ( $post_format && ! is_wp_error( $post_format ) ) {
$classes[] = 'single-format-' . sanitize_html_class( $post_format );
} else {
$classes[] = 'single-format-standard';
}
}
}
}
if ( is_attachment() ) {
$mime_type = get_post_mime_type( $post_id );
$mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' );
$classes[] = 'attachmentid-' . $post_id;
$classes[] = 'attachment-' . str_replace( $mime_prefix, '', $mime_type );
} elseif ( is_page() ) {
$classes[] = 'page';
$page_id = $wp_query->get_queried_object_id();
$post = get_post( $page_id );
$classes[] = 'page-id-' . $page_id;
if ( get_pages(
array(
'parent' => $page_id,
'number' => 1,
)
) ) {
$classes[] = 'page-parent';
}
if ( $post->post_parent ) {
$classes[] = 'page-child';
$classes[] = 'parent-pageid-' . $post->post_parent;
}
}
} elseif ( is_archive() ) {
if ( is_post_type_archive() ) {
$classes[] = 'post-type-archive';
$post_type = get_query_var( 'post_type' );
if ( is_array( $post_type ) ) {
$post_type = reset( $post_type );
}
$classes[] = 'post-type-archive-' . sanitize_html_class( $post_type );
} elseif ( is_author() ) {
$author = $wp_query->get_queried_object();
$classes[] = 'author';
if ( isset( $author->user_nicename ) ) {
$classes[] = 'author-' . sanitize_html_class( $author->user_nicename, $author->ID );
$classes[] = 'author-' . $author->ID;
}
} elseif ( is_category() ) {
$cat = $wp_query->get_queried_object();
$classes[] = 'category';
if ( isset( $cat->term_id ) ) {
$cat_class = sanitize_html_class( $cat->slug, $cat->term_id );
if ( is_numeric( $cat_class ) || ! trim( $cat_class, '-' ) ) {
$cat_class = $cat->term_id;
}
$classes[] = 'category-' . $cat_class;
$classes[] = 'category-' . $cat->term_id;
}
} elseif ( is_tag() ) {
$tag = $wp_query->get_queried_object();
$classes[] = 'tag';
if ( isset( $tag->term_id ) ) {
$tag_class = sanitize_html_class( $tag->slug, $tag->term_id );
if ( is_numeric( $tag_class ) || ! trim( $tag_class, '-' ) ) {
$tag_class = $tag->term_id;
}
$classes[] = 'tag-' . $tag_class;
$classes[] = 'tag-' . $tag->term_id;
}
} elseif ( is_tax() ) {
$term = $wp_query->get_queried_object();
if ( isset( $term->term_id ) ) {
$term_class = sanitize_html_class( $term->slug, $term->term_id );
if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) {
$term_class = $term->term_id;
}
$classes[] = 'tax-' . sanitize_html_class( $term->taxonomy );
$classes[] = 'term-' . $term_class;
$classes[] = 'term-' . $term->term_id;
}
}
}
if ( is_user_logged_in() ) {
$classes[] = 'logged-in';
}
if ( is_admin_bar_showing() ) {
$classes[] = 'admin-bar';
$classes[] = 'no-customize-support';
}
if ( current_theme_supports( 'custom-background' )
&& ( get_background_color() !== get_theme_support( 'custom-background', 'default-color' ) || get_background_image() ) ) {
$classes[] = 'custom-background';
}
if ( has_custom_logo() ) {
$classes[] = 'wp-custom-logo';
}
if ( current_theme_supports( 'responsive-embeds' ) ) {
$classes[] = 'wp-embed-responsive';
}
$page = $wp_query->get( 'page' );
if ( ! $page || $page < 2 ) {
$page = $wp_query->get( 'paged' );
}
if ( $page && $page > 1 && ! is_404() ) {
$classes[] = 'paged-' . $page;
if ( is_single() ) {
$classes[] = 'single-paged-' . $page;
} elseif ( is_page() ) {
$classes[] = 'page-paged-' . $page;
} elseif ( is_category() ) {
$classes[] = 'category-paged-' . $page;
} elseif ( is_tag() ) {
$classes[] = 'tag-paged-' . $page;
} elseif ( is_date() ) {
$classes[] = 'date-paged-' . $page;
} elseif ( is_author() ) {
$classes[] = 'author-paged-' . $page;
} elseif ( is_search() ) {
$classes[] = 'search-paged-' . $page;
} elseif ( is_post_type_archive() ) {
$classes[] = 'post-type-paged-' . $page;
}
}
if ( ! empty( $class ) ) {
if ( ! is_array( $class ) ) {
$class = preg_split( '#\s+#', $class );
}
$classes = array_merge( $classes, $class );
} else {
// Ensure that we always coerce class to being an array.
$class = array();
}
$classes = array_map( 'esc_attr', $classes );
/**
* Filters the list of CSS body class names for the current post or page.
*
* @since 2.8.0
*
* @param string[] $classes An array of body class names.
* @param string[] $class An array of additional class names added to the body.
*/
$classes = apply_filters( 'body_class', $classes, $class );
return array_unique( $classes );
}
Fonctions et Hook utilisés par get_body_class()
is_privacy_policy()Détermine si la requête est pour une page de politique de confidentialité.
has_custom_logo()Détermine si le site a un logo personnalisé.
current_theme_supports()Vérifie si un support de thème existe pour un réglage donné.
get_background_color()Retourne la valeur d'une couleur de fond personnalisée.
get_theme_support()Obtient les arguments du support de thème passés à l'enregistrement de ce support.
get_background_image()Retourne l'image d'un fond personnalisé.
sanitize_html_class()Nettoie une classe css pour s'assurer que les caractères soient valides pour l'attribut class en HTML.
is_user_logged_in()Détermine si le visiteur actuel est connecté.
is_search()Détermine si la requête est pour une recherche.
is_404()Détermine si la requête résulte d'une erreur 404 (aucuns résultats).
is_singular()Détermine si la requête est pour un poste unique existant de n'importe quel type de poste (poste, attachement, page, types de poste personnalisés).
is_single()Détermine si la requête est pour un poste unique existant.
is_front_page()Détermine si la requête est pour la page d'accueil du site.
is_home()Détermine si la requête est pour la page d'accueil du home (homepage).
is_date()Détermine si la requête est pour une archive de date existante.
is_paged()Détermine si la requête est pour un résultat paginé et non pour la première page.
is_attachment()Détermine si la requête est pour une page d'attachement existante.
is_page()Détermine si la requête est pour une page unique existante.
is_author()Détermine si la requête est pour une page d'archive d'auteur existante.
is_category()Détermine si la requête est pour une page d'archive de catégorie existante.
is_tag()Détermine si la requête est pour une page d'archive d'étiquettes.
is_tax()Détermine si la requête est pour une page d'archive d'une taxonomie personnalisée existante.
is_archive()Détermine si la requête est pour une page d'archive existante.
is_post_type_archive()Détermine si la requête est pour une page d'archive de type de poste personnalisé.
get_query_var()Retourne la valeur d'une variable de requête dans la class
WP_Query.is_rtl()Détermine si la locale actuelle est right-to-left (RTL).
is_admin_bar_showing()Détermine si la barre d'administration doit être montrée.
apply_filters()Appel les fonctions qui ont été attaché à un filtre (hook).
is_page_template()Détermine si la page actuelle est un modèle de page (template).
get_page_template_slug()Obtient le nom de fichier d'un modèle de page pour un poste donné.
body_classFiltre la liste des classes CSS de la balise HTML body pour la page ou le poste actuel.
get_pages()Retourne un tableau de pages (ou de types de postes hiérarchiques).
post_type_supports()Vérifie si un type de poste est doté d'un support donné.
get_post_mime_type()Retourne le type mime d'un attachement avec son id.
get_post()Retourne les données d'un poste en passant l'id ou l'objet d'un poste.
get_post_format()Retourne le slug du format d'un poste donné.
is_wp_error()Vérifie si la variable est une erreur WordPress.
Où trouver la fonction get_body_class()
dans le CMS Wordpress
Sources
Codex Wordpress : get_body_class()
Autres fonctions dans le même fichier : wp-includes/post-template.php