hugo/docs/content/en/methods/page/InSection.md
Bjørn Erik Pedersen 5fd1e74903
Merge commit '9b0050e9aabe4be65c78ccf292a348f309d50ccd' as 'docs'
```
git subtree add --prefix=docs/ https://github.com/gohugoio/hugoDocs.git master --squash
```

Closes #11925
2024-01-27 10:48:57 +01:00

2.6 KiB

title description categories keywords action toc
InSection Reports whether the given page is in the given section.
related returnType signatures
methods/page/Ancestors
methods/page/CurrentSection
methods/page/FirstSection
methods/page/IsAncestor
methods/page/IsDescendant
methods/page/Parent
methods/page/Sections
bool
PAGE.InSection SECTION
true

The InSection method on a page object reports whether the given page is in the given section. Note that the method returns true when comparing a page to a sibling.

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

With this content structure:

content/
├── auctions/
│   ├── 2023-11/
│   │   ├── _index.md
│   │   ├── auction-1.md
│   │   └── auction-2.md
│   ├── 2023-12/
│   │   ├── _index.md
│   │   ├── auction-3.md
│   │   └── auction-4.md
│   ├── _index.md
│   ├── bidding.md
│   └── payment.md
└── _index.md

When rendering the "auction-1" page:

{{ with .Site.GetPage "/" }}
  {{ $.InSection . }} → false
{{ end }}

{{ with .Site.GetPage "/auctions" }}
  {{ $.InSection . }} → false
{{ end }}

{{ with .Site.GetPage "/auctions/2023-11" }}
  {{ $.InSection . }} → true
{{ end }}

{{ with .Site.GetPage "/auctions/2023-11/auction-2" }}
  {{ $.InSection . }} → true
{{ end }}

In the examples above we are coding defensively using the with statement, returning nothing if the page does not exist. By adding an else clause we can do some error reporting:

{{ $path := "/auctions/2023-11" }}
{{ with .Site.GetPage $path }}
  {{ $.InSection . }} → true
{{ else }}
  {{ errorf "Unable to find the section with path %s" $path }}
{{ end }}

Understanding context

Inside of the with block, the context (the dot) is the section Page object, not the Page object passed into the template. If we were to use this syntax:

{{ with .Site.GetPage "/auctions" }}
  {{ .InSection . }} → true
{{ end }}

The result would be wrong when rendering the "auction-1" page because we are comparing the section page to itself.

{{% note %}} Use the $ to get the context passed into the template. {{% /note %}}

{{ with .Site.GetPage "/auctions" }}
  {{ $.InSection . }} → true
{{ end }}

{{% note %}} Gaining a thorough understanding of context is critical for anyone writing template code. {{% /note %}}