Custom_Image_Header::insert_attachment( array $attachment, string $cropped ): int
- Since
- 3.9.0
- Source
wp-admin/includes/class-custom-image-header.php:1353
Compatibility
- WordPress
- since 3.9.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
$attachmentarray- An array with attachment object data.
$croppedstring- File path to cropped image.
Return value
int- Attachment ID.
Performance profile
How much work a call to Custom_Image_Header::insert_attachment() 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
- 28–31
- Plugin surface
- 1 hook
- Called by
- 2
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 32.
Third-party callbacks on 'wp_header_image_attachment_metadata' run inside this call, and their cost is not bounded by anything here.
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()called directly - querycontent query
get_post()one call below Custom_Image_Header::insert_attachment()
Further down the call graph this can also reach option, cache, serialize 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 · 1 distinct outcome
One number would be a lie: the work depends on which branch runs. These are every distinct cost Custom_Image_Header::insert_attachment() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 28–31 | wp_insert_attachment(), wp_generate_attachment_metadata(), apply_filters(), wp_update_attachment_metadata() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 32 | 28–31 | 2 | |
| 8.5 | 32 | 28–31 | 2 | |
| 8.4 | 32 | 28–31 | 2 | |
| 8.3 | 32 | 28–31 | 2 | |
| 8.2 | 32 | 28–31 | 2 | |
| 8.1 | 32 | 28–31 | 2 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 33 | 28–32 | 2 |
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_Image_Header::insert_attachment() runs, in this order:
- apply_filters( wp_header_image_attachment_metadata )filterline 1374 (+21 into the body)
Filters the header image attachment metadata.
Uses · 4
- wp_insert_attachment()Inserts an attachment.
- wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- wp_update_attachment_metadata()Updates metadata for an attachment.
Used by · 2
- Custom_Image_Header::ajax_header_crop()Gets attachment uploaded by Media Manager, crops it, then saves it as a new object. Returns JSON-encoded object details.
- Custom_Image_Header::step_3()Displays third step of custom header image page.
Source code
final public function insert_attachment( $attachment, $cropped ) { $parent_id = isset( $attachment['post_parent'] ) ? $attachment['post_parent'] : null; unset( $attachment['post_parent'] ); $attachment_id = wp_insert_attachment( $attachment, $cropped ); $metadata = wp_generate_attachment_metadata( $attachment_id, $cropped ); // If this is a crop, save the original attachment ID as metadata. if ( $parent_id ) { $metadata['attachment_parent'] = $parent_id; } /** * Filters the header image attachment metadata. * * @since 3.9.0 * * @see wp_generate_attachment_metadata() * * @param array $metadata Attachment metadata. */ $metadata = apply_filters( 'wp_header_image_attachment_metadata', $metadata ); wp_update_attachment_metadata( $attachment_id, $metadata ); return $attachment_id; }Changelog
Introduced in 3.9.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-image-header.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.