For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Resources
Get started
ReferenceGuidesExamplesChangelog
ReferenceGuidesExamplesChangelog
  • Designer API
    • Introduction
    • Getting Started
    • Webflow CLI
    • Error Handling
    • App Modes
  • Elements
    • Creating & Retrieving Elements
    • Element Properties & Methods
    • Element Types & Methods
  • Styles
    • Managing Style Properties
    • Managing Variable Modes
  • Components
  • Variables & Collections
    • Variable Collections
    • Variables
    • Variable Modes
  • Assets
  • Pages & Folders
      • Page information
      • Page settings
        • Get search engine title
        • Set search engine title
        • Check if page uses title as the search engine title
        • Use page title as search engine title
        • Get search engine description
        • Set search engine description
        • Check if page uses description as the search engine description
        • Use page description as search engine description
        • Get search image
        • Set search image
        • Use Open Graph image as search image
        • Check if page is excluded from in site search indexing
        • Exclude page from in site search indexing
  • Utilities
    • User Events & Notifications
    • App Intents & Connections
  • Additional Resources
    • API Playground
    • FAQs
LogoLogo
Resources
Get started
On this page
  • page.useOpenGraphImageAsSearchImage(use)
Pages & FoldersManaging PagesSEO metadata

Use Open Graph image as search image

Was this page helpful?
Previous

Check if page is excluded from search

Next
Built with

page.useOpenGraphImageAsSearchImage(use)

Use the Open Graph image as the search image.

Syntax

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

Parameters

  • use: boolean - Whether to use the Open Graph image as the search image.

Returns

Promise<null>

A Promise that resolves to null.

Example

1// Get current page
2const currentPage = await webflow.getCurrentPage()
3
4// Set Open Graph image as search image
5await currentPage?.useOpenGraphImageAsSearchImage(true)

Try this example

Designer Ability

Designer AbilityLocaleBranchWorkflowSitemode
canManagePageSettingsAnyAnyAnyAny