mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
4d26ab33dc
This resolves some surprising behaviour when reading other pages' content from shortcodes. Before this commit, that behaviour was undefined. Note that this has never been an issue from regular templates. It will still not be possible to get **the current shortcode's page's rendered content**. That would have impressed Einstein. The new and well defined rules are: * `.Page.Content` from a shortcode will be empty. The related `.Page.Truncated` `.Page.Summary`, `.Page.WordCount`, `.Page.ReadingTime`, `.Page.Plain` and `.Page.PlainWords` will also have empty values. * For _other pages_ (retrieved via `.Page.Site.GetPage`, `.Site.Pages` etc.) the `.Content` is there to use as you please as long as you don't have infinite content recursion in your shortcode/content setup. See below. * `.Page.TableOfContents` is good to go (but does not support shortcodes in headlines; this is unchanged) If you get into a situation of infinite recursion, the `.Content` will be empty. Run `hugo -v` for more information. Fixes #4632 Fixes #4653 Fixes #4655
67 lines
1.7 KiB
Go
67 lines
1.7 KiB
Go
// Copyright 2018 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package hugolib
|
|
|
|
import (
|
|
"html/template"
|
|
)
|
|
|
|
// PageWithoutContent is sent to the shortcodes. They cannot access the content
|
|
// they're a part of. It would cause an infinite regress.
|
|
//
|
|
// Go doesn't support virtual methods, so this careful dance is currently (I think)
|
|
// the best we can do.
|
|
type PageWithoutContent struct {
|
|
*Page
|
|
}
|
|
|
|
// Content returns an empty string.
|
|
func (p *PageWithoutContent) Content() (interface{}, error) {
|
|
return "", nil
|
|
}
|
|
|
|
// Truncated always returns false.
|
|
func (p *PageWithoutContent) Truncated() bool {
|
|
return false
|
|
}
|
|
|
|
// Summary returns an empty string.
|
|
func (p *PageWithoutContent) Summary() template.HTML {
|
|
return ""
|
|
}
|
|
|
|
// WordCount always returns 0.
|
|
func (p *PageWithoutContent) WordCount() int {
|
|
return 0
|
|
}
|
|
|
|
// ReadingTime always returns 0.
|
|
func (p *PageWithoutContent) ReadingTime() int {
|
|
return 0
|
|
}
|
|
|
|
// FuzzyWordCount always returns 0.
|
|
func (p *PageWithoutContent) FuzzyWordCount() int {
|
|
return 0
|
|
}
|
|
|
|
// Plain returns an empty string.
|
|
func (p *PageWithoutContent) Plain() string {
|
|
return ""
|
|
}
|
|
|
|
// PlainWords returns an empty string slice.
|
|
func (p *PageWithoutContent) PlainWords() []string {
|
|
return []string{}
|
|
}
|