wagtailseo.models

class wagtailseo.models.SeoMixin(*args, **kwargs)

Contains fields for SEO-related attributes on a Page model.

class Meta
property seo_author: str

Gets the name of the author of this page. Override in your Page model as necessary.

property seo_canonical_url: str

Gets the full/absolute/canonical URL preferred for meta tags and search engines. Override in your Page model as necessary.

property seo_description: str

Gets the correct search engine and Open Graph description of this page. Override in your Page model as necessary.

property seo_image: AbstractImage | None

Gets the primary Open Graph image of this page.

property seo_image_url: str

Gets the absolute URL for the primary Open Graph image of this page.

Gets the primary logo of the organization.

property seo_logo_url: str

Gets the absolute URL for the organization logo.

property seo_og_type: str

Gets the correct Open Graph type for this page. Override in your Page model as necessary.

property seo_pagetitle: str

Gets the correct search engine and Open Graph title of this page. Override in your Page model as necessary.

property seo_published_at: datetime

Gets the date this page was first published. Override in your Page model as necessary.

property seo_sitename: str

Gets the site name. Override in your Page model as necessary.

property seo_struct_org_base_dict: dict

Gets generic “Organization” data for use as a subset of other structured data types (for example, as publisher of an Article).

See: https://developers.google.com/search/docs/data-types/article

property seo_struct_org_dict: dict

Gets full “Organization” structured data on top of base organization data.

See: https://developers.google.com/search/docs/data-types/local-business

property seo_struct_org_name: str

Gets org name for structured data using a fallback.

property seo_struct_publisher_dict: dict | None

Gets the base organization info from either this page, or the root page.

property seo_twitter_card_content: str

Gets the correct style of twitter card for this page. Override in your Page model as necessary.

class wagtailseo.models.SeoSettings(*args, **kwargs)

Toggle Search engine optimization features and meta tags.

exception DoesNotExist
exception MultipleObjectsReturned
property at_twitter_site

The Twitter site handle, prepended with “@”.

class wagtailseo.models.SeoType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
class wagtailseo.models.TwitterCard(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)