wp_copy_parent_attachment_properties( string $cropped, int $parent_attachment_id, string $context = '' ): array
- Since
- 6.5.0
- Source
wp-admin/includes/image.php:522
Compatibility
- WordPress
- since 6.5.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
$croppedstring- Path to the cropped image file.
$parent_attachment_idint- Parent file Attachment ID.
$contextstringoptional- Control calling the function.Default:
''
Return value
array- Properties of attachment.
Performance profile
How much work a call to wp_copy_parent_attachment_properties() 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
- 68–90
- Plugin surface
- None
- Called by
- 3
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 94.
Nothing here hands control to plugin code.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_post()called directly - hookthird-party callbacks
apply_filters()one call below wp_copy_parent_attachment_properties()
Further down the call graph this can also reach cache, option, 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 · 8 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_copy_parent_attachment_properties() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 68–75 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name() |
| always | 70–77 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name(), wp_basename() |
$parent_basename !== false | 75–80 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name(), pathinfo() |
| always | 76–83 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name(), wp_slash() |
$parent_basename !== false | 77–82 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name(), pathinfo(), wp_basename() |
| always | 78–85 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name(), wp_basename(), wp_slash() |
$parent_basename !== false | 83–88 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name(), pathinfo(), wp_slash() |
$parent_basename !== false | 85–90 | get_post(), wp_get_attachment_url(), wp_basename(), wp_basename(), wp_basename(), wp_getimagesize(), sanitize_file_name(), pathinfo(), wp_basename(), wp_slash() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 93 | 68–89 | 7 | 1 fewer instruction than PHP 8.5 |
| 8.5 | 94 | 68–90 | 7 | |
| 8.4 | 94 | 68–90 | 7 | 12 fewer instructions than PHP 8.3 |
| 8.3 | 106 | 80–102 | 7 | |
| 8.2 | 106 | 80–102 | 7 | |
| 8.1 | 106 | 80–102 | 7 | 3 fewer instructions than PHP 7.4 |
| 7.4 | 109 | 81–104 | 7 |
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 · 6
- get_post()Retrieves post data given a post ID or post object.
- wp_get_attachment_url()Retrieves the URL for an attachment.
- wp_basename()i18n-friendly version of basename().
- wp_getimagesize()Allows PHP's getimagesize() to be debuggable when necessary.
- sanitize_file_name()Sanitizes a filename, replacing whitespace with dashes.
- wp_slash()Adds slashes to a string or recursively adds slashes to strings within an array.
Used by · 3
- 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.
- wp_ajax_crop_image()Handles cropping an image via AJAX.
Source code
function wp_copy_parent_attachment_properties( $cropped, $parent_attachment_id, $context = '' ) { $parent = get_post( $parent_attachment_id ); $parent_url = wp_get_attachment_url( $parent->ID ); $parent_basename = wp_basename( $parent_url ); $url = str_replace( wp_basename( $parent_url ), wp_basename( $cropped ), $parent_url ); $size = wp_getimagesize( $cropped ); $image_type = $size ? $size['mime'] : 'image/jpeg'; $sanitized_post_title = sanitize_file_name( $parent->post_title ); $use_original_title = ( ( '' !== trim( $parent->post_title ) ) && /* * Check if the original image has a title other than the "filename" default, * meaning the image had a title when originally uploaded or its title was edited. */ ( $parent_basename !== $sanitized_post_title ) && ( pathinfo( $parent_basename, PATHINFO_FILENAME ) !== $sanitized_post_title ) ); $use_original_description = ( '' !== trim( $parent->post_content ) ); $attachment = array( 'post_title' => $use_original_title ? $parent->post_title : wp_basename( $cropped ), 'post_content' => $use_original_description ? $parent->post_content : $url, 'post_mime_type' => $image_type, 'guid' => $url, 'context' => $context, ); // Copy the image caption attribute (post_excerpt field) from the original image. if ( '' !== trim( $parent->post_excerpt ) ) { $attachment['post_excerpt'] = $parent->post_excerpt; } // Copy the image alt text attribute from the original image. if ( '' !== trim( $parent->_wp_attachment_image_alt ) ) { $attachment['meta_input'] = array( '_wp_attachment_image_alt' => wp_slash( $parent->_wp_attachment_image_alt ), ); } $attachment['post_parent'] = $parent_attachment_id; return $attachment;}Changelog
Introduced in 6.5.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-admin/includes/image.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.