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: ''
Return
(bool) Whether the query is for an existing attachment page.
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; }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
3.1.0 | Introduced. |