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

Parameters

$attachmentint|WP_Post

Attachment ID or object.

Return

array|void

Array of attachment details, or void 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.

Hooks fired · 3

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

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

   Filters the names and labels of the default image sizes.

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

   Filters whether to preempt the output of image_downsize().

3. 3
   apply_filters( wp_prepare_attachment_for_js )filterline 4793 (+252 into the body)

   Filters the attachment data prepared for JavaScript.

Uses · 29

• 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.
• 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.
• get_bloginfo()Retrieves information about the current site.

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

View on Trac ↗View on GitHub ↗

4541function wp_prepare_attachment_for_js( $attachment ) {4542	$attachment = get_post( $attachment );4543 4544	if ( ! $attachment ) {4545		return;4546	}4547 4548	if ( 'attachment' !== $attachment->post_type ) {4549		return;4550	}4551 4552	$meta = wp_get_attachment_metadata( $attachment->ID );4553	if ( str_contains( $attachment->post_mime_type, '/' ) ) {4554		list( $type, $subtype ) = explode( '/', $attachment->post_mime_type );4555	} else {4556		list( $type, $subtype ) = array( $attachment->post_mime_type, '' );4557	}4558 4559	$attachment_url = wp_get_attachment_url( $attachment->ID );4560	$base_url       = str_replace( wp_basename( $attachment_url ), '', $attachment_url );4561 4562	$response = array(4563		'id'            => $attachment->ID,4564		'title'         => $attachment->post_title,4565		'filename'      => wp_basename( get_attached_file( $attachment->ID ) ),4566		'url'           => $attachment_url,4567		'link'          => get_attachment_link( $attachment->ID ),4568		'alt'           => get_post_meta( $attachment->ID, '_wp_attachment_image_alt', true ),4569		'author'        => $attachment->post_author,4570		'description'   => $attachment->post_content,4571		'caption'       => $attachment->post_excerpt,4572		'name'          => $attachment->post_name,4573		'status'        => $attachment->post_status,4574		'uploadedTo'    => $attachment->post_parent,4575		'date'          => strtotime( $attachment->post_date_gmt ) * 1000,4576		'modified'      => strtotime( $attachment->post_modified_gmt ) * 1000,4577		'menuOrder'     => $attachment->menu_order,4578		'mime'          => $attachment->post_mime_type,4579		'type'          => $type,4580		'subtype'       => $subtype,4581		'icon'          => wp_mime_type_icon( $attachment->ID, '.svg' ),4582		'dateFormatted' => mysql2date( __( 'F j, Y' ), $attachment->post_date ),4583		'nonces'        => array(4584			'update' => false,4585			'delete' => false,4586			'edit'   => false,4587		),4588		'editLink'      => false,4589		'meta'          => false,4590	);4591 4592	$author = new WP_User( $attachment->post_author );4593 4594	if ( $author->exists() ) {4595		$author_name            = $author->display_name ? $author->display_name : $author->nickname;4596		$response['authorName'] = html_entity_decode( $author_name, ENT_QUOTES, get_bloginfo( 'charset' ) );4597		$response['authorLink'] = get_edit_user_link( $author->ID );4598	} else {4599		$response['authorName'] = __( '(no author)' );4600	}4601 4602	if ( $attachment->post_parent ) {4603		$post_parent = get_post( $attachment->post_parent );4604		if ( $post_parent && current_user_can( 'read_post', $attachment->post_parent ) ) {4605			$response['uploadedToTitle'] = $post_parent->post_title ? $post_parent->post_title : __( '(no title)' );4606			$response['uploadedToLink']  = get_edit_post_link( $attachment->post_parent, 'raw' );4607		}4608	}4609 4610	$attached_file = get_attached_file( $attachment->ID );4611 4612	if ( isset( $meta['filesize'] ) ) {4613		$bytes = $meta['filesize'];4614	} elseif ( file_exists( $attached_file ) ) {4615		$bytes = wp_filesize( $attached_file );4616	} else {4617		$bytes = '';4618	}4619 4620	if ( $bytes ) {

History

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.0.4 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.