github.com/linchen2chris/hugo@v0.0.0-20230307053224-cec209389705/tpl/page/init.go (about)

     1  // Copyright 2022 The Hugo Authors. All rights reserved.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  // http://www.apache.org/licenses/LICENSE-2.0
     7  //
     8  // Unless required by applicable law or agreed to in writing, software
     9  // distributed under the License is distributed on an "AS IS" BASIS,
    10  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  // Package page provides template functions for accessing the current Page object,
    15  // the entry level context for the current template.
    16  package page
    17  
    18  import (
    19  	"context"
    20  
    21  	"github.com/gohugoio/hugo/deps"
    22  	"github.com/gohugoio/hugo/resources/page"
    23  	"github.com/gohugoio/hugo/tpl"
    24  
    25  	"github.com/gohugoio/hugo/tpl/internal"
    26  )
    27  
    28  const name = "page"
    29  
    30  func init() {
    31  	f := func(d *deps.Deps) *internal.TemplateFuncsNamespace {
    32  		ns := &internal.TemplateFuncsNamespace{
    33  			Name: name,
    34  			Context: func(ctx context.Context, args ...interface{}) (interface{}, error) {
    35  				v := tpl.GetPageFromContext(ctx)
    36  				if v == nil {
    37  					// The multilingual sitemap does not have a page as its context.
    38  					return nil, nil
    39  				}
    40  
    41  				return v.(page.Page), nil
    42  			},
    43  		}
    44  
    45  		return ns
    46  	}
    47  
    48  	internal.AddTemplateFuncsNamespace(f)
    49  }