Custom_Image_Header::insert_attachment( array $object, string $cropped )
Insert an attachment and its metadata.
Parameters
- $object
-
(array) (Required) Attachment object.
- $cropped
-
(string) (Required) File path to cropped image.
Return
(int) Attachment ID.
Source
File: wp-admin/includes/class-custom-image-header.php
final public function insert_attachment( $object, $cropped ) { $parent_id = isset( $object['post_parent'] ) ? $object['post_parent'] : null; unset( $object['post_parent'] ); $attachment_id = wp_insert_attachment( $object, $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
Version | Description |
---|---|
3.9.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/custom_image_header/insert_attachment