hugo/docs/content/en/methods/page/File.md

title	description	categories	keywords	params
File	For pages backed by a file, returns file information for the given page.			functions_and_methods returnType signatures hugolib.fileInfo PAGE.File

By default, not all pages are backed by a file, including top-level section pages, taxonomy pages, and term pages. By definition, you cannot retrieve file information when the file does not exist.

To back one of the pages above with a file, create an _index.md file in the corresponding directory. For example:

content/
└── books/
    ├── _index.md  <-- the top-slevel section page
    ├── book-1.md
    └── book-2.md

[!note] Code defensively by verifying file existence as shown in the examples below.

Methods

[!note] The path separators (slash or backslash) in Path, Dir, and Filename depend on the operating system.

BaseFileName

(string) The file name, excluding the extension.

{{ with .File }}
  {{ .BaseFileName }}
{{ end }}

ContentBaseName

(string) If the page is a branch or leaf bundle, the name of the containing directory, else the TranslationBaseName.

{{ with .File }}
  {{ .ContentBaseName }}
{{ end }}

Dir

(string) The file path, excluding the file name, relative to the content directory.

{{ with .File }}
  {{ .Dir }}
{{ end }}

Ext

(string) The file extension.

{{ with .File }}
  {{ .Ext }}
{{ end }}

Filename

(string) The absolute file path.

{{ with .File }}
  {{ .Filename }}
{{ end }}

IsContentAdapter

{{< new-in 0.126.0 />}}

(bool) Reports whether the file is a content adapter.

{{ with .File }}
  {{ .IsContentAdapter }}
{{ end }}

LogicalName

(string) The file name.

{{ with .File }}
  {{ .LogicalName }}
{{ end }}

Path

(string) The file path, relative to the content directory.

{{ with .File }}
  {{ .Path }}
{{ end }}

Section

(string) The name of the top-level section in which the file resides.

{{ with .File }}
  {{ .Section }}
{{ end }}

TranslationBaseName

(string) The file name, excluding the extension and language identifier.

{{ with .File }}
  {{ .TranslationBaseName }}
{{ end }}

UniqueID

(string) The MD5 hash of .File.Path.

{{ with .File }}
  {{ .UniqueID }}
{{ end }}

Examples

Consider this content structure in a multilingual project:

content/
├── news/
│   ├── b/
│   │   ├── index.de.md   <-- leaf bundle
│   │   └── index.en.md   <-- leaf bundle
│   ├── a.de.md           <-- regular content
│   ├── a.en.md           <-- regular content
│   ├── _index.de.md      <-- branch bundle
│   └── _index.en.md      <-- branch bundle
├── _index.de.md
└── _index.en.md

With the English language site:

	regular content	leaf bundle	branch bundle
BaseFileName	a.en	index.en	_index.en
ContentBaseName	a	b	news
Dir	news/	news/b/	news/
Ext	md	md	md
Filename	/home/user/...	/home/user/...	/home/user/...
IsContentAdapter	false	false	false
LogicalName	a.en.md	index.en.md	_index.en.md
Path	news/a.en.md	news/b/index.en.md	news/_index.en.md
Section	news	news	news
TranslationBaseName	a	index	_index
UniqueID	15be14b...	186868f...	7d9159d...

Defensive coding

Some of the pages on a site may not be backed by a file. For example:

• Top-level section pages
• Taxonomy pages
• Term pages

Without a backing file, Hugo will throw an error if you attempt to access a .File property. To code defensively, first check for file existence:

{{ with .File }}
  {{ .ContentBaseName }}
{{ end }}