SEO metadata

`page.isExcludedFromSearch()`

Check if the page is excluded from search engine indexing.

Syntax

page.isExcludedFromSearch(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage()

// Check if page is excluded from search engine indexing
const isExcluded = await currentPage?.isExcludedFromSearch()

if (isExcluded){
  console.log('Current page is excluded from search engine indexing')
} else {
  "Current page is included in search engine indexing"
}

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

`page.excludeFromSearch(shouldExclude)`

Sets whether the page should be excluded from search engine indexing.

Syntax

page.excludeFromSearch(shouldExclude: boolean): Promise<null>;

Parameters

shouldExclude: boolean - Set to true to exclude the page from search engine indexing, false otherwise.

Returns

Promise<null>

A Promise that resolves to null when the page is excluded from search.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage()

// Exclud from search engine indexing
await currentPage.excludeFromSearch(true)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canManagePageSettings	Any	Any	Any	Any

`page.usesTitleAsSearchTitle()`

Checks if the page uses its title as the search engine title.

Syntax

page.usesTitleAsSearchTitle(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage()

// Check title
const usesTitle = await currentPage?.usesTitleAsSearchTitle()

if (usesTitle){
  console.log('This page uses its Title as the Search Engine title')
} else {
  console.log( "This page has a custom search engine title")
}

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

`page.useTitleAsSearchTitle(use)`

Sets whether the page should use its title as the search engine title.

Syntax

page.useTitleAsSearchTitle(use: boolean): Promise<null>;

Parameters

use: boolean - Set to true to use the page title as the search engine title, false otherwise.

Returns

Promise<null>

A Promise that resolves to null when the search engine title is set.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage()

// Set title as search title
await currentPage?.useTitleAsSearchTitle(true)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canManagePageSettings	Any	Any	Any	Any

`page.getSearchTitle()`

Retrieves the search engine title of the page.

Syntax

page.getSearchTitle(): Promise<string>;

Returns

Promise< string>

A Promise that resolves to a string with the search engine title.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page

// Get Search engine title and print details
const searchEngineTitle = currentPage.getSearchTitle()
console.log(searchEngineTitle)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

`page.setSearchTitle(title)`

Sets the search engine title of the page to the provided value.

Syntax

page.setSearchTitle(title: string): Promise<null>;

Parameters

title: string - The new search engine title to set for the page.

Returns

Promise<null>

A Promise that resolves to a null value when the search engine title has been set.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page

// Set search engine title and print details
await currentPage.setSearchTitle("My New Title")
const searchTitle = await currentPage.getSearchTitle()
console.log(searchTitle)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canManagePageSettings	Any	Any	Any	Any

`page.usesDescriptionAsSearchDescription()`

Checks if the page uses its description as the search engine description.

Syntax

page.usesDescriptionAsSearchDescription(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value when the description is set.

Example

// Get current page
const currentPage = await webflow.getCurrentPage()

// Check search engine description
const isSearchDescription = await currentPage?.usesDescriptionAsSearchDescription()

if(isSearchDescription){
  console.log("This page uses its description as the search engine description")
} else {
  console.log("This page has a custom search engine description")
}

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

`page.useDescriptionAsSearchDescription(use)`

Sets whether the page should use its description as the search engine description.

Syntax

page.useDescriptionAsSearchDescription(use: boolean): Promise<null>;

Parameters

use: boolean - Set to true to use the page description as the search engine description, false otherwise.

Returns

Promise< null>

A Promise that resolves to null when the search engine description is set.

Example

// Get current page
const currentPage = await webflow.getCurrentPage()

// Set search description
await currentPage.useDescriptionAsSearchDescription(true)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canManagePageSettings	Any	Any	Any	Any

`page.getSearchDescription()`

Retrieves the search engine description of the page.

Syntax

page.getSearchDescription(): Promise<string>;

Returns

Promise< string>

A Promise that resolves to a string with the search engine description.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page

// Get search engine description and print details
const searchEngineDescription = currentPage.getSearchDescription()
console.log(searchEngineDescription)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

`page.setSearchDescription(description)`

Sets the search engine description of the page to the provided value.

Syntax

page.setSearchDescription(description: string): Promise<null>;

Parameters

description: string - The new search engine description to set for the page.

Returns

Promise<null>

A Promise that resolves to null when the search engine description is set.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page

// Set search engine description and print details
await currentPage.setSearchDescription(description)
const searchDescription = await currentPage.getSearchDescription()
console.log(My New Description)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canManagePageSettings	Any	Any	Any	Any

`page.usesOpenGraphImageAsSearchImage()`

Check if the page uses its Open Graph image as the search engine image.

Syntax

page.usesOpenGraphImageAsSearchImage(): Promise<boolean>;

Returns

Promise<boolean>

A Promise that resolves to a boolean value to indicate whether a page uses its Open Graph image as a search engine image.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page

// Check page status
const isOpenGraphImageUsedForSearchEngines = await currentPage.usesOpenGraphImageAsSearchImage()

// Print page status
if (isOpenGraphImageUsedForSearchEngines) {

  console.log('Page uses Open Graph image as Seach Engine Image')
} else {
  console.log('This page has a custom Search engine image')
}

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

`page.useOpenGraphImageAsSearchImage(use)`

Choose whether the page should use its Open Graph image as the search engine image.

Syntax

page.useOpenGraphImageAsSearchImage(use: boolean): Promise<null>;

Parameters

use: boolean - Set to true to use the Open Graph (OG) image as the search engine image, false otherwise.

Returns

Promise<null>

A Promise that resolves to null when the search image is set.

Example

// Get current page
const currentPage = await webflow.getCurrentPage()

// Set Open Graph image as search image
await currentPage?.useOpenGraphImageAsSearchImage(true)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canManagePageSettings	Any	Any	Any	Any

`page.getSearchImage()`

Retrieves the search engine image URL of the page.

Syntax

page.getSearchImage(): Promise<string>;

Returns

Promise<string>

A Promise that resolves to a string with the search engine image URL.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page

// Get search engine Image and print details
const searchEngineImage = currentPage.getSearchImage()
console.log(searchEngineImage)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canReadPageSettings	Any	Any	Any	Any

`page.setSearchImage(url)`

Sets the search engine image of the page to the provided URL.

Syntax

page.setSearchImage(url: string): Promise<null>;

Parameters

url: string - The new search engine image URL to set for the page.

Returns

Promise<null>

A Promise that resolves to null when the search engine image is set.

Example

// Get Current Page
const currentPage = await webflow.getCurrentPage() as Page

// Set search engine image and print details
await currentPage.setSearchImage(image)
const searchImage = await currentPage.getSearchImage()
console.log(searchImage)

Designer Ability

Designer Ability	Locale	Branch	Workflow	Sitemode
canManagePageSettings	Any	Any	Any	Any