hugo/docs/content/en/methods/page/CurrentSection.md
2023-12-04 15:24:01 +01:00

1.8 KiB

title description categories keywords action
CurrentSection Returns the Page object of the section in which the given page resides.
related returnType signatures
methods/page/Ancestors
methods/page/FirstSection
methods/page/InSection
methods/page/IsAncestor
methods/page/IsDescendant
methods/page/Parent
methods/page/Sections
hugolib.pageState
PAGE.CurrentSection

{{% include "methods/page/_common/definition-of-section.md" %}}

{{% note %}} The current section of a section page, taxonomy page, term page, or the home page, is itself.

{{% /note %}}

Consider this content structure:

content/
├── auctions/
│   ├── 2023-11/
│   │   ├── _index.md     <-- current section: 2023-11
│   │   ├── auction-1.md
│   │   └── auction-2.md  <-- current section: 2023-11
│   ├── 2023-12/
│   │   ├── _index.md     
│   │   ├── auction-3.md
│   │   └── auction-4.md
│   ├── _index.md         <-- current section: auctions
│   ├── bidding.md
│   └── payment.md        <-- current section: auctions
├── books/
│   ├── _index.md         <-- current section: books
│   ├── book-1.md
│   └── book-2.md         <-- current section: books
├── films/
│   ├── _index.md         <-- current section: films 
│   ├── film-1.md
│   └── film-2.md         <-- current section: films
└── _index.md             <-- current section: home

To create a link to the current section page:

<a href="{{ .CurrentSection.RelPermalink }}">{{ .CurrentSection.LinkTitle }}</a>