summaryrefslogtreecommitdiffstats
path: root/docs/content/en/methods/page/Page.md
blob: 7c7728b2f9420c1467e3fb9a2e13bcc17559f37d (plain) (blame)
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
---
title: Page
description: Returns the Page object of the given page.
categories: []
keywords: []
params:
  functions_and_methods:
    returnType: page.Page
    signatures: [PAGE.Page]
---

This is a convenience method, useful within partial templates that are called from both [shortcodes](g) and page templates.

```go-html-template {file="layouts/shortcodes/foo.html"}
{{ partial "my-partial.html" . }}
```

When the shortcode calls the partial, it passes the current [context](g) (the dot). The context includes identifiers such as `Page`, `Params`, `Inner`, and `Name`.

```go-html-template {file="layouts/_default/single.html"}
{{ partial "my-partial.html" . }}
```

When the page template calls the partial, it also passes the current context (the dot). But in this case, the dot _is_ the `Page` object.

```go-html-template {file="layouts/partials/my-partial.html"}
The page title is: {{ .Page.Title }}
```

To handle both scenarios, the partial template must be able to access the `Page` object with `Page.Page`.

> [!note]
> And yes, that means you can do `.Page.Page.Page.Page.Title` too.
>
> But don't.