mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
5fd1e74903
``` git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash ``` Closes #11925
65 lines
1.6 KiB
Markdown
65 lines
1.6 KiB
Markdown
---
|
|
title: GetPage
|
|
description: Returns a Page object from the given path.
|
|
categories: []
|
|
keywords: []
|
|
action:
|
|
related:
|
|
- methods/site/GetPage
|
|
returnType: page.Page
|
|
signatures: [PAGE.GetPage PATH]
|
|
aliases: [/functions/getpage]
|
|
---
|
|
|
|
The `GetPage` method is also available on a `Site` object. See [details].
|
|
|
|
[details]: /methods/site/getpage
|
|
|
|
When using the `GetPage` method on the `Page` object, specify a path relative to the current directory or relative to the content directory.
|
|
|
|
If Hugo cannot resolve the path to a page, the method returns nil. If the path is ambiguous, Hugo throws an error and fails the build.
|
|
|
|
Consider this content structure:
|
|
|
|
```text
|
|
content/
|
|
├── works/
|
|
│ ├── paintings/
|
|
│ │ ├── _index.md
|
|
│ │ ├── starry-night.md
|
|
│ │ └── the-mona-lisa.md
|
|
│ ├── sculptures/
|
|
│ │ ├── _index.md
|
|
│ │ ├── david.md
|
|
│ │ └── the-thinker.md
|
|
│ └── _index.md
|
|
└── _index.md
|
|
```
|
|
|
|
The examples below depict the result of rendering works/paintings/the-mona-list.md with a single page template:
|
|
|
|
```go-html-template
|
|
{{ with .GetPage "starry-night" }}
|
|
{{ .Title }} → Starry Night
|
|
{{ end }}
|
|
|
|
{{ with .GetPage "./starry-night" }}
|
|
{{ .Title }} → Starry Night
|
|
{{ end }}
|
|
|
|
{{ with .GetPage "../paintings/starry-night" }}
|
|
{{ .Title }} → Starry Night
|
|
{{ end }}
|
|
|
|
{{ with .GetPage "/works/paintings/starry-night" }}
|
|
{{ .Title }} → Starry Night
|
|
{{ end }}
|
|
|
|
{{ with .GetPage "../sculptures/david" }}
|
|
{{ .Title }} → David
|
|
{{ end }}
|
|
|
|
{{ with .GetPage "/works/sculptures/david" }}
|
|
{{ .Title }} → David
|
|
{{ end }}
|
|
```
|