Custom_Background::handle_upload()
- Since
- 3.0.0
- Source
wp-admin/includes/class-custom-background.php:530
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::handle_upload() 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
- Heavy
- Scaling
- Constant
- Instructions
- 3–108
- Plugin surface
- 1 hook
- Called by
- 0
Reaches the database via get_post().
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 109.
Third-party callbacks on 'wp_create_file_in_uploads' run inside this call, and their cost is not bounded by anything here.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
get_option()called directly - hookthird-party callbacks
apply_filters()called directly - querycontent query
get_post()one call below Custom_Background::handle_upload() - cacheobject cache
wp_cache_get()one call below Custom_Background::handle_upload() - serializeserialisation
maybe_unserialize()one call below Custom_Background::handle_upload()
Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost Custom_Background::handle_upload() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($value) | 3 | none |
!empty($value) && wp_match_mime_types() && !isset($file) | 97 | check_admin_referer(), wp_check_filetype_and_ext(), wp_match_mime_types(), wp_handle_upload(), wp_basename(), wp_insert_attachment(), wp_generate_attachment_metadata(), wp_update_attachment_metadata(), get_option(), update_post_meta(), sanitize_url(), set_theme_mod(), wp_get_attachment_image_src(), sanitize_url(), set_theme_mod(), apply_filters() |
!empty($value) && wp_match_mime_types() && isset($file) | 102 | check_admin_referer(), wp_check_filetype_and_ext(), wp_match_mime_types(), wp_handle_upload(), wp_die(), wp_basename(), wp_insert_attachment(), wp_generate_attachment_metadata(), wp_update_attachment_metadata(), get_option(), update_post_meta(), sanitize_url(), set_theme_mod(), wp_get_attachment_image_src(), sanitize_url(), set_theme_mod(), apply_filters() |
!empty($value) && !wp_match_mime_types() && !isset($file) | 103 | check_admin_referer(), wp_check_filetype_and_ext(), wp_match_mime_types(), __(), wp_die(), wp_handle_upload(), wp_basename(), wp_insert_attachment(), wp_generate_attachment_metadata(), wp_update_attachment_metadata(), get_option(), update_post_meta(), sanitize_url(), set_theme_mod(), wp_get_attachment_image_src(), sanitize_url(), set_theme_mod(), apply_filters() |
!empty($value) && !wp_match_mime_types() && isset($file) | 108 | check_admin_referer(), wp_check_filetype_and_ext(), wp_match_mime_types(), __(), wp_die(), wp_handle_upload(), wp_die(), wp_basename(), wp_insert_attachment(), wp_generate_attachment_metadata(), wp_update_attachment_metadata(), get_option(), update_post_meta(), sanitize_url(), set_theme_mod(), wp_get_attachment_image_src(), sanitize_url(), set_theme_mod(), apply_filters() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 109 instructions, 3–108 executed per call, 3 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.
Hooks and filters fired · 1
One hook fires while Custom_Background::handle_upload() runs, in this order:
- apply_filters( wp_create_file_in_uploads )filterline 578 (+48 into the body)
Filters the attachment file path after the custom header or background image is set.
Uses · 16
- check_admin_referer()Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
- wp_check_filetype_and_ext()Attempts to determine the real file type of a file.
- wp_match_mime_types()Checks a MIME-Type against a list.
- wp_die()Kills WordPress execution and displays HTML page with an error message.
- __()Retrieves the translation of $text.
- wp_handle_upload()Wrapper for _wp_handle_upload().
- wp_basename()i18n-friendly version of basename().
- wp_insert_attachment()Inserts an attachment.
- wp_update_attachment_metadata()Updates metadata for an attachment.
- wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
- update_post_meta()Updates a post meta field based on the given post ID.
- get_option()Retrieves an option value based on an option name.
Show all 16
- set_theme_mod()Updates theme modification value for the active theme.
- sanitize_url()Sanitizes a URL for database or redirect usage.
- wp_get_attachment_image_src()Retrieves an image to represent an attachment.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Source code
public function handle_upload() { if ( empty( $_FILES ) ) { return; } check_admin_referer( 'custom-background-upload', '_wpnonce-custom-background-upload' ); $overrides = array( 'test_form' => false ); $uploaded_file = $_FILES['import']; $wp_filetype = wp_check_filetype_and_ext( $uploaded_file['tmp_name'], $uploaded_file['name'] ); if ( ! wp_match_mime_types( 'image', $wp_filetype['type'] ) ) { wp_die( __( 'The uploaded file is not a valid image. Please try again.' ) ); } $file = wp_handle_upload( $uploaded_file, $overrides ); if ( isset( $file['error'] ) ) { wp_die( $file['error'] ); } $url = $file['url']; $type = $file['type']; $file = $file['file']; $filename = wp_basename( $file ); // Construct the attachment array. $attachment = array( 'post_title' => $filename, 'post_content' => $url, 'post_mime_type' => $type, 'guid' => $url, 'context' => 'custom-background', ); // Save the data. $id = wp_insert_attachment( $attachment, $file ); // Add the metadata. wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $file ) ); update_post_meta( $id, '_wp_attachment_is_custom_background', get_option( 'stylesheet' ) ); set_theme_mod( 'background_image', sanitize_url( $url ) ); $thumbnail = wp_get_attachment_image_src( $id, 'thumbnail' ); set_theme_mod( 'background_image_thumb', sanitize_url( $thumbnail[0] ) ); /** This filter is documented in wp-admin/includes/class-custom-image-header.php */ $file = apply_filters( 'wp_create_file_in_uploads', $file, $id ); // For replication. $this->updated = true; }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.