get_body_class( string|string[] $css_class = '' ): string[]

Parameters

$css_classstring|string[]optional

Space-separated string or array of class names to add to the class list. Default empty.Default: ''

Return

string[]

Array of class names.

Hooks fired · 1

One hook fires while get_body_class() runs, in this order:

1. 1
   apply_filters( body_class )filterline 859 (+223 into the body)

   Filters the list of CSS body class names for the current post or page.

Uses · 35

• is_rtl()Determines whether the current locale is right-to-left (RTL).
• is_front_page()Determines whether the query is for the front page of the site.
• is_home()Determines whether the query is for the blog homepage.
• is_privacy_policy()Determines whether the query is for the Privacy Policy page.
• is_archive()Determines whether the query is for an existing archive page.
• is_date()Determines whether the query is for an existing date archive.
• is_search()Determines whether the query is for a search.
• is_paged()Determines whether the query is for a paged result and not for the first page.
• is_attachment()Determines whether the query is for an existing attachment page.
• is_404()Determines whether the query has resulted in a 404 (returns no results).
• is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
• is_page_template()Determines whether the current post uses a page template.

Used by · 1

• body_class()Displays the class names for the body element.

Source

View on Trac ↗View on GitHub ↗

636function get_body_class( $css_class = '' ) {637	global $wp_query;638 639	$classes = array();640 641	if ( is_rtl() ) {642		$classes[] = 'rtl';643	}644 645	if ( is_front_page() ) {646		$classes[] = 'home';647	}648	if ( is_home() ) {649		$classes[] = 'blog';650	}651	if ( is_privacy_policy() ) {652		$classes[] = 'privacy-policy';653	}654	if ( is_archive() ) {655		$classes[] = 'archive';656	}657	if ( is_date() ) {658		$classes[] = 'date';659	}660	if ( is_search() ) {661		$classes[] = 'search';662		$classes[] = $wp_query->posts ? 'search-results' : 'search-no-results';663	}664	if ( is_paged() ) {665		$classes[] = 'paged';666	}667	if ( is_attachment() ) {668		$classes[] = 'attachment';669	}670	if ( is_404() ) {671		$classes[] = 'error404';672	}673 674	if ( is_singular() ) {675		$post      = $wp_query->get_queried_object();676		$post_id   = $post->ID;677		$post_type = $post->post_type;678 679		if ( is_page_template() ) {680			$classes[] = "{$post_type}-template";681 682			$template_slug  = get_page_template_slug( $post_id );683			$template_parts = explode( '/', $template_slug );684 685			foreach ( $template_parts as $part ) {686				$classes[] = "{$post_type}-template-" . sanitize_html_class( str_replace( array( '.', '/' ), '-', basename( $part, '.php' ) ) );687			}688			$classes[] = "{$post_type}-template-" . sanitize_html_class( str_replace( '.', '-', $template_slug ) );689		} else {690			$classes[] = "{$post_type}-template-default";691		}692 693		if ( is_single() ) {694			$classes[] = 'single';695			if ( isset( $post->post_type ) ) {696				$classes[] = 'single-' . sanitize_html_class( $post->post_type, $post_id );697				$classes[] = 'postid-' . $post_id;698 699				// Post Format.700				if ( post_type_supports( $post->post_type, 'post-formats' ) ) {701					$post_format = get_post_format( $post->ID );702 703					if ( $post_format && ! is_wp_error( $post_format ) ) {704						$classes[] = 'single-format-' . sanitize_html_class( $post_format );705					} else {706						$classes[] = 'single-format-standard';707					}708				}709			}710		}711 712		if ( is_attachment() ) {713			$mime_type   = get_post_mime_type( $post_id );714			$mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' );715			$classes[]   = 'attachmentid-' . $post_id;

History

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/post-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.