WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/get file description

Description

Get the description for standard WordPress theme files and other various standard WordPress files.

Usage

 <?php get_file_description$file ); ?> 

Parameters

$file
(string) (required) Filesystem path or filename required
Default: None

Returns

Description of file from $wp_file_descriptions only for top level directory files of themes for others empty string or basename of $file if description doesn't exist.

Change Log

Source File

get_file_description( $file ) is located in wp-admin/includes/file.php#L58