WP_Theme::get_post_templates(): array[]

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

array[]

Array of page template arrays, keyed by post type and filename, with the value of the translated header name.

Performance profile

How much work a call to WP_Theme::get_post_templates() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

10–51

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 131.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below WP_Theme::get_post_templates()

Further down the call graph this can also reach option, query, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 9 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme::get_post_templates() can have, taken from its control-flow graph on PHP 8.5.

Uses · 11

• _cleanup_header_comment()Strips close comment and close php tags from file headers used by WP.
• sanitize_key()Sanitizes a string key.
• current_theme_supports()Checks a theme's support for a given feature.
• get_block_templates()Retrieves a list of unified template objects based on a query.
• get_post_types()Gets a list of all registered post type objects.
• WP_Theme::errors()Returns errors property.
• WP_Theme::cache_get()Gets theme data from cache.
• WP_Theme::get_files()Returns files in the theme's directory.
• WP_Theme::cache_add()Adds theme data to cache.
• WP_Theme::load_textdomain()Loads the theme's textdomain.
• WP_Theme::translate_header()Translates a theme header.

Used by · 1

• WP_Theme::get_page_templates()Returns the theme's post templates for a given post type.

Source code

View on Trac ↗View on GitHub ↗

1319	public function get_post_templates() {1320		// If you screw up your active theme and we invalidate your parent, most things still work. Let it slide.1321		if ( $this->errors() && $this->errors()->get_error_codes() !== array( 'theme_parent_invalid' ) ) {1322			return array();1323		}1324 1325		$post_templates = $this->cache_get( 'post_templates' );1326 1327		if ( ! is_array( $post_templates ) ) {1328			$post_templates = array();1329 1330			$files = (array) $this->get_files( 'php', 1, true );1331 1332			foreach ( $files as $file => $full_path ) {1333				if ( ! preg_match( '|Template Name:(.*)$|mi', file_get_contents( $full_path ), $header ) ) {1334					continue;1335				}1336 1337				$types = array( 'page' );1338				if ( preg_match( '|Template Post Type:(.*)$|mi', file_get_contents( $full_path ), $type ) ) {1339					$types = explode( ',', _cleanup_header_comment( $type[1] ) );1340				}1341 1342				foreach ( $types as $type ) {1343					$type = sanitize_key( $type );1344					if ( ! isset( $post_templates[ $type ] ) ) {1345						$post_templates[ $type ] = array();1346					}1347 1348					$post_templates[ $type ][ $file ] = _cleanup_header_comment( $header[1] );1349				}1350			}1351 1352			$this->cache_add( 'post_templates', $post_templates );1353		}1354 1355		if ( current_theme_supports( 'block-templates' ) ) {1356			$block_templates = get_block_templates( array(), 'wp_template' );1357			foreach ( get_post_types( array( 'public' => true ) ) as $type ) {1358				foreach ( $block_templates as $block_template ) {1359					if ( ! $block_template->is_custom ) {1360						continue;1361					}1362 1363					if ( isset( $block_template->post_types ) && ! in_array( $type, $block_template->post_types, true ) ) {1364						continue;1365					}1366 1367					$post_templates[ $type ][ $block_template->slug ] = $block_template->title;1368				}1369			}1370		}1371 1372		if ( $this->load_textdomain() ) {1373			foreach ( $post_templates as &$post_type ) {1374				foreach ( $post_type as &$post_template ) {1375					$post_template = $this->translate_header( 'Template Name', $post_template );1376				}1377			}1378		}1379 1380		return $post_templates;1381	}

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-theme.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.