is_attachment() WordPress Function

The is_attachment() function is used to check if the current post is an attachment. This function can be used within the WordPress loop to check if the current post is an attachment.

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
VersionDescription
2.0.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.