wp_prepare_attachment_for_js( int|WP_Post $attachment ): array|null

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$attachmentint|WP_Post

Attachment ID or object.

Return value

array|null

Array of attachment details, or null if the parameter does not correspond to an attachment.

• $altstring

  Alt text of the attachment.

• $authorstring

  ID of the attachment author, as a string.

• $authorNamestring

  Name of the attachment author.

• $captionstring

  Caption for the attachment.

• $compatarray

  Containing item and meta.

• $contextstring

  Context, whether it's used as the site icon for example.

• $dateint

  Uploaded date, timestamp in milliseconds.

• $dateFormattedstring

  Formatted date (e.g. June 29, 2018).

• $descriptionstring

  Description of the attachment.

• $editLinkstring

  URL to the edit page for the attachment.

• $filenamestring

  File name of the attachment.

• $filesizeHumanReadablestring

  Filesize of the attachment in human readable format (e.g. 1 MB).

• $filesizeInBytesint

  Filesize of the attachment in bytes.

• $heightint

  If the attachment is an image, represents the height of the image in pixels.

• $iconstring

  Icon URL of the attachment (e.g. /wp-includes/images/media/archive.png).

• $idint

  ID of the attachment.

• $linkstring

  URL to the attachment.

• $menuOrderint

  Menu order of the attachment post.

• $metaarray

  Meta data for the attachment.

• $mimestring

  Mime type of the attachment (e.g. image/jpeg or application/zip).

• $modifiedint

  Last modified, timestamp in milliseconds.

• $namestring

  Name, same as title of the attachment.

• $noncesarray

  Nonces for update, delete and edit.

• $orientationstring

  If the attachment is an image, represents the image orientation (landscape or portrait).

• $sizesarray

  If the attachment is an image, contains an array of arrays for the images sizes: thumbnail, medium, large, and full.

• $statusstring

  Post status of the attachment (usually 'inherit').

• $subtypestring

  Mime subtype of the attachment (usually the last part, e.g. jpeg or zip).

• $titlestring

  Title of the attachment (usually slugified file name without the extension).

• $typestring

  Type of the attachment (usually first part of the mime type, e.g. image).

• $uploadedToint

  Parent post to which the attachment was uploaded.

• $uploadedToLinkstring

  URL to the edit page of the parent post of the attachment.

• $uploadedToTitlestring

  Post title of the parent of the attachment.

• $urlstring

  Direct URL to the attachment file (from wp-content).

• $widthint

  If the attachment is an image, represents the width of the image in pixels.

Performance profile

How much work a call to wp_prepare_attachment_for_js() 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

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

190–325

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 675.

Plugin surface

3 hooks

Third-party callbacks on 'image_size_names_choose', 'image_downsize', 'wp_prepare_attachment_for_js' run inside this call, and their cost is not bounded by anything here.

Called by

7

7 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below wp_prepare_attachment_for_js()
• cacheobject cachewp_cache_get()one call below wp_prepare_attachment_for_js()

Further down the call graph this can also reach 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 · 48 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_prepare_attachment_for_js() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 3

3 hooks fire while wp_prepare_attachment_for_js() runs, in this order:

1. 1
   apply_filters( image_size_names_choose )filterline 4749 (+101 into the body)

   Filters the names and labels of the default image sizes.

2. 2
   apply_filters( image_downsize )filterline 4769 (+121 into the body)

   Filters whether to preempt the output of image_downsize().

3. 3
   apply_filters( wp_prepare_attachment_for_js )filterline 4904 (+256 into the body)

   Filters the attachment data prepared for JavaScript.

Uses · 30

• get_post()Retrieves post data given a post ID or post object.
• wp_get_attachment_metadata()Retrieves attachment metadata for attachment ID.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• wp_basename()i18n-friendly version of basename().
• get_attached_file()Retrieves attached file path based on attachment ID.
• esc_url_raw()Sanitizes a URL for database or redirect usage.
• get_attachment_link()Retrieves the permalink for an attachment.
• get_post_meta()Retrieves a post meta field for the given post ID.
• wp_mime_type_icon()Retrieves the icon for a MIME type or attachment.
• mysql2date()Converts given MySQL date string into a different format.
• __()Retrieves the translation of $text.

Used by · 7

• WP_Customize_Media_Control::to_json()Refresh the parameters passed to the JavaScript via JSON.
• WP_Customize_Upload_Control::to_json()Refresh the parameters passed to the JavaScript via JSON.
• wp_ajax_crop_image()Handles cropping an image via AJAX.
• wp_ajax_get_attachment()Handles getting an attachment via AJAX.
• wp_ajax_media_create_image_subsizes()Handles creating missing image sub-sizes for just uploaded images via AJAX.
• wp_ajax_save_attachment_compat()Handles saving backward compatible attachment attributes via AJAX.
• wp_ajax_upload_attachment()Handles uploading attachments via AJAX.

Source code

View on Trac ↗View on GitHub ↗

4648function wp_prepare_attachment_for_js( $attachment ) {4649	$attachment = get_post( $attachment );4650 4651	if ( ! $attachment ) {4652		return null;4653	}4654 4655	if ( 'attachment' !== $attachment->post_type ) {4656		return null;4657	}4658 4659	$meta = wp_get_attachment_metadata( $attachment->ID );4660	if ( str_contains( $attachment->post_mime_type, '/' ) ) {4661		list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );4662	} else {4663		list( $type, $subtype ) = array( $attachment->post_mime_type, '' );4664	}4665 4666	$attachment_url = wp_get_attachment_url( $attachment->ID );4667	$base_url       = str_replace( wp_basename( $attachment_url ), '', $attachment_url );4668 4669	$response = array(4670		'id'            => $attachment->ID,4671		'title'         => $attachment->post_title,4672		'filename'      => wp_basename( get_attached_file( $attachment->ID ) ),4673		'url'           => esc_url_raw( $attachment_url ),4674		'link'          => get_attachment_link( $attachment->ID ),4675		'alt'           => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ),4676		'author'        => $attachment->post_author,4677		'description'   => $attachment->post_content,4678		'caption'       => $attachment->post_excerpt,4679		'name'          => $attachment->post_name,4680		'status'        => $attachment->post_status,4681		'uploadedTo'    => $attachment->post_parent,4682		'date'          => strtotime( $attachment->post_date_gmt ) * 1000,4683		'modified'      => strtotime( $attachment->post_modified_gmt ) * 1000,4684		'menuOrder'     => $attachment->menu_order,4685		'mime'          => $attachment->post_mime_type,4686		'type'          => $type,4687		'subtype'       => $subtype,4688		'icon'          => wp_mime_type_icon( $attachment->ID, '.svg' ),4689		'dateFormatted' => mysql2date( __( 'F j, Y' ), $attachment->post_date ),4690		'nonces'        => array(4691			'update' => false,4692			'delete' => false,4693			'edit'   => false,4694		),4695		'editLink'      => false,4696		'meta'          => false,4697	);4698 4699	$author = new WP_User( $attachment->post_author );4700 4701	if ( $author->exists() ) {4702		$author_name            = $author->display_name ? $author->display_name : $author->nickname;4703		$response['authorName'] = html_entity_decode( $author_name, ENT_QUOTES, get_bloginfo( 'charset' ) );4704		$response['authorLink'] = get_edit_user_link( $author->ID );4705	} else {4706		$response['authorName'] = __( '(no author)' );4707	}4708 4709	if ( $attachment->post_parent ) {4710		$post_parent = get_post( $attachment->post_parent );4711		if ( $post_parent && current_user_can( 'read_post', $attachment->post_parent ) ) {4712			$response['uploadedToTitle'] = $post_parent->post_title ? $post_parent->post_title : __( '(no title)' );4713			$response['uploadedToLink']  = get_edit_post_link( $attachment->post_parent, 'raw' );4714		}4715	}4716 4717	$attached_file = get_attached_file( $attachment->ID );4718 4719	if ( isset( $meta['filesize'] ) && is_numeric( $meta['filesize'] ) && (int) $meta['filesize'] > 0 ) {4720		$bytes = (int) $meta['filesize'];4721	} elseif ( is_string( $attached_file ) && '' !== $attached_file && is_readable( $attached_file ) ) {4722		$bytes = wp_filesize( $attached_file );4723	} else {4724		$bytes = '';4725	}4726 4727	if ( $bytes ) {

Changelog

Introduced in 3.5.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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-includes/media.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.