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

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


Top ↑

Return

bool Whether the query is for an existing attachment page.


Top ↑

Source

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

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
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes

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