wppaste
WordPress

twentyseventeen_is_view_with_layout_option()

Source
wp-content/themes/twentyseventeen/inc/customizer.php:240
Returns whether we're on a view that supports a one or two column layout.

Compatibility

WordPress
core
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.

Performance profile

How much work a call to twentyseventeen_is_view_with_layout_option() 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
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

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

Instructions
4–11

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

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

  • hookthird-party callbacksapply_filters()one call below twentyseventeen_is_view_with_layout_option()

Further down the call graph this can also reach option, cache, serialize, query and transient. Those are 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 twentyseventeen_is_view_with_layout_option() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
is_page()4is_page()
!is_page() && !is_archive()7is_page(), is_archive()
!is_page() && is_archive()11is_page(), is_archive(), is_active_sidebar()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 11 instructions, 4–11 executed per call, 2 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 · 3

  • is_page()Determines whether the query is for an existing single page.
  • is_archive()Determines whether the query is for an existing archive page.
  • is_active_sidebar()Determines whether a sidebar contains widgets.

Source code

View on Trac View on GitHub 

function twentyseventeen_is_view_with_layout_option() {	// This option is available on all pages. It's also available on archives when there isn't a sidebar.	return ( is_page() || ( is_archive() && ! is_active_sidebar( 'sidebar-1' ) ) );}

Changelog

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/twentyseventeen/inc/customizer.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.