Model Reference¶

Database fields¶

class wagtail.models.Page¶

title¶

(text)

Human-readable title of the page.

draft_title¶

(text)

Human-readable title of the page, incorporating any changes that have been made in a draft edit (in contrast to the title field, which for published pages will be the title as it exists in the current published version).

slug¶

(text)

This is used for constructing the page’s URL.

For example: http://domain.com/blog/[my-slug]/

content_type¶

(foreign key to django.contrib.contenttypes.models.ContentType)

A foreign key to the ContentType object that represents the specific model of this page.

live¶

(boolean)

A boolean that is set to True if the page is published.

Note: this field defaults to True meaning that any pages that are created programmatically will be published by default.

has_unpublished_changes¶

(boolean)

A boolean that is set to True when the page is either in draft or published with draft changes.

owner¶

(foreign key to user model)

A foreign key to the user that created the page.

first_published_at¶

(date/time)

The date/time when the page was first published.

last_published_at¶

(date/time)

The date/time when the page was last published.

seo_title¶

(text)

Alternate SEO-crafted title, for use in the page’s <title> HTML tag.

search_description¶

(text)

SEO-crafted description of the content, used for search indexing. This is also suitable for the page’s <meta name="description"> HTML tag.

show_in_menus¶

(boolean)

Toggles whether the page should be included in site-wide menus, and is shown in the promote_panels within the Page editor.

Wagtail does not include any menu implementation by default, which means that this field will not do anything in the front facing content unless built that way in a specific Wagtail installation.

However, this is used by the in_menu() QuerySet filter to make it easier to query for pages that use this field.

Defaults to False and can be overridden on the model with show_in_menus_default = True.

Note

To set the global default for all pages, set Page.show_in_menus_default = True once where you first import the Page model.

locked¶

(boolean)

When set to True, the Wagtail editor will not allow any users to edit the content of the page.

If locked_by is also set, only that user can edit the page.

locked_by¶

(foreign key to user model)

The user who has currently locked the page. Only this user can edit the page.

If this is None when locked is True, nobody can edit the page.

locked_at¶

(date/time)

The date/time when the page was locked.

alias_of¶

(foreign key to another page)

If set, this page is an alias of the page referenced in this field.

locale¶

(foreign key to Locale)

This foreign key links to the Locale object that represents the page language.

translation_key¶

(uuid)

A UUID that is shared between translations of a page. These are randomly generated when a new page is created and copied when a translation of a page is made.

A translation_key value can only be used on one page in each locale.

Methods and properties¶

In addition to the model fields provided, Page has many properties and methods that you may wish to reference, use, or override in creating your own models.

class wagtail.models.Page

get_specific(deferred=False, copy_attrs=None, copy_attrs_exclude=None)¶

Return this object in its most specific subclassed form.

By default, a database query is made to fetch all field values for the specific object. If you only require access to custom methods or other non-field attributes on the specific object, you can use deferred=True to avoid this query. However, any attempts to access specific field values from the returned object will trigger additional database queries.

By default, references to all non-field attribute values are copied from current object to the returned one. This includes:

• Values set by a queryset, for example: annotations, or values set as a result of using select_related() or prefetch_related().

• Any cached_property values that have been evaluated.

• Attributes set elsewhere in Python code.

For fine-grained control over which non-field values are copied to the returned object, you can use copy_attrs to specify a complete list of attribute names to include. Alternatively, you can use copy_attrs_exclude to specify a list of attribute names to exclude.

If called on an object that is already an instance of the most specific class, the object will be returned as is, and no database queries or other operations will be triggered.

If the object was originally created using a model that has since been removed from the codebase, an instance of the base class will be returned (without any custom field values or other functionality present on the original class). Usually, deleting these objects is the best course of action, but there is currently no safe way for Wagtail to do that at migration time.

specific¶

Returns this object in its most specific subclassed form with all field values fetched from the database. The result is cached in memory.

specific_deferred¶

Returns this object in its most specific subclassed form without any additional field values being fetched from the database. The result is cached in memory.

specific_class¶

Return the class that this object would be if instantiated in its most specific form.

If the model class can no longer be found in the codebase, and the relevant ContentType has been removed by a database migration, the return value will be None.

If the model class can no longer be found in the codebase, but the relevant ContentType is still present in the database (usually a result of switching between git branches without running or reverting database migrations beforehand), the return value will be None.

cached_content_type¶

Return this object’s content_type value from the ContentType model’s cached manager, which will avoid a database query if the content type is already in memory.

page_type_display_name¶

A human-readable version of this page’s type

get_url(request=None, current_site=None)¶

Return the ‘most appropriate’ URL for referring to this page from the pages we serve, within the Wagtail backend and actual website templates; this is the local URL (starting with ‘/’) if we’re only running a single site (i.e. we know that whatever the current page is being served from, this link will be on the same domain), and the full URL (with domain) if not. Return None if the page is not routable.

Accepts an optional but recommended request keyword argument that, if provided, will be used to cache site-level URL information (thereby avoiding repeated database / cache lookups) and, via the Site.find_for_request() function, determine whether a relative or full URL is most appropriate.

get_full_url(request=None)¶

Return the full URL (including protocol / domain) to this page, or None if it is not routable

full_url¶

Return the full URL (including protocol / domain) to this page, or None if it is not routable

relative_url(current_site, request=None)¶

Return the ‘most appropriate’ URL for this page taking into account the site we’re currently on; a local URL if the site matches, or a fully qualified one otherwise. Return None if the page is not routable.

Accepts an optional but recommended request keyword argument that, if provided, will be used to cache site-level URL information (thereby avoiding repeated database / cache lookups).

get_site()¶

Return the Site object that this page belongs to.

get_url_parts(request=None)¶

Determine the URL for this page and return it as a tuple of (site_id, site_root_url, page_url_relative_to_site_root). Return None if the page is not routable.

This is used internally by the full_url, url, relative_url and get_site properties and methods; pages with custom URL routing should override this method in order to have those operations return the custom URLs.

Accepts an optional keyword argument request, which may be used to avoid repeated database / cache lookups. Typically, a page model that overrides get_url_parts should not need to deal with request directly, and should just pass it to the original method when calling super.

route(request, path_components)¶

serve(request, *args, **kwargs)¶

context_object_name = None¶

Custom name for page instance in page’s Context.

get_context(request, *args, **kwargs)¶

get_template(request, *args, **kwargs)¶

get_admin_display_title()¶

Return the title for this page as it should appear in the admin backend; override this if you wish to display extra contextual information about the page, such as language. By default, returns draft_title.

preview_modes¶

A list of (internal_name, display_name) tuples for the modes in which this object can be displayed for preview/moderation purposes. Ordinarily an object will only have one display mode, but subclasses can override this - for example, a page containing a form might have a default view of the form, and a post-submission ‘thank you’ page. Set to [] to completely disable previewing for this model.

serve_preview(request, mode_name)¶

Returns an HTTP response for use in object previews.

This method can be overridden to implement custom rendering and/or routing logic.

Any templates rendered during this process should use the request object passed here - this ensures that request.user and other properties are set appropriately for the wagtail user bar to be displayed/hidden. This request will always be a GET.

get_parent(update=False)¶

Returns:

the parent node of the current node object. Caches the result in the object itself to help in loops.

get_ancestors(inclusive=False)¶

Returns a queryset of the current page’s ancestors, starting at the root page and descending to the parent, or to the current page itself if inclusive is true.

get_descendants(inclusive=False)¶

Returns a queryset of all pages underneath the current page, any number of levels deep. If inclusive is true, the current page itself is included in the queryset.

get_siblings(inclusive=True)¶

Returns a queryset of all other pages with the same parent as the current page. If inclusive is true, the current page itself is included in the queryset.

get_translations(inclusive=False)¶

Returns a queryset containing the translations of this instance.

get_translation(locale)¶

Finds the translation in the specified locale.

If there is no translation in that locale, this raises a model.DoesNotExist exception.

get_translation_or_none(locale)¶

Finds the translation in the specified locale.

If there is no translation in that locale, this returns None.

has_translation(locale)¶

Returns True if a translation exists in the specified locale.

copy_for_translation(locale, copy_parents=False, alias=False, exclude_fields=None)¶

Creates a copy of this page in the specified locale.

localized¶

Finds the translation in the current active language.

If there is no translation in the active language, self is returned.

Note: This will not return the translation if it is in draft. If you want to include drafts, use the .localized_draft attribute instead.

localized_draft¶

Finds the translation in the current active language.

If there is no translation in the active language, self is returned.

Note: This will return translations that are in draft. If you want to exclude these, use the .localized attribute.

search_fields¶

A list of fields to be indexed by the search engine. See Search docs Indexing extra fields

subpage_types¶

A list of page models which can be created as children of this page type. For example, a BlogIndex page might allow a BlogPage as a child, but not a JobPage:

class BlogIndex(Page):
    subpage_types = ['mysite.BlogPage', 'mysite.BlogArchivePage']

The creation of child pages can be blocked altogether for a given page by setting its subpage_types attribute to an empty array:

class BlogPage(Page):
    subpage_types = []

parent_page_types¶

A list of page models which are allowed as parent page types. For example, a BlogPage may only allow itself to be created below the BlogIndex page:

class BlogPage(Page):
    parent_page_types = ['mysite.BlogIndexPage']

Pages can block themselves from being created at all by setting parent_page_types to an empty array (this is useful for creating unique pages that should only be created once):

class HiddenPage(Page):
    parent_page_types = []

To allow for a page to be only created under the root page (for example for HomePage models) set the parent_page_type to ['wagtailcore.Page'].

class HomePage(Page):
    parent_page_types = ['wagtailcore.Page']

classmethod can_exist_under(parent)¶

Checks if this page type can exist as a subpage under a parent page instance.

See also: Page.can_create_at() and Page.can_move_to()

classmethod can_create_at(parent)¶

Checks if this page type can be created as a subpage under a parent page instance.

can_move_to(parent)¶

Checks if this page instance can be moved to be a subpage of a parent page instance.

get_route_paths()¶

Returns a list of paths that this page can be viewed at.

These values are combined with the dynamic portion of the page URL to automatically create redirects when the page’s URL changes.

Note

If using RoutablePageMixin, you may want to override this method to include the paths of popualar routes.

Note

Redirect paths are ‘normalized’ to apply consistent ordering to GET parameters, so you don’t need to include every variation. Fragment identifiers are discarded too, so should be avoided.

password_required_template¶

Defines which template file should be used to render the login form for Protected pages using this model. This overrides the default, defined using PASSWORD_REQUIRED_TEMPLATE in your settings. See Private pages

is_creatable¶

Controls if this page can be created through the Wagtail administration. Defaults to True, and is not inherited by subclasses. This is useful when using multi-table inheritance, to stop the base model from being created as an actual page.

max_count¶

Controls the maximum number of pages of this type that can be created through the Wagtail administration interface. This is useful when needing “allow at most 3 of these pages to exist”, or for singleton pages.

max_count_per_parent¶

Controls the maximum number of pages of this type that can be created under any one parent page.

exclude_fields_in_copy¶

An array of field names that will not be included when a Page is copied. Useful when you have relations that do not use ClusterableModel or should not be copied.

class BlogPage(Page):
    exclude_fields_in_copy = ['special_relation', 'custom_uuid']

The following fields will always be excluded in a copy - [‘id’, ‘path’, ‘depth’, ‘numchild’, ‘url_path’, ‘path’].

base_form_class¶

The form class used as a base for editing Pages of this type in the Wagtail page editor. This attribute can be set on a model to customise the Page editor form. Forms must be a subclass of WagtailAdminPageForm. See Customising generated forms for more information.

with_content_json(content)¶

Returns a new version of the page with field values updated to reflect changes in the provided content (which usually comes from a previously-saved page revision).

Certain field values are preserved in order to prevent errors if the returned page is saved, such as id, content_type and some tree-related values. The following field values are also preserved, as they are considered to be meaningful to the page as a whole, rather than to a specific revision:

• draft_title

• live

• has_unpublished_changes

• owner

• locked

• locked_by

• locked_at

• latest_revision

• latest_revision_created_at

• first_published_at

• alias_of

• wagtail_admin_comments (COMMENTS_RELATION_NAME)

save(clean=True, user=None, log_action=False, **kwargs)¶

Overrides default method behaviour to make additional updates unique to pages, such as updating the url_path value of descendant page to reflect changes to this page’s slug.

New pages should generally be saved via the add_child() or add_sibling() method of an existing page, which will correctly set the path and depth fields on the new page before saving it.

By default, pages are validated using full_clean() before attempting to save changes to the database, which helps to preserve validity when restoring pages from historic revisions (which might not necessarily reflect the current model state). This validation step can be bypassed by calling the method with clean=False.

create_alias(*, recursive=False, parent=None, update_slug=None, update_locale=None, user=None, log_action='wagtail.create_alias', reset_translation_key=True, _mpnode_attrs=None)¶

update_aliases(*, revision=None, _content=None, _updated_ids=None)¶

Publishes all aliases that follow this page with the latest content from this page.

This is called by Wagtail whenever a page with aliases is published.

Parameters:

revision (PageRevision, optional) – The revision of the original page that we are updating to (used for logging purposes)

get_cache_key_components()¶

The components of a Page which make up the cache_key. Any change to a page should be reflected in a change to at least one of these components.

cache_key¶

A generic cache key to identify a page in its current state. Should the page change, so will the key.

Customizations to the cache key should be made in get_cache_key_components.

Database fields¶

class wagtail.models.Site¶

hostname¶

(text)

This is the hostname of the site, excluding the scheme, port and path.

For example: www.mysite.com

Note

If you’re looking for how to get the root url of a site, use the root_url attribute.

port¶

(number)

This is the port number that the site responds on.

site_name¶

(text - optional)

A human-readable name for the site. This is not used by Wagtail itself, but is suitable for use on the site front-end, such as in <title> elements.

For example: Rod's World of Birds

root_page¶

(foreign key to Page)

This is a link to the root page of the site. This page will be what appears at the / URL on the site and would usually be a homepage.

is_default_site¶

(boolean)

This is set to True if the site is the default. Only one site can be the default.

The default site is used as a fallback in situations where a site with the required hostname/port couldn’t be found.

Methods and properties¶

class wagtail.models.Site

static find_for_request(request)¶

Find the site object responsible for responding to this HTTP request object. Try:

• unique hostname first

• then hostname and port

• if there is no matching hostname at all, or no matching hostname:port combination, fall back to the unique default site, or raise an exception

NB this means that high-numbered ports on an extant hostname may still be routed to a different hostname which is set as the default

The site will be cached via request._wagtail_site

root_url¶

This returns the URL of the site. It is calculated from the hostname and the port fields.

The scheme part of the URL is calculated based on value of the port field:

• 80 = http://

• 443 = https://

• Everything else will use the http:// scheme and the port will be appended to the end of the hostname (for example http://mysite.com:8000/)

static get_site_root_paths()¶

Return a list of SiteRootPath instances, most specific path first - used to translate url_paths into actual URLs with hostnames

Each root path is an instance of the SiteRootPath named tuple, and have the following attributes:

• site_id - The ID of the Site record

• root_path - The internal URL path of the site’s home page (for example ‘/home/’)

• root_url - The scheme/domain name of the site (for example ‘https://www.example.com/’)

• language_code - The language code of the site (for example ‘en’)

Changing WAGTAIL_CONTENT_LANGUAGES¶

Languages can be added or removed from WAGTAIL_CONTENT_LANGUAGES over time.

Before removing an option from WAGTAIL_CONTENT_LANGUAGES, it’s important that the Locale record is updated to a use a different content language or is deleted. Any Locale instances that have invalid content languages are automatically filtered out from all database queries making them unable to be edited or viewed.

Methods and properties¶

class wagtail.models.Locale

language_code¶

The language code that represents this locale

The language code can either be a language code on its own (such as en, fr), or it can include a region code (such as en-gb, fr-fr).

classmethod get_default()¶

Returns the default Locale based on the site’s LANGUAGE_CODE setting

classmethod get_active()¶

Returns the Locale that corresponds to the currently activated language in Django.

language_name¶

Uses data from django.conf.locale to return the language name in English. For example, if the object’s language_code were "fr", the return value would be "French".

Raises KeyError if django.conf.locale has no information for the object’s language_code value.

language_name_local¶

Uses data from django.conf.locale to return the language name in the language itself. For example, if the language_code were "fr" (French), the return value would be "français".

Raises KeyError if django.conf.locale has no information for the object’s language_code value.

language_name_localized¶

Uses data from django.conf.locale to return the language name in the currently active language. For example, if language_code were "fr" (French), and the active language were "da" (Danish), the return value would be "Fransk".

Raises KeyError if django.conf.locale has no information for the object’s language_code value.

is_default¶

Returns a boolean indicating whether this object is the default locale.

is_active¶

Returns a boolean indicating whether this object is the currently active locale.

is_bidi¶

Returns a boolean indicating whether the language is bi-directional.

get_display_name() → str¶

Database fields¶

The locale and translation_key fields have a unique key constraint to prevent the object being translated into a language more than once.

class wagtail.models.TranslatableMixin¶

locale¶

(Foreign Key to Locale)

For pages, this defaults to the locale of the parent page.

translation_key¶

(uuid)

A UUID that is randomly generated whenever a new model instance is created. This is shared with all translations of that instance so can be used for querying translations.

Methods and properties¶

class wagtail.models.TranslatableMixin

get_translations(inclusive=False)¶

Returns a queryset containing the translations of this instance.

get_translation(locale)¶

Finds the translation in the specified locale.

If there is no translation in that locale, this raises a model.DoesNotExist exception.

get_translation_or_none(locale)¶

Finds the translation in the specified locale.

If there is no translation in that locale, this returns None.

has_translation(locale)¶

Returns True if a translation exists in the specified locale.

copy_for_translation(locale, exclude_fields=None)¶

Creates a copy of this instance with the specified locale.

Note that the copy is initially unsaved.

classmethod get_translation_model()¶

Returns this model’s “Translation model”.

The “Translation model” is the model that has the locale and translation_key fields. Typically this would be the current model, but it may be a super-class if multi-table inheritance is in use (as is the case for wagtailcore.Page).

localized¶

Finds the translation in the current active language.

If there is no translation in the active language, self is returned.

Note: This will not return the translation if it is in draft. If you want to include drafts, use the .localized_draft attribute instead.

Methods and properties¶

class wagtail.models.PreviewableMixin¶

preview_modes¶

A list of (internal_name, display_name) tuples for the modes in which this object can be displayed for preview/moderation purposes. Ordinarily an object will only have one display mode, but subclasses can override this - for example, a page containing a form might have a default view of the form, and a post-submission ‘thank you’ page. Set to [] to completely disable previewing for this model.

default_preview_mode¶

The default preview mode to use in live preview. This default is also used in areas that do not give the user the option of selecting a mode explicitly, e.g. in the moderator approval workflow. If preview_modes is empty, an IndexError will be raised.

is_previewable()¶

Returns True if at least one preview mode is specified in preview_modes.

get_preview_context(request, mode_name)¶

Returns a context dictionary for use in templates for previewing this object.

get_preview_template(request, mode_name)¶

Returns a template to be used when previewing this object.

Subclasses of PreviewableMixin must override this method to return the template name to be used in the preview. Alternatively, subclasses can also override the serve_preview method to completely customise the preview rendering logic.

serve_preview(request, mode_name)¶

Returns an HTTP response for use in object previews.

This method can be overridden to implement custom rendering and/or routing logic.

Any templates rendered during this process should use the request object passed here - this ensures that request.user and other properties are set appropriately for the wagtail user bar to be displayed/hidden. This request will always be a GET.

Database fields¶

class wagtail.models.RevisionMixin¶

latest_revision¶

(foreign key to Revision)

This points to the latest revision created for the object. This reference is stored in the database for performance optimisation.

Methods and properties¶

class wagtail.models.RevisionMixin

revisions¶

Returns revisions that belong to the object.

Subclasses should define a GenericRelation to Revision and override this property to return that GenericRelation. This allows subclasses to customise the related_query_name of the GenericRelation and add custom logic (e.g. to always use the specific instance in Page).

save_revision(user=None, submitted_for_moderation=False, approved_go_live_at=None, changed=True, log_action=False, previous_revision=None, clean=True)¶

Creates and saves a revision.

Parameters:

• user – The user performing the action.

• submitted_for_moderation – Deprecated – Indicates whether the object was submitted for moderation.

• approved_go_live_at – The date and time the revision is approved to go live.

• changed – Indicates whether there were any content changes.

• log_action – Flag for logging the action. Pass True to also create a log entry. Can be passed an action string. Defaults to "wagtail.edit" when no previous_revision param is passed, otherwise "wagtail.revert".

• previous_revision (Revision) – Indicates a revision reversal. Should be set to the previous revision instance.

• clean – Set this to False to skip cleaning object content before saving this revision.

Returns:

The newly created revision.

get_latest_revision_as_object()¶

Returns the latest revision of the object as an instance of the model. If no latest revision exists, returns the object itself.

with_content_json(content)¶

Returns a new version of the object with field values updated to reflect changes in the provided content (which usually comes from a previously-saved revision).

Certain field values are preserved in order to prevent errors if the returned object is saved, such as id. The following field values are also preserved, as they are considered to be meaningful to the object as a whole, rather than to a specific revision:

• latest_revision

If TranslatableMixin is applied, the following field values are also preserved:

• translation_key

• locale

Database fields¶

class wagtail.models.DraftStateMixin¶

live¶

(boolean)

A boolean that is set to True if the object is published.

Note: this field defaults to True meaning that any objects that are created programmatically will be published by default.

live_revision¶

(foreign key to Revision)

This points to the revision that is currently live.

has_unpublished_changes¶

(boolean)

A boolean that is set to True when the object is either in draft or published with draft changes.

first_published_at¶

(date/time)

The date/time when the object was first published.

last_published_at¶

(date/time)

The date/time when the object was last published.

Methods and properties¶

class wagtail.models.DraftStateMixin

publish(revision, user=None, changed=True, log_action=True, previous_revision=None, skip_permission_checks=False)¶

Publish a revision of the object by applying the changes in the revision to the live object.

Parameters:

• revision (Revision) – Revision to publish.

• user – The publishing user.

• changed – Indicated whether content has changed.

• log_action – Flag for the logging action, pass False to skip logging.

• previous_revision (Revision) – Indicates a revision reversal. Should be set to the previous revision instance.

unpublish(set_expired=False, commit=True, user=None, log_action=True)¶

Unpublish the live object.

Parameters:

• set_expired – Mark the object as expired.

• commit – Commit the changes to the database.

• user – The unpublishing user.

• log_action – Flag for the logging action, pass False to skip logging.

with_content_json(content)¶

Similar to RevisionMixin.with_content_json(), but with the following fields also preserved:

• live

• has_unpublished_changes

• first_published_at

Database fields¶

class wagtail.models.LockableMixin¶

locked¶

(boolean)

A boolean that is set to True if the object is locked.

locked_at¶

(date/time)

The date/time when the object was locked.

locked_by¶

(foreign key to user model)

The user who locked the object.

Methods and properties¶

class wagtail.models.LockableMixin

get_lock()¶

Returns a sub-class of BaseLock if the instance is locked, otherwise None.

with_content_json(content)¶

Similar to RevisionMixin.with_content_json(), but with the following fields also preserved:

• locked

• locked_at

• locked_by

Methods and properties¶

class wagtail.models.WorkflowMixin¶

classmethod get_default_workflow()¶

Returns the active workflow assigned to the model.

For non-Page models, workflows are assigned to the model’s content type, thus shared across all instances instead of being assigned to individual instances (unless get_workflow() is overridden).

This method is used to determine the workflow to use when creating new instances of the model. On Page models, this method is unused as the workflow can be determined from the parent page’s workflow.

has_workflow¶

Returns True if the object has an active workflow assigned, otherwise False.

get_workflow()¶

Returns the active workflow assigned to the object.

workflow_states¶

Returns workflow states that belong to the object.

To allow filtering WorkflowState queries by the object, subclasses should define a GenericRelation to WorkflowState with the desired related_query_name. This property can be replaced with the GenericRelation or overridden to allow custom logic, which can be useful if the model has inheritance.

workflow_in_progress¶

Returns True if a workflow is in progress on the current object, otherwise False.

current_workflow_state¶

Returns the in progress or needs changes workflow state on this object, if it exists.

current_workflow_task_state¶

Returns (specific class of) the current task state of the workflow on this object, if it exists.

current_workflow_task¶

Returns (specific class of) the current task in progress on this object, if it exists.

Database fields¶

class wagtail.models.Revision¶

content_object¶

(generic foreign key)

The object this revision belongs to. For page revisions, the object is an instance of the specific class.

content_type¶

(foreign key to ContentType)

The content type of the object this revision belongs to. For page revisions, this means the content type of the specific page type.

base_content_type¶

(foreign key to ContentType)

The base content type of the object this revision belongs to. For page revisions, this means the content type of the Page model.

object_id¶

(string)

The primary key of the object this revision belongs to.

submitted_for_moderation¶

(boolean)

True if this revision is in moderation.

Changed in version 5.2: This field is only used for the legacy moderation system. It has been deprecated and will be removed in a future release.

created_at¶

(date/time)

The time the revision was created.

user¶

(foreign key to user model)

The user that created the revision.

content¶

(dict)

The JSON content for the object at the time the revision was created.

Managers¶

class wagtail.models.Revision

objects¶

This default manager is used to retrieve all of the Revision objects in the database. It also provides a for_instance() method that lets you query for revisions of a specific object.

Example:

Revision.objects.all()
Revision.objects.for_instance(my_object)

page_revisions¶

This manager extends the default manager and is used to retrieve all of the Revision objects that belong to pages.

Example:

Revision.page_revisions.all()

submitted_revisions¶

This manager extends the default manager and is used to retrieve all of the Revision objects that are awaiting moderator approval.

Example:

Revision.submitted_revisions.all()

Changed in version 5.2: This manager is only used for the legacy moderation system. It has been deprecated and will be removed in a future release.

Methods and properties¶

class wagtail.models.Revision

as_object()¶

This method retrieves this revision as an instance of its object’s specific class. If the revision belongs to a page, it will be an instance of the Page’s specific subclass.

approve_moderation(user=None)¶

Calling this on a revision that’s in moderation will mark it as approved and publish it.

Changed in version 5.2: This method is only used for the legacy moderation system. It has been deprecated and will be removed in a future release.

reject_moderation(user=None)¶

Calling this on a revision that’s in moderation will mark it as rejected.

Changed in version 5.2: This method is only used for the legacy moderation system. It has been deprecated and will be removed in a future release.

is_latest_revision()¶

Returns True if this revision is the object’s latest revision.

publish(user=None, changed=True, log_action=True, previous_revision=None, skip_permission_checks=False)¶

Calling this will copy the content of this revision into the live object. If the object is in draft, it will be published.

base_content_object¶

This property returns the object this revision belongs to as an instance of the base class.

Database fields¶

class wagtail.models.GroupPagePermission¶

group¶

(foreign key to django.contrib.auth.models.Group)

page¶

(foreign key to Page)

permission_type¶

(choice list)

Database fields¶

class wagtail.models.PageViewRestriction¶

page¶

(foreign key to Page)

password¶

(text)

Database fields¶

class wagtail.models.Orderable¶

sort_order¶

(number)

Database fields¶

class wagtail.models.Workflow¶

name¶

(text)

Human-readable name of the workflow.

active¶

(boolean)

Whether or not the workflow is active: active workflows can be added to pages and snippets, and started. Inactive workflows cannot.

Methods and properties¶

class wagtail.models.Workflow

start(obj, user)¶

Initiates a workflow by creating an instance of WorkflowState

tasks¶

Returns all Task instances linked to this workflow

deactivate(user=None)¶

Sets the workflow as inactive, and cancels all in progress instances of WorkflowState linked to this workflow

all_pages()¶

Returns a queryset of all the pages that this Workflow applies to.

Database fields¶

class wagtail.models.WorkflowState¶

content_object¶

(generic foreign key)

The object on which the workflow has been started. For page workflows, the object is an instance of the base Page model.

content_type¶

(foreign key to ContentType)

The content type of the object this workflow state belongs to. For page workflows, this means the content type of the specific page type.

base_content_type¶

(foreign key to ContentType)

The base content type of the object this workflow state belongs to. For page workflows, this means the content type of the Page model.

object_id¶

(string)

The primary key of the object this revision belongs to.

workflow¶

(foreign key to Workflow)

The workflow whose state the WorkflowState represents

status¶

(text)

The current status of the workflow (options are WorkflowState.STATUS_CHOICES)

created_at¶

(date/time)

When this instance of WorkflowState was created - when the workflow was started

requested_by¶

(foreign key to user model)

The user who started this workflow

current_task_state¶

(foreign key to TaskState)

The TaskState model for the task the workflow is currently at: either completing (if in progress) or the final task state (if finished)

Methods and properties¶

class wagtail.models.WorkflowState

STATUS_CHOICES¶

A tuple of the possible options for the status field, and their verbose names. Options are STATUS_IN_PROGRESS, STATUS_APPROVED, STATUS_CANCELLED and STATUS_NEEDS_CHANGES.

update(user=None, next_task=None)¶

Checks the status of the current task, and progresses (or ends) the workflow if appropriate. If the workflow progresses, next_task will be used to start a specific task next if provided.

get_next_task()¶

Returns the next active task, which has not been either approved or skipped

cancel(user=None)¶

Cancels the workflow state

finish(user=None)¶

Finishes a successful in progress workflow, marking it as approved and performing the on_finish action

resume(user=None)¶

Put a STATUS_NEEDS_CHANGES workflow state back into STATUS_IN_PROGRESS, and restart the current task

copy_approved_task_states_to_revision(revision)¶

This creates copies of previously approved task states with revision set to a different revision.

all_tasks_with_status()¶

Returns a list of Task objects that are linked with this workflow state’s workflow. The status of that task in this workflow state is annotated in the .status field. And a displayable version of that status is annotated in the .status_display field.

This is different to querying TaskState as it also returns tasks that haven’t been started yet (so won’t have a TaskState).

revisions()¶

Returns all revisions associated with task states linked to the current workflow state

Database fields¶

class wagtail.models.Task¶

name¶

(text)

Human-readable name of the task.

active¶

(boolean)

Whether or not the task is active: active workflows can be added to workflows, and started. Inactive workflows cannot, and are skipped when in an existing workflow.

content_type¶

(foreign key to django.contrib.contenttypes.models.ContentType)

A foreign key to the ContentType object that represents the specific model of this task.

Methods and properties¶

class wagtail.models.Task

workflows¶

Returns all Workflow instances that use this task

active_workflows¶

Return a QuerySet` of active workflows that this task is part of

task_state_class¶

The specific task state class to generate to store state information for this task. If not specified, this will be TaskState.

classmethod get_verbose_name()¶

Returns the human-readable “verbose name” of this task model e.g “Group approval task”.

specific¶

Returns this object in its most specific subclassed form with all field values fetched from the database. The result is cached in memory.

start(workflow_state, user=None)¶

Start this task on the provided workflow state by creating an instance of TaskState

on_action(task_state, user, action_name, **kwargs)¶

Performs an action on a task state determined by the action_name string passed

user_can_access_editor(obj, user)¶

Returns True if a user who would not normally be able to access the editor for the object should be able to if the object is currently on this task. Note that returning False does not remove permissions from users who would otherwise have them.

user_can_lock(obj, user)¶

Returns True if a user who would not normally be able to lock the object should be able to if the object is currently on this task. Note that returning False does not remove permissions from users who would otherwise have them.

user_can_unlock(obj, user)¶

Returns True if a user who would not normally be able to unlock the object should be able to if the object is currently on this task. Note that returning False does not remove permissions from users who would otherwise have them.

locked_for_user(obj, user)¶

Returns True if the object should be locked to a given user’s edits. This can be used to prevent editing by non-reviewers.

get_actions(obj, user)¶

Get the list of action strings (name, verbose_name, whether the action requires additional data - see get_form_for_action) for actions the current user can perform for this task on the given object. These strings should be the same as those able to be passed to on_action

get_task_states_user_can_moderate(user, **kwargs)¶

Returns a QuerySet of the task states the current user can moderate

deactivate(user=None)¶

Set active to False and cancel all in progress task states linked to this task

get_form_for_action(action)¶

get_template_for_action(action)¶

classmethod get_description()¶

Returns the task description.

Database fields¶

class wagtail.models.TaskState¶

workflow_state¶

(foreign key to WorkflowState)

The workflow state which started this task state.

revision¶

(foreign key to Revision)

The revision this task state was created on.

task¶

(foreign key to Task)

The task that this task state is storing state information for.

status¶

(text)

The completion status of the task on this revision. Options are available in TaskState.STATUS_CHOICES)

content_type¶

(foreign key to django.contrib.contenttypes.models.ContentType)

A foreign key to the ContentType object that represents the specific model of this task.

started_at¶

(date/time)

When this task state was created.

finished_at¶

(date/time)

When this task state was cancelled, rejected, or approved.

finished_by¶

(foreign key to user model)

The user who completed (cancelled, rejected, approved) the task.

comment¶

(text)

A text comment, typically added by a user when the task is completed.

Methods and properties¶

class wagtail.models.TaskState

STATUS_CHOICES¶

A tuple of the possible options for the status field, and their verbose names. Options are STATUS_IN_PROGRESS, STATUS_APPROVED, STATUS_CANCELLED, STATUS_REJECTED and STATUS_SKIPPED.

exclude_fields_in_copy¶

A list of fields not to copy when the TaskState.copy() method is called.

specific¶

Returns this object in its most specific subclassed form with all field values fetched from the database. The result is cached in memory.

approve(user=None, update=True, comment='')¶

Approve the task state and update the workflow state

reject(user=None, update=True, comment='')¶

Reject the task state and update the workflow state

task_type_started_at¶

Finds the first chronological started_at for successive TaskStates - ie started_at if the task had not been restarted

cancel(user=None, resume=False, comment='')¶

Cancel the task state and update the workflow state. If resume is set to True, then upon update the workflow state is passed the current task as next_task, causing it to start a new task state on the current task if possible

copy(update_attrs=None, exclude_fields=None)¶

Copy this task state, excluding the attributes in the exclude_fields list and updating any attributes to values specified in the update_attrs dictionary of attribute: new value pairs

get_comment()¶

Returns a string that is displayed in workflow history.

This could be a comment by the reviewer, or generated. Use mark_safe to return HTML.

Database fields¶

class wagtail.models.WorkflowTask¶

workflow¶

(foreign key to Workflow)

task¶

(foreign key to Task)

sort_order¶

(number)

The ordering of the task in the workflow.

Database fields¶

class wagtail.models.WorkflowPage¶

workflow¶

(foreign key to Workflow)

page¶

(foreign key to Page)

Database fields¶

class wagtail.models.WorkflowContentType¶

workflow¶

(foreign key to Workflow)

content_type¶

(foreign key to ContentType)

A foreign key to the ContentType object that represents the model that is assigned to the workflow.

Database fields¶

class wagtail.models.BaseLogEntry¶

content_type¶

(foreign key to django.contrib.contenttypes.models.ContentType)

A foreign key to the ContentType object that represents the specific model of this model.

label¶

(text)

The object title at the time of the entry creation

Note: Wagtail will attempt to use get_admin_display_title or the string representation of the object passed to log_action()

user¶

(foreign key to user model)

A foreign key to the user that triggered the action.

revision¶

(foreign key to Revision)

A foreign key to the current revision.

data¶

(dict)

The JSON representation of any additional details for each action. For example source page id and title when copying from a page. Or workflow id/name and next step id/name on a workflow transition

timestamp¶

(date/time)

The date/time when the entry was created.

content_changed¶

(boolean)

A boolean that can set to True when the content has changed.

deleted¶

(boolean)

A boolean that can set to True when the object is deleted. Used to filter entries in the Site History report.

Methods and properties¶

class wagtail.models.BaseLogEntry

user_display_name¶

Returns the display name of the associated user; get_full_name if available and non-empty, otherwise get_username. Defaults to ‘system’ when none is provided

comment¶

object_verbose_name¶

object_id()¶

Database fields¶

class wagtail.models.PageLogEntry¶

page¶

(foreign key to Page)

A foreign key to the page the action is performed on.

Database fields¶

class wagtail.models.Comment¶

page¶

(parental key to Page)

A parental key to the page the comment has been added to.

user¶

(foreign key to user model)

A foreign key to the user who added this comment.

text¶

(text)

The text content of the comment.

contentpath¶

(text)

The path to the field or streamfield block the comment is attached to, in the form field or field.streamfield_block_id.

position¶

(text)

An identifier for the position of the comment within its field. The format used is determined by the field.

created_at¶

(date/time)

The date/time when the comment was created.

updated_at¶

(date/time)

The date/time when the comment was updated.

revision_created¶

(foreign key to Revision)

A foreign key to the revision on which the comment was created.

resolved_at¶

(date/time)

The date/time when the comment was resolved, if any.

resolved_by¶

(foreign key to user model)

A foreign key to the user who resolved this comment, if any.

Database fields¶

class wagtail.models.CommentReply¶

comment¶

(parental key to Comment)

A parental key to the comment that started the thread.

user¶

(foreign key to user model)

A foreign key to the user who added this comment.

text¶

(text)

The text content of the comment.

created_at¶

(date/time)

The date/time when the comment was created.

updated_at¶

(date/time)

The date/time when the comment was updated.

Database fields¶

class wagtail.models.PageSubscription¶

page¶

(parental key to Page)

user¶

(foreign key to user model)

comment_notifications¶

(boolean)

Whether the user should receive comment notifications for all comments, or just comments in threads they participate in.