wppaste
WordPress

twentythirteen_body_class( array $classes ): array

Since
Twenty Thirteen 1.0
Source
wp-content/themes/twentythirteen/functions.php:781
Extends the default WordPress body classes.

Description

Adds body classes to denote:

  1. Single or multiple authors.
  2. Active widgets in the sidebar to change the layout and spacing.
  3. When avatars are disabled in discussion settings.

Compatibility

WordPress
since Twenty Thirteen 1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$classesarray
A list of existing body class values.

Return value

array
The filtered body class list.

Performance profile

How much work a call to twentythirteen_body_class() 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
13–25

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

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 twentythirteen_body_class()
  • hookthird-party callbacksapply_filters()one call below twentythirteen_body_class()
  • cacheobject cachewp_cache_get()one call below twentythirteen_body_class()
  • serializeserialisationmaybe_unserialize()one call below twentythirteen_body_class()

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 · 3 distinct outcomes

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

WhenInstructionsCalls it makes
!is_active_sidebar()13–17is_multi_author(), is_active_sidebar(), get_option()
is_active_sidebar() && is_attachment()16–20is_multi_author(), is_active_sidebar(), is_attachment(), get_option()
is_active_sidebar() && !is_attachment()19–25is_multi_author(), is_active_sidebar(), is_attachment(), is_404(), get_option()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 25 instructions, 13–25 executed per call, 5 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 5

  • is_multi_author()Determines whether this site has more than one author.
  • is_active_sidebar()Determines whether a sidebar contains widgets.
  • 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).
  • get_option()Retrieves an option value based on an option name.

Source code

View on Trac View on GitHub 

function twentythirteen_body_class( $classes ) {	if ( ! is_multi_author() ) {		$classes[] = 'single-author';	} 	if ( is_active_sidebar( 'sidebar-2' ) && ! is_attachment() && ! is_404() ) {		$classes[] = 'sidebar';	} 	if ( ! get_option( 'show_avatars' ) ) {		$classes[] = 'no-avatars';	} 	return $classes;}

Changelog

Introduced in Twenty Thirteen 1.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 7.1.0 tag, from src/wp-content/themes/twentythirteen/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.