wp_attachment_is( string $type, int|WP_Post $post = null ): bool
- Since
- 4.2.0
- Source
wp-includes/post.php:7332
Compatibility
- WordPress
- since 4.2.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
$typestring- Attachment type. Accepts
image,audio,video, or a file extension. $postint|WP_Postoptional- Attachment ID or object. Default is global $post.Default:
null
Return value
bool- True if an accepted type or a matching file extension, false otherwise.
Performance profile
How much work a call to wp_attachment_is() 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
- 8–40
- Plugin surface
- None
- Called by
- 13
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 56.
Nothing here hands control to plugin code.
13 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_attachment_is()
Further down the call graph this can also reach cache, serialize, option 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 · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_attachment_is() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 8 | get_post() |
| always | 15–19 | get_post(), get_attached_file() |
| always | 25–38 | get_post(), get_attached_file(), wp_check_filetype() |
!empty($check) | 34–38 | get_post(), get_attached_file(), wp_check_filetype(), wp_get_audio_extensions() |
!empty($check) | 34–40 | get_post(), get_attached_file(), wp_check_filetype(), wp_get_video_extensions() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 56 | 8–40 | 9 | |
| 8.5 | 56 | 8–40 | 9 | |
| 8.4 | 56 | 8–40 | 9 | 9 fewer instructions than PHP 8.3 |
| 8.3 | 65 | 8–46 | 9 | |
| 8.2 | 65 | 8–46 | 9 | 1 more instruction than PHP 8.1 |
| 8.1 | 64 | 8–46 | 9 | 1 fewer instruction than PHP 7.4 |
| 7.4 | 65 | 8–47 | 9 |
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.
- get_attached_file()Retrieves attached file path based on attachment ID.
- str_starts_with()Polyfill for `str_starts_with()` function added in PHP 8.0.
- wp_check_filetype()Retrieves the file type from the file name.
- wp_get_audio_extensions()Returns a filtered list of supported audio formats.
- wp_get_video_extensions()Returns a filtered list of supported video formats.
Used by · 13
- WP_REST_Attachments_Controller::handle_featured_media()Determines the featured media based on a request param.
- WP_REST_Attachments_Controller::sideload_item()Side-loads a media file without creating a new attachment.
- WP_Widget_Media::is_attachment_with_mime_type()Determine if the supplied attachment is for a valid attachment post with the specified MIME type.
- edit_form_image_editor()Displays the image and editor in the post editor
- get_oembed_response_data_rich()Filters the oEmbed response data to return an iframe embed code.
- prepend_attachment()Wraps attachment in paragraph tag before content.
- register_and_do_post_meta_boxes()Registers the default post meta boxes, and runs the `do_meta_boxes` actions.
- wp_ajax_save_attachment()Handles updating attachment attributes via AJAX.
- wp_ajax_send_attachment_to_editor()Handles sending an attachment to the editor via AJAX.
- wp_attachment_is_image()Determines whether an attachment is an image.
- wp_enqueue_media()Enqueues all scripts, styles, settings, and templates necessary to use all media JS APIs.
- wp_generate_attachment_metadata()Generates attachment meta data and create image sub-sizes for images.
Show all 13
- wp_insert_post()Inserts or updates a post in the database.
Source code
function wp_attachment_is( $type, $post = null ) { $post = get_post( $post ); if ( ! $post ) { return false; } $file = get_attached_file( $post->ID ); if ( ! $file ) { return false; } if ( str_starts_with( $post->post_mime_type, $type . '/' ) ) { return true; } $check = wp_check_filetype( $file ); if ( empty( $check['ext'] ) ) { return false; } $ext = $check['ext']; if ( 'import' !== $post->post_mime_type ) { return $type === $ext; } switch ( $type ) { case 'image': $image_exts = array( 'jpg', 'jpeg', 'jpe', 'gif', 'png', 'webp', 'avif', 'heic' ); return in_array( $ext, $image_exts, true ); case 'audio': return in_array( $ext, wp_get_audio_extensions(), true ); case 'video': return in_array( $ext, wp_get_video_extensions(), true ); default: return $type === $ext; }}Changelog
Introduced in 4.2.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-includes/post.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.