Yoast SEO 开发者文档

title: "Overview" post_status: publish comment_status: open taxonomy: category: - yoast-developer post_tag: - Controls - Features - Repos

This documentation provides information about the types of controls that Yoast SEO provides.

Global site controls

As a site owner, I want to be able to set the following metadata globally.

Default meta options

Option Description Values
og:site_name The name of the site for when shared in social platforms string
twitter:site The X handle of the X profile associated with the site string
Social profiles An array of the URLs of social media properties representing the publisher array
Title separator The character used to delimit a page's 'name' and brand components in the title tag char

Publisher information

Option Description Values
Publisher type Whether the site represents a user or organization user or organization
organization.name The name of the organization which publishes the site. string
organization.logo An image representing the organization which publishes the site. string
person.name The name (and identity, e.g., a user ID/profile) of the person who publishes the site. string
person.logo An image representing the person who publishes the site. string

NB: Only values for one of organization or person fields are required, depending on the Publisher type.

Template controls

For each template (and/or content) type, the user should be able to set:

Option Description Values
Title patterns The default pattern which title values should use string supporting replacement vars
Description patterns The default pattern which meta description values should use string supporting replacement vars
Meta robots values Crawling/indexing controls which deviate from the defaults One or more of index, noindex, follow, nofollow, noodp, noimageindex, noarchive, nosnippet

Page-level controls

For each page, the user should be able to preview and control their SEO settings via our analysis tools

Misc Tools

Tools must be provided to allow users to manage:

Feature controls

It must be possible to enable/disable the following features (when available):