Help us to improve the Codex by filling out our documentation survey!Function Reference/get template part
Languages: English • 日本語 • 中文(简体) • Português do Brasil • (Add your language)
Contents |
Description
Load a template part into a template (other than header, sidebar, footer). Makes it easy for a theme to reuse sections of code and an easy way for child themes to replace sections of their parent theme.
Includes the named template part for a theme or if a name is specified then a specialized part will be included. If the theme contains no {slug}.php file then no template will be included.
For the parameter, if the file is called "{slug}-{name}.php".
Usage
<?php get_template_part( $slug, $name ); ?>
Parameters
- $slug
- (string) (required) The slug name for the generic template.
- Default: None
- $name
- (string) (optional) The name of the specialized template.
- Default: None
Examples
Using loop.php in child themes
Assuming the theme folder is wp-content/themes, that the parent theme is twentyten, and the child theme is twentytenchild, then the following code --
<?php get_template_part( 'loop', 'index' ); ?>
will do a PHP require() for the first file that exists among these, in this priority:
- wp-content/themes/twentytenchild/loop-index.php
- wp-content/themes/twentyten/loop-index.php
- wp-content/themes/twentytenchild/loop.php
- wp-content/themes/twentyten/loop.php
Using with theme subfolders
To use this function with subfolders in your theme directory, simply prepend the folder name before the slug. For example, if you have a folder called "partials" in your theme directory and a template part called "content-page.php" in that sub-folder, you would use get_template_part() like this:
<?php get_template_part( 'partials/content', 'page' ); ?>
Navigation
Adding a navigation bar to theme using a generic nav.php template file:
<?php get_template_part( 'nav' ); // Navigation bar (nav.php) ?> <?php get_template_part( 'nav', '2' ); // Navigation bar #2 (nav-2.php) ?> <?php get_template_part( 'nav', 'single' ); // Navigation bar to use in single pages (nav-single.php) ?>
Notes
- Uses: locate_template()
- Uses: do_action() Calls 'get_template_part_{$slug}' action.
Change Log
- Since: 3.0
Source File
get_template_part() is located in wp-includes/general-template.php.
External Resources
- Understanding get_template_part by Konstantin Kovshenin
Related
Include Tags: get_header(), get_footer(), get_sidebar(), get_template_part(), get_search_form(), comments_template()
