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.

Contents

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'

Top ↑

Return Return

(string[]) Array of template header names keyed by the template file name.

Top ↑

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 template header names keyed by the template file name.
		 * @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 template header names keyed by the template file name.
		 * @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

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/class-wp-theme.php: theme_templates

Filters list of page templates for a theme.
wp-includes/class-wp-theme.php: WP_Theme::get_post_templates()

Returns the theme’s post templates.
wp-includes/class-wp-theme.php: theme_{$post_type}_templates

Filters list of page templates for a theme.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/post.php: get_post_type()

Retrieves the post type of the current post or of a given post.

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::check_template()

Check whether the template is valid for the given post.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::handle_template()

Sets the template for a post.
wp-admin/includes/theme.php: get_page_templates()

Gets the page templates available in this theme.
wp-includes/post.php: wp_insert_post()

Insert or update a post.

Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Added the $post_type parameter.
3.4.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Jonas Lundman —

    As of 4.7 a safe way to get your custom post type available templates, outside the loop or if the global $post is intercepted:

    $templates = wp_get_theme()->get_page_templates(null, 'my_post_type');

    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.

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