Skip to main content

Site

Access global site settings. Available on all pages.

All Fields

FieldArgumentsReturnsDescription
idintSite ID
namestringSite name
titlestringSite title (alias)
blognamestringBlog name (alias)
descriptionstringSite tagline
urlstringSite URL
linkstringSite URL (alias)
home_urlstringHome URL
site_urlstringWordPress URL
siteurlstringWordPress URL (alias)
admin_emailstringAdministrator email
languagestringSite language code
charsetstringCharacter set (UTF-8)
multisiteboolIs multisite network
themeobjectCurrent theme object
iconImageSite icon
optionoption_namemixedWordPress option value

Basic Fields

{{ site.name }}
{{ site.description }}

URLs

{{ site.url }}
{{ site.home_url }}
{{ site.site_url }}

Configuration

{{ site.admin_email }}
{{ site.language }}
{{ site.charset }}
{{ site.multisite }}

Theme

{{ site.theme.name }}
{{ site.theme.version }}

Site Icon

The icon field returns an Image object.

{{ site.icon.src }}
{{ site.icon.src('thumbnail') }}

Options

{{ site.option('blogname') }}
{{ site.option('posts_per_page') }}
{{ site.option('date_format') }}
{{ site.option('my_custom_option') }}
{{ site.option('theme_settings').colors.primary }}

Security: Options must be whitelisted via the unblock/data/allowed_options filter:

add_filter( 'unblock/data/allowed_options', function( $allowed ) {
$allowed[] = 'my_custom_option';
return $allowed;
});

Common Patterns

Site branding

{{ site.name }}
{{ site.description }}
{{ site.icon.src('thumbnail') }}
© {{ post.date('Y') }} {{ site.name }}

Dynamic page title

{{ post.title }} - {{ site.name }}