is_attachment( int|string|int[]|string[] $attachment = '' )

Determines whether the query is for an existing attachment page.


Description

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.


Top ↑

Parameters

$attachment

(int|string|int[]|string[]) (Optional) Attachment ID, title, slug, or array of such to check against.

Default value: ''


Top ↑

Return

(bool) Whether the query is for an existing attachment page.


Top ↑

More Information


Top ↑

Source

File: wp-includes/query.php

function is_attachment( $attachment = '' ) {
	global $wp_query;

	if ( ! isset( $wp_query ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'Conditional query tags do not work before the query is run. Before then, they always return false.' ), '3.1.0' );
		return false;
	}

	return $wp_query->is_attachment( $attachment );
}


Top ↑

Changelog

Changelog
Version Description
2.0.0 Introduced.

Top ↑

User Contributed Notes

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