mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-16 01:30:18 -04:00
31 lines
918 B
Markdown
31 lines
918 B
Markdown
---
|
|
title: Position
|
|
description: Returns the file name and position from which the shortcode was called.
|
|
categories: []
|
|
keywords: []
|
|
params:
|
|
functions_and_methods:
|
|
returnType: text.Position
|
|
signatures: [SHORTCODE.Position]
|
|
---
|
|
|
|
The `Position` method is useful for error reporting. For example, if your shortcode requires a "greeting" argument:
|
|
|
|
```go-html-template {file="layouts/_shortcodes/myshortcode.html"}
|
|
{{ $greeting := "" }}
|
|
{{ with .Get "greeting" }}
|
|
{{ $greeting = . }}
|
|
{{ else }}
|
|
{{ errorf "The %q shortcode requires a 'greeting' argument. See %s" .Name .Position }}
|
|
{{ end }}
|
|
```
|
|
|
|
In the absence of a "greeting" argument, Hugo will throw an error message and fail the build:
|
|
|
|
```text
|
|
ERROR The "myshortcode" shortcode requires a 'greeting' argument. See "/home/user/project/content/about.md:11:1"
|
|
```
|
|
|
|
> [!note]
|
|
> The position can be expensive to calculate. Limit its use to error reporting.
|