WP_Query::is_attachment() WordPress Method

The WP_Query::is_attachment() method is used to determine if the current post is an attachment. This method can be used within the WordPress Loop or outside of it.

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

Is the query for an existing attachment page?


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 ↑

Source

File: wp-includes/class-wp-query.php

	public function is_attachment( $attachment = '' ) {
		if ( ! $this->is_attachment ) {
			return false;
		}

		if ( empty( $attachment ) ) {
			return true;
		}

		$attachment = array_map( 'strval', (array) $attachment );

		$post_obj = $this->get_queried_object();

		if ( in_array( (string) $post_obj->ID, $attachment, true ) ) {
			return true;
		} elseif ( in_array( $post_obj->post_title, $attachment, true ) ) {
			return true;
		} elseif ( in_array( $post_obj->post_name, $attachment, true ) ) {
			return true;
		}
		return false;
	}


Top ↑

Changelog

Changelog
VersionDescription
3.1.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.

Show More