get_page_templates( WP_Post|null $post = null, string $post_type = 'page' )

Gets the page templates available in this theme.

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.

Default value: 'page'

Top ↑

Return Return

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

Top ↑

More Information More Information

The function searches all the current theme’s template files for the commented “Template Name: name of template”. See also wp_get_theme() and the wp_get_theme()->get_page_templates() method of the WP_Theme class.

Top ↑

Source Source

File: wp-admin/includes/theme.php 

function get_page_templates( $post = null, $post_type = 'page' ) {
	return array_flip( wp_get_theme()->get_page_templates( $post, $post_type ) );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/meta-boxes.php: register_and_do_post_meta_boxes()

Registers the default post meta boxes, and runs the do_meta_boxes actions.
wp-admin/includes/template.php: page_template_dropdown()

Print out option HTML elements for the page templates drop-down.
wp-admin/includes/meta-boxes.php: page_attributes_meta_box()

Display page attributes form fields.
wp-admin/includes/class-wp-posts-list-table.php: WP_Posts_List_Table::inline_edit()

Outputs the hidden row displayed when inline editing
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getPageTemplates()

Retrieve page templates.

Top ↑

Changelog Changelog

Changelog
Version Description
4.7.0 Added the $post_type parameter.
1.5.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: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Output a list of available templates

    The following code snippet loops through the available page templates and outputs their template names and the filenames.

    <?php 
   $templates = get_page_templates();
   foreach ( $templates as $template_name => $template_filename ) {
       echo "$template_name ($template_filename)<br />";
   }
?>

    <?php print_r(get_page_templates());?>
Array
(
    [Sidebar] => sidebar.php
    [Category] => category.php
    [Page] => page.php
    [Home] => home.php
    [Single] => single.php
    [Comments Popup] => comments-popup.php
    [Footer] => footer.php
    [Header] => header.php
    [Index] => index.php
    [Contact] => contact.php
    [Home-Intro] => home-intro.php
    [Sidebar Left] => sidebar-left.php
    [Sidebar Right] => sidebar-right.php
    [TOC Home] => page-client-toc.php
    [Search Form] => searchform.php
    [Main-Navbar] => main-navbar.php
    [Bookmarks] => page-bookmarks.php
)

    Expand full source codeCollapse full source code

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