get_body_class() WP 2.8.0

Отримує список класів css для тега body у вигляді масиву.

Для тега <body>, з допомогою функції body_class() , WordPress вказується набір класів, пр.: class="blog logged-in ...". Цей набір різний для кожної сторінки.

get_body_class() можна використовувати для нестандартних завдань, коли потрібно отримати стандартний набір класів та якось їх змінити. Для наочності подивіться код body_class() , він дуже простий і все що він робить збирає масив класів їх get_body_class() в рядок:

function body_class( $class = '' ) {
	echo 'class="' . join( ' ', get_body_class( $class ) ) . '"';
}

Конкретний список класів, що повертаються, дивіться в body_class() .

Основа для:
body_class()
1 раз – 0.000142 сек
(швидко) | 50000 разів – 2.53 сек
(швидко) |
PHP 7.0.2, WP 4.4.2

Хуки з функції
get_body_class($class);
$class
(рядок/масив)
Один або більше класів, які потрібно додати до списку класів.


За замовчуванням: ”

Приклади

Кожній сторінці надаються різні класи, залежно від типу сторінки. Які класи, на якій сторінці використовуються, дивіться в описі body_class() .

0

#1 Що функція повертає

$body_class = get_body_class();
print_r($body_class);

/*
Поверне:
Array
(
	[0] => page
	[1] => page-id-19
	[2] => page-template-default
	[3] => logged-in
)
*/
0

#2 Додамо свої класи

$body_class = get_body_class('my class');
print_r($body_class);

/*
Поверне:
Array
(
	[0] => page
	[1] => page-id-19
	[2] => page-template-default
	[3] => logged-in
	[4] => my
	[5] => class
)
*/
0

#3 Використання хукаbody_class

Припустимо, нам потрібно додати до класів, що виводяться через body_class() роль користувача. Точніше всі ролі, тому що у користувача їх може бути декілька:

add_filter('body_class', function( $classes ){
	if( is_user_logged_in() )
		$classes[] = implode(' ', wp_get_current_user()->roles );
	return $classes;
} );

body_class();
// Виведе: class="page page-id-19 page-template-default logged-in admin-bar no-customize-support administrator"
// Бачимо, що в кінці додалося "administrator"...

нотатки

  • Global. WP_Query. $wp_query WordPress Query object.

список змін

З версії 2.8.0Введено.

Код get_body_class() WP 6.0.2

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 List of CSS body class names for current post or page.
	 *
	 * @ Since 2.8.0
	 *
	 * @param string[] $classes На 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);
}

Залишити відповідь

Ваша e-mail адреса не оприлюднюватиметься. Обов’язкові поля позначені *