get_body_class()

💡 云策文档标注

概述

get_body_class() 函数用于获取 body 元素的 CSS 类名数组，基于当前页面上下文自动生成类名，并支持通过参数添加自定义类名。函数返回经过过滤和去重的类名数组，适用于主题开发中的样式定制。

关键要点

函数返回一个字符串数组，包含基于页面类型、用户状态、主题特性等自动生成的 CSS 类名。
参数 $css_class 可选，接受字符串或数组形式的额外类名，会合并到返回数组中。
函数内部使用大量条件判断（如 is_front_page()、is_singular() 等）来动态添加类名，覆盖各种页面场景。
输出前会应用 body_class 过滤器，允许开发者修改类名列表。
类名经过 sanitize_html_class() 和 esc_attr() 处理，确保安全性。

代码示例

// 获取 body 类名数组
$body_classes = get_body_class();

// 添加自定义类名
$body_classes = get_body_class('custom-class another-class');

// 检查是否包含特定类名（如用户贡献笔记示例）
if (in_array('home', get_body_class())) {
    // 类名存在时的处理
} else {
    // 类名不存在时的处理
}

注意事项

函数依赖于全局 $wp_query 对象，确保在适当上下文中调用。
返回的类名已去重，但自定义类名需避免与自动生成的类名冲突。
使用 body_class 过滤器可灵活调整类名，适用于插件或子主题开发。

📄 原文内容

Retrieves an array of the class names for the body element.

Parameters

$css_classstring|string[]optional: Space-separated string or array of class names to add to the class list. Default empty.

Return

string[] Array of class names.

Source

function get_body_class( $css_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      = $wp_query->get_queried_object();
		$post_id   = $post->ID;
		$post_type = $post->post_type;

		$classes[] = 'wp-singular';

		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';
			$classes[] = 'page-id-' . $post_id;

			if ( get_pages(
				array(
					'parent' => $post_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;
		}
	}

	$classes[] = 'wp-theme-' . sanitize_html_class( get_template() );
	if ( is_child_theme() ) {
		$classes[] = 'wp-child-theme-' . sanitize_html_class( get_stylesheet() );
	}

	if ( ! empty( $css_class ) ) {
		if ( ! is_array( $css_class ) ) {
			$css_class = preg_split( '#s+#', $css_class );
		}
		$classes = array_merge( $classes, $css_class );
	} else {
		// Ensure that we always coerce class to being an array.
		$css_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[] $css_class An array of additional class names added to the body.
	 */
	$classes = apply_filters( 'body_class', $classes, $css_class );

	return array_unique( $classes );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘body_class’, string[] $classes, string[] $css_class ): Filters the list of CSS body class names for the current post or page.

Uses	Description
is_privacy_policy()`wp-includes/query.php`	Determines whether the query is for the Privacy Policy page.
has_custom_logo()`wp-includes/general-template.php`	Determines whether the site has a custom logo.
get_background_color()`wp-includes/theme.php`	Retrieves value for custom background color.
get_theme_support()`wp-includes/theme.php`	Gets the theme support arguments passed when registering that support.
get_background_image()`wp-includes/theme.php`	Retrieves background image for custom background.
get_template()`wp-includes/theme.php`	Retrieves name of the active theme.
is_child_theme()`wp-includes/theme.php`	Whether a child theme is in use.
get_stylesheet()`wp-includes/theme.php`	Retrieves name of the current stylesheet.
sanitize_html_class()`wp-includes/formatting.php`	Sanitizes an HTML classname to ensure it only contains valid characters.
WP_Query::get_queried_object()`wp-includes/class-wp-query.php`	Retrieves the currently queried object.
WP_Query::get()`wp-includes/class-wp-query.php`	Retrieves the value of a query variable.
is_search()`wp-includes/query.php`	Determines whether the query is for a search.
is_404()`wp-includes/query.php`	Determines whether the query has resulted in a 404 (returns no results).
is_singular()`wp-includes/query.php`	Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
is_single()`wp-includes/query.php`	Determines whether the query is for an existing single post.
is_front_page()`wp-includes/query.php`	Determines whether the query is for the front page of the site.
is_home()`wp-includes/query.php`	Determines whether the query is for the blog homepage.
is_date()`wp-includes/query.php`	Determines whether the query is for an existing date archive.
is_paged()`wp-includes/query.php`	Determines whether the query is for a paged result and not for the first page.
is_attachment()`wp-includes/query.php`	Determines whether the query is for an existing attachment page.
is_page()`wp-includes/query.php`	Determines whether the query is for an existing single page.
is_author()`wp-includes/query.php`	Determines whether the query is for an existing author archive page.
is_category()`wp-includes/query.php`	Determines whether the query is for an existing category archive page.
is_tag()`wp-includes/query.php`	Determines whether the query is for an existing tag archive page.
is_tax()`wp-includes/query.php`	Determines whether the query is for an existing custom taxonomy archive page.
is_archive()`wp-includes/query.php`	Determines whether the query is for an existing archive page.
is_post_type_archive()`wp-includes/query.php`	Determines whether the query is for an existing post type archive page.
get_query_var()`wp-includes/query.php`	Retrieves the value of a query variable in the WP_Query class.
is_rtl()`wp-includes/l10n.php`	Determines whether the current locale is right-to-left (RTL).
is_admin_bar_showing()`wp-includes/admin-bar.php`	Determines whether the admin bar should be showing.
is_page_template()`wp-includes/post-template.php`	Determines whether the current post uses a page template.
get_page_template_slug()`wp-includes/post-template.php`	Gets the specific template filename for a given post.
get_pages()`wp-includes/post.php`	Retrieves an array of pages (or hierarchical post type items).
post_type_supports()`wp-includes/post.php`	Checks a post type’s support for a given feature.
get_post_mime_type()`wp-includes/post.php`	Retrieves the mime type of an attachment based on the ID.
get_post_format()`wp-includes/post-formats.php`	Retrieve the format slug for a post
current_theme_supports()`wp-includes/theme.php`	Checks a theme’s support for a given feature.
is_user_logged_in()`wp-includes/pluggable.php`	Determines whether the current visitor is a logged in user.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
is_wp_error()`wp-includes/load.php`	Checks whether the given variable is a WordPress Error.

Show 35 more Show less

Used by	Description
body_class()`wp-includes/post-template.php`	Displays the class names for the body element.

Changelog

Version	Description
2.8.0	Introduced.

User Contributed Notes

Skip to note 2 content

Fida Al Hasan

4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
```
// If has "home" class in the body
if (in_array('home', get_body_class())) {
    // Class is present
} else {
    // Class is not present
}
```
Log in to add feedback

云策 WordPress 开发者社区

函数文档

get_body_class()

概述

关键要点

代码示例

注意事项

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes

函数文档

概述

关键要点

代码示例

注意事项

Parameters

Return

Source

Hooks

Related

Changelog

User Contributed Notes