twentyseventeen_body_classes( array $classes ): string[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$classesarray

Classes for the body element.

Return value

string[]

Filtered body classes with theme-specific additions.

Performance profile

How much work a call to twentyseventeen_body_classes() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

42–72

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 74.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• optionoption read or writeget_option()called directly
• transienttransientget_transient()one call below twentyseventeen_body_classes()
• hookthird-party callbacksapply_filters()one call below twentyseventeen_body_classes()
• cacheobject cachewp_cache_get()one call below twentyseventeen_body_classes()
• serializeserialisationmaybe_unserialize()one call below twentyseventeen_body_classes()

Further down the call graph this can also reach query. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 12 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost twentyseventeen_body_classes() can have, taken from its control-flow graph on PHP 8.5.

Uses · 12

• is_multi_author()Determines whether this site has more than one author.
• is_singular()Determines whether the query is for an existing single post of any post type (post, attachment, page, custom post types).
• is_customize_preview()Whether the site is being previewed in the Customizer.
• is_front_page()Determines whether the query is for the front page of the site.
• get_option()Retrieves an option value based on an option name.
• has_header_image()Checks whether a header image is set or not.
• is_active_sidebar()Determines whether a sidebar contains widgets.
• is_page()Determines whether the query is for an existing single page.
• is_archive()Determines whether the query is for an existing archive page.
• get_theme_mod()Retrieves theme modification value for the active theme.
• get_header_textcolor()Retrieves the custom header text color in 3- or 6-digit hexadecimal form.
• twentyseventeen_sanitize_colorscheme()Sanitizes the colorscheme.

Source code

View on Trac ↗View on GitHub ↗

16function twentyseventeen_body_classes( $classes ) {17	// Add class of group-blog to blogs with more than 1 published author.18	if ( is_multi_author() ) {19		$classes[] = 'group-blog';20	}21 22	// Add class of hfeed to non-singular pages.23	if ( ! is_singular() ) {24		$classes[] = 'hfeed';25	}26 27	// Add class if we're viewing the Customizer for easier styling of theme options.28	if ( is_customize_preview() ) {29		$classes[] = 'twentyseventeen-customizer';30	}31 32	// Add class on front page.33	if ( is_front_page() && 'posts' !== get_option( 'show_on_front' ) ) {34		$classes[] = 'twentyseventeen-front-page';35	}36 37	// Add a class if there is a custom header.38	if ( has_header_image() ) {39		$classes[] = 'has-header-image';40	}41 42	// Add class if sidebar is used.43	if ( is_active_sidebar( 'sidebar-1' ) && ! is_page() ) {44		$classes[] = 'has-sidebar';45	}46 47	// Add class for one or two column page layouts.48	if ( is_page() || is_archive() ) {49		if ( 'one-column' === get_theme_mod( 'page_layout' ) ) {50			$classes[] = 'page-one-column';51		} else {52			$classes[] = 'page-two-column';53		}54	}55 56	// Add class if the site title and tagline is hidden.57	if ( 'blank' === get_header_textcolor() ) {58		$classes[] = 'title-tagline-hidden';59	}60 61	// Get the colorscheme or the default if there isn't one.62	$colors    = twentyseventeen_sanitize_colorscheme( get_theme_mod( 'colorscheme', 'light' ) );63	$classes[] = 'colors-' . $colors;64 65	return $classes;66}

Changelog

One change between 6.7.7 and 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 7.1.0 tag, from src/wp-content/themes/twentyseventeen/inc/template-functions.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.