get_attachment_template

Retrieve path of attachment template in current or parent template.

Description

(string) get_attachment_template(); 

The hierarchy for this template looks like:

1. -.php 2. .php 3. .php 4. attachment.php

An example of this is:

1. image-jpeg.php 2. jpeg.php 3. image.php 4. attachment.php

The template hierarchy is filterable via the hook. The template path is filterable via the hook.

Returns (string)

Full path to attachment template file.

Usage

  1. if ( !function_exists( 'get_attachment_template' ) ) { 
  2.     require_once ABSPATH . WPINC . '/template.php'; 
  3. } 
  4.  
  5.   
  6. // NOTICE! Understand what this does before running. 
  7. $result = get_attachment_template(); 
  8.     

Defined (1)

The function is defined in the following location(s).

/wp-includes/template.php  
  1. function get_attachment_template() { 
  2.     $attachment = get_queried_object(); 
  3.  
  4.     $templates = array(); 
  5.  
  6.     if ( $attachment ) { 
  7.         if ( false !== strpos( $attachment->post_mime_type, '/' ) ) { 
  8.             list( $type, $subtype ) = explode( '/', $attachment->post_mime_type ); 
  9.         } else { 
  10.             list( $type, $subtype ) = array( $attachment->post_mime_type, '' ); 
  11.         } 
  12.  
  13.         if ( ! empty( $subtype ) ) { 
  14.             $templates[] = "{$type}-{$subtype}.php"; 
  15.             $templates[] = "{$subtype}.php"; 
  16.         } 
  17.         $templates[] = "{$type}.php"; 
  18.     } 
  19.     $templates[] = 'attachment.php'; 
  20.  
  21.     return get_query_template( 'attachment', $templates ); 
  22. }