Custom_Background::take_action()
- Since
- 3.0.0
- Source
wp-admin/includes/class-custom-background.php:124
Executes custom background modification.
Compatibility
- WordPress
- since 3.0.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.
Performance profile
How much work a call to Custom_Background::take_action() 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
- Scaling
- Constant
- Instructions
- 3–127
- Plugin surface
- None
- Called by
- 0
Reads stored settings via get_option(), cached per request but not free on a cold cache.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 170.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()one call below Custom_Background::take_action() - optionoption read or write
get_option()one call below Custom_Background::take_action()
Further down the call graph this can also reach 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 · 18 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Custom_Background::take_action() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 3–29 | none |
!empty($value) && isset($value) | 18 | check_admin_referer(), remove_theme_mod(), remove_theme_mod() |
!empty($value) | 29 | check_admin_referer(), set_theme_mod(), set_theme_mod(), wp_safe_redirect() |
!empty($value) | 40–47 | check_admin_referer(), set_theme_mod() |
!empty($value) | 51–61 | check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 55–57 | check_admin_referer(), explode(), set_theme_mod(), set_theme_mod() |
!empty($value) | 63–75 | check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 66–75 | check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 67–71 | check_admin_referer(), set_theme_mod(), check_admin_referer(), explode(), set_theme_mod(), set_theme_mod() |
!empty($value) | 75–87 | check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 77–89 | check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 78–89 | check_admin_referer(), set_theme_mod(), check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
6 further outcomes, up to 127 instructions
!empty($value) | 89–101 | check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 89–103 | check_admin_referer(), set_theme_mod(), check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 90–99 | check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 101–115 | check_admin_referer(), set_theme_mod(), check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 104–113 | check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
!empty($value) | 116–127 | check_admin_referer(), set_theme_mod(), check_admin_referer(), explode(), set_theme_mod(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod(), check_admin_referer(), set_theme_mod() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 170 | 3–127 | 17 | |
| 8.5 | 170 | 3–127 | 17 | |
| 8.4 | 170 | 3–127 | 17 | 4 fewer instructions than PHP 8.3 |
| 8.3 | 174 | 3–131 | 17 | |
| 8.2 | 174 | 3–131 | 17 | |
| 8.1 | 174 | 3–131 | 17 | |
| 7.4 | 174 | 3–131 | 17 |
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 · 4
- check_admin_referer()Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
- remove_theme_mod()Removes theme modification name from active theme list.
- set_theme_mod()Updates theme modification value for the active theme.
- wp_safe_redirect()Performs a safe (local) redirect, using wp_redirect().
Source code
public function take_action() { if ( empty( $_POST ) ) { return; } if ( isset( $_POST['reset-background'] ) ) { check_admin_referer( 'custom-background-reset', '_wpnonce-custom-background-reset' ); remove_theme_mod( 'background_image' ); remove_theme_mod( 'background_image_thumb' ); $this->updated = true; return; } if ( isset( $_POST['remove-background'] ) ) { // @todo Uploaded files are not removed here. check_admin_referer( 'custom-background-remove', '_wpnonce-custom-background-remove' ); set_theme_mod( 'background_image', '' ); set_theme_mod( 'background_image_thumb', '' ); $this->updated = true; wp_safe_redirect( $_POST['_wp_http_referer'] ); return; } if ( isset( $_POST['background-preset'] ) ) { check_admin_referer( 'custom-background' ); if ( in_array( $_POST['background-preset'], array( 'default', 'fill', 'fit', 'repeat', 'custom' ), true ) ) { $preset = $_POST['background-preset']; } else { $preset = 'default'; } set_theme_mod( 'background_preset', $preset ); } if ( isset( $_POST['background-position'] ) ) { check_admin_referer( 'custom-background' ); $position = explode( ' ', $_POST['background-position'] ); if ( in_array( $position[0], array( 'left', 'center', 'right' ), true ) ) { $position_x = $position[0]; } else { $position_x = 'left'; } if ( in_array( $position[1], array( 'top', 'center', 'bottom' ), true ) ) { $position_y = $position[1]; } else { $position_y = 'top'; } set_theme_mod( 'background_position_x', $position_x ); set_theme_mod( 'background_position_y', $position_y ); } if ( isset( $_POST['background-size'] ) ) { check_admin_referer( 'custom-background' ); if ( in_array( $_POST['background-size'], array( 'auto', 'contain', 'cover' ), true ) ) { $size = $_POST['background-size']; } else { $size = 'auto'; } set_theme_mod( 'background_size', $size ); } if ( isset( $_POST['background-repeat'] ) ) { check_admin_referer( 'custom-background' ); $repeat = $_POST['background-repeat']; if ( 'no-repeat' !== $repeat ) { $repeat = 'repeat'; }Changelog
Introduced in 3.0.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 6.8.8 tag, from
src/wp-admin/includes/class-custom-background.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.