Twenty_Twenty_One_Dark_Mode::the_html( array $attrs = array() ): void
- Since
- Twenty Twenty-One 1.0
- Source
wp-content/themes/twentytwentyone/classes/class-twenty-twenty-one-dark-mode.php:310
Description
Inspired from https://codepen.io/aaroniker/pen/KGpXZo (MIT-licensed)
Compatibility
- WordPress
- since Twenty Twenty-One 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
$attrsarrayoptional- The attributes to add to our element.Default:
array()
Return value
void
Performance profile
How much work a call to Twenty_Twenty_One_Dark_Mode::the_html() 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
- Light
- Scaling
- Scales with input
- Instructions
- 41–46
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 60.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()one call below Twenty_Twenty_One_Dark_Mode::the_html()
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 · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Twenty_Twenty_One_Dark_Mode::the_html() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_admin() | 41–43 | wp_parse_args(), esc_html__(), printf(), is_rtl(), esc_attr_e(), esc_attr_e(), is_admin() |
!is_admin() | 43–46 | wp_parse_args(), esc_html__(), printf(), is_rtl(), esc_attr_e(), esc_attr_e(), is_admin(), wp_is_json_request() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 60 instructions, 41–46 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 · 7
- wp_parse_args()Merges user defined arguments into defaults array.
- esc_attr()Escaping for HTML attributes.
- esc_html__()Retrieves the translation of $text and escapes it for safe use in HTML output.
- is_rtl()Determines whether the current locale is right-to-left (RTL).
- esc_attr_e()Displays translated text that has been escaped for safe use in an attribute.
- is_admin()Determines whether the current request is for an administrative interface page.
- wp_is_json_request()Checks whether current request is a JSON request, or is expecting a JSON response.
Used by · 2
- Twenty_Twenty_One_Dark_Mode::customizer_controls()Registers customizer options.
- Twenty_Twenty_One_Dark_Mode::the_switch()Adds night/day switch.
Source code
public function the_html( $attrs = array() ) { $attrs = wp_parse_args( $attrs, array( 'id' => 'dark-mode-toggler', 'class' => 'fixed-bottom', 'aria-pressed' => 'false', 'onClick' => 'toggleDarkMode()', ) ); echo '<button'; foreach ( $attrs as $key => $val ) { echo ' ' . esc_attr( $key ) . '="' . esc_attr( $val ) . '"'; } echo '>'; printf( /* translators: %s: On/Off */ esc_html__( 'Dark Mode: %s', 'twentytwentyone' ), '<span aria-hidden="true"></span>' ); echo '</button>'; ?> <style> #dark-mode-toggler > span { margin-<?php echo is_rtl() ? 'right' : 'left'; ?>: 5px; } #dark-mode-toggler > span::before { content: '<?php esc_attr_e( 'Off', 'twentytwentyone' ); ?>'; } #dark-mode-toggler[aria-pressed="true"] > span::before { content: '<?php esc_attr_e( 'On', 'twentytwentyone' ); ?>'; } <?php if ( is_admin() || wp_is_json_request() ) : ?> .components-editor-notices__pinned ~ .edit-post-visual-editor #dark-mode-toggler { z-index: 20; } .is-dark-theme.is-dark-theme #dark-mode-toggler:not(:hover):not(:focus) { color: var(--global--color-primary); } @media only screen and (max-width: 782px) { #dark-mode-toggler { margin-top: 32px; } } <?php endif; ?> </style> <?php }Changelog
Introduced in Twenty Twenty-One 1.0. Unchanged from 6.7.7 through 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/twentytwentyone/classes/class-twenty-twenty-one-dark-mode.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.