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

Determines whether the query is for an existing attachment page.

Description
Parameters
Return
More Information
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes

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: ''

Top ↑

Return

bool Whether the query is for an existing attachment page.

Top ↑

More Information

See Also: is_singular()
For more specific checking of the attachment see: wp_attachment_is_image()

Top ↑

Source

File: wp-includes/query.php. View all references

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 );
}

View on Trac View on GitHub

Top ↑

Uses

Uses
Uses	Description
WP_Query::is_attachment() wp-includes/class-wp-query.php	Is the query for an existing attachment page?
__() wp-includes/l10n.php	Retrieves the translation of $text.
_doing_it_wrong() wp-includes/functions.php	Marks something as being incorrectly called.

Show 1 more use Hide more uses

Top ↑

Used By

Used By
Used By	Description
wp_embed_excerpt_attachment() wp-includes/embed.php	Filters the post excerpt for the embed template.
get_adjacent_post_link() wp-includes/link-template.php	Retrieves the adjacent post link.
get_adjacent_post_rel_link() wp-includes/link-template.php	Retrieves the adjacent post relational link.
adjacent_posts_rel_link_wp_head() wp-includes/link-template.php	Displays relational links for the posts adjacent to the current post for single post pages.
get_boundary_post() wp-includes/link-template.php	Retrieves the boundary post.
wp_list_pages() wp-includes/post-template.php	Retrieves or displays a list of pages (or hierarchical post type items) in list (li) format.
get_post_class() wp-includes/post-template.php	Retrieves an array of the class names for the post container element.
get_body_class() wp-includes/post-template.php	Retrieves an array of the class names for the body element.
redirect_canonical() wp-includes/canonical.php	Redirects incoming links to the proper URL based on the site url.