An alternate Document
model can be used to add custom behaviour and additional fields.
You need to complete the following steps in your project to do this:
wagtail.documents.models.AbstractDocument
. This is where you would add additional fields.WAGTAILDOCS_DOCUMENT_MODEL
to the new model.Here’s an example:
# models.py from django.db import models from wagtail.documents.models import Document, AbstractDocument class CustomDocument(AbstractDocument): # Custom field example: source = models.CharField( max_length=255, blank=True, null=True ) admin_form_fields = Document.admin_form_fields + ( # Add all custom fields names to make them appear in the form: 'source', )
Then in your settings module:
# Ensure that you replace app_label with the app you placed your custom # model in. WAGTAILDOCS_DOCUMENT_MODEL = 'app_label.CustomDocument'
Note
Migrating from the builtin document model
When changing an existing site to use a custom document model, no documents will be copied to the new model automatically. Copying old documents to the new model would need to be done manually with a data migration.
Any templates that reference the builtin document model will still continue to work as before.
© 2014-present Torchbox Ltd and individual contributors.
All rights are reserved.
Licensed under the BSD License.
https://docs.wagtail.org/en/stable/advanced_topics/documents/custom_document_model.html