wp_attachment_is( string $type, int|WP_Post $post = null )

Verifies an attachment is of a given type.


Description Description


Parameters Parameters

$type

(string) (Required) Attachment type. Accepts 'image', 'audio', or 'video'.

$post

(int|WP_Post) (Optional) Attachment ID or object. Default is global $post.

Default value: null


Top ↑

Return Return

(bool) True if one of the accepted types, false otherwise.


Top ↑

Source Source

File: wp-includes/post.php

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 ( 0 === strpos( $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' );
			return in_array( $ext, $image_exts );

		case 'audio':
			return in_array( $ext, wp_get_audio_extensions() );

		case 'video':
			return in_array( $ext, wp_get_video_extensions() );

		default:
			return $type === $ext;
	}
}

Top ↑

Changelog Changelog

Changelog
Version Description
4.2.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.