wpseek.com
A WordPress-centric search engine for devs and theme authors



get_file_description › WordPress Function

Since1.5.0
Deprecatedn/a
› get_file_description ( $file )
Parameters:
  • (string) $file Filesystem path or filename.
    Required: Yes
Returns:
  • (string) Description of file from $wp_file_descriptions or basename of $file if description doesn't exist. Appends 'Page Template' to basename of $file if the file is a page template.
Defined at:
Codex:

Gets the description for standard WordPress theme files.



Related Functions: term_description, get_the_archive_description, the_archive_description, tag_description, get_the_author_description

Source 

function get_file_description( $file ) {
	global $wp_file_descriptions, $allowed_files;

	$dirname   = pathinfo( $file, PATHINFO_DIRNAME );
	$file_path = $allowed_files[ $file ];

	if ( isset( $wp_file_descriptions[ basename( $file ) ] ) && '.' === $dirname ) {
		return $wp_file_descriptions[ basename( $file ) ];
	} elseif ( file_exists( $file_path ) && is_file( $file_path ) ) {
		$template_data = implode( '', file( $file_path ) );

		if ( preg_match( '|Template Name:(.*)$|mi', $template_data, $name ) ) {
			/* translators: %s: Template name. */
			return sprintf( __( '%s Page Template' ), _cleanup_header_comment( $name[1] ) );
		}
	}

	return trim( basename( $file ) );
}