WP_Theme::get_page_templates( WP_Post|null $post = null, string $post_type = 'page' )
Returns the theme’s post templates for a given post type.
Description Description
Parameters Parameters
- $post
-
(WP_Post|null) (Optional) The post being edited, provided for context.
Default value: null
- $post_type
-
(string) (Optional) Post type to get the templates for. If a post is provided, its post type is used.
Default value: 'page'
Return Return
(array) Array of page templates, keyed by filename, with the value of the translated header name.
Source Source
File: wp-includes/class-wp-theme.php
public function get_page_templates( $post = null, $post_type = 'page' ) {
if ( $post ) {
$post_type = get_post_type( $post );
}
$post_templates = $this->get_post_templates();
$post_templates = isset( $post_templates[ $post_type ] ) ? $post_templates[ $post_type ] : array();
/**
* Filters list of page templates for a theme.
*
* @since 4.9.6
*
* @param string[] $post_templates Array of page templates. Keys are filenames,
* values are translated names.
* @param WP_Theme $this The theme object.
* @param WP_Post|null $post The post being edited, provided for context, or null.
* @param string $post_type Post type to get the templates for.
*/
$post_templates = (array) apply_filters( 'theme_templates', $post_templates, $this, $post, $post_type );
/**
* Filters list of page templates for a theme.
*
* The dynamic portion of the hook name, `$post_type`, refers to the post type.
*
* @since 3.9.0
* @since 4.4.0 Converted to allow complete control over the `$page_templates` array.
* @since 4.7.0 Added the `$post_type` parameter.
*
* @param string[] $post_templates Array of page templates. Keys are filenames,
* values are translated names.
* @param WP_Theme $this The theme object.
* @param WP_Post|null $post The post being edited, provided for context, or null.
* @param string $post_type Post type to get the templates for.
*/
$post_templates = (array) apply_filters( "theme_{$post_type}_templates", $post_templates, $this, $post, $post_type );
return $post_templates;
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 4.7.0 | Added the $post_type parameter. |
| 3.4.0 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
As of 4.7 a safe way to get your custom post type available templates, outside the loop or if the global
$postis intercepted:For a custom post type
'locations'this would give you something “like”:array(2) { ["templates/locations-max.php"]=> string(21) "Locations, no sidebar", ["templates/locations-no-maps.php"]=> string(21) "Locations, information only" }As of 4.7 this might be filtered and then some template information might be missing, you can call
wp_get_theme()->get_post_templates()instead, then you get an array with all post_types available templates within a deeper array.