WP_Theme::get_file_path( string $file = '' )

Retrieves the path of a file in the theme.


Description

Searches in the stylesheet directory before the template directory so themes which inherit from a parent theme can just override one file.


Top ↑

Parameters

$file

(string) (Optional) File to search for in the stylesheet directory.

Default value: ''


Top ↑

Return

(string) The path of the file.


Top ↑

Source

File: wp-includes/class-wp-theme.php

	public function get_file_path( $file = '' ) {
		$file = ltrim( $file, '/' );

		$stylesheet_directory = $this->get_stylesheet_directory();
		$template_directory   = $this->get_template_directory();

		if ( empty( $file ) ) {
			$path = $stylesheet_directory;
		} elseif ( file_exists( $stylesheet_directory . '/' . $file ) ) {
			$path = $stylesheet_directory . '/' . $file;
		} else {
			$path = $template_directory . '/' . $file;
		}

		/** This filter is documented in wp-includes/link-template.php */
		return apply_filters( 'theme_file_path', $path, $file );
	}


Top ↑

Changelog

Changelog
Version Description
5.9.0 Introduced.

Top ↑

User Contributed Notes

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