blob: dbd2cb9b3f548642eab8e6f3837926e1c4b8823b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
---
title: Parent
description: Returns the Page object of the parent section of the given page.
categories: []
keywords: []
action:
related:
- methods/page/Ancestors
- methods/page/CurrentSection
- methods/page/FirstSection
- methods/page/InSection
- methods/page/IsAncestor
- methods/page/IsDescendant
- methods/page/Sections
returnType: hugolib.pageState
signatures: [PAGE.Parent]
---
{{% include "methods/page/_common/definition-of-section.md" %}}
{{% note %}}
The parent section of a regular page is the [current section].
[current section]: /methods/page/currentsection
{{% /note %}}
Consider this content structure:
```text
content/
├── auctions/
│ ├── 2023-11/
│ │ ├── _index.md <-- parent: auctions
│ │ ├── auction-1.md
│ │ └── auction-2.md <-- parent: 2023-11
│ ├── 2023-12/
│ │ ├── _index.md
│ │ ├── auction-3.md
│ │ └── auction-4.md
│ ├── _index.md <-- parent: home
│ ├── bidding.md
│ └── payment.md <-- parent: auctions
├── books/
│ ├── _index.md <-- parent: home
│ ├── book-1.md
│ └── book-2.md <-- parent: books
├── films/
│ ├── _index.md <-- parent: home
│ ├── film-1.md
│ └── film-2.md <-- parent: films
└── _index.md <-- parent: nil
```
In the example above, note the parent section of the home page is nil. Code defensively by verifying existence of the parent section before calling methods on its `Page` object. To create a link to the parent section page of the current page:
```go-html-template
{{ with .Parent }}
<a href="{{ .RelPermalink }}">{{ .LinkTitle }}</a>
{{ end }}
```
|
