get_file_description() – Gets the description for standard WordPress theme files.

You appear to be a bot. Output may be restricted

Description

Gets the description for standard WordPress theme files.

Usage

$string = get_file_description( $file );

Parameters

$file
( string ) required – Filesystem path or filename.

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.

Source

File name: wordpress/wp-admin/includes/file.php
Lines:

1 to 19 of 19
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 ) );
}
 

 View on GitHub View on Trac