wagtail/docs/advanced_topics/images/title_generation_on_upload.md

(images_title_generation_on_upload)=

Title generation on upload

When uploading an image, Wagtail takes the filename, removes the file extension, and populates the title field. This section is about how to customize this filename to title conversion.

The filename to title conversion is used on the single file widget, multiple upload widget, and within chooser modals.

You can also customize this same behavior for documents.

You can customize the resolved value of this title using a JavaScript event listener which will listen to the 'wagtail:images-upload' event.

The simplest way to add JavaScript to the editor is via the insert_global_admin_js hook, however, any JavaScript that adds the event listener will work.

DOM event

The event name to listen for is 'wagtail:images-upload'. It will be dispatched on the image upload form. The event's detail attribute will contain:

• data - An object which includes the title to be used. It is the filename with the extension removed.
• maxTitleLength - An integer (or null) which is the maximum length of the Image model title field.
• filename - The original filename without the extension removed.

To modify the generated Image title, access and update event.detail.data.title, no return value is needed.

For single image uploads, the custom event will only run if the title does not already have a value so that we do not overwrite whatever the user has typed.

You can prevent the default behavior by calling event.preventDefault(). For the single upload page or modals, this will not pre-fill any value into the title. For multiple uploads, this will avoid any title submission and use the filename title only (with file extension) as a title is required to save the image.

The event will 'bubble' up so that you can simply add a global document listener to capture all of these events, or you can scope your listener or handler logic as needed to ensure you only adjust titles in some specific scenarios.

See MDN for more information about custom JavaScript events.

Code examples

Removing any url unsafe characters from the title

# wagtail_hooks.py
from django.utils.safestring import mark_safe

from wagtail import hooks


@hooks.register("insert_global_admin_js")
def get_global_admin_js():
    return mark_safe(
    """
    <script>
    window.addEventListener('DOMContentLoaded', function () {
        document.addEventListener('wagtail:images-upload', function(event) {
            var newTitle = (event.detail.data.title || '').replace(/[^a-zA-Z0-9\s-]/g, "");
            event.detail.data.title = newTitle;
        });
    });
    </script>
    """
    )

Changing generated titles on the page editor only to remove dashes/underscores

Use the insert_editor_js hook instead so that this script will not run on the Image upload page, only on page editors.

# wagtail_hooks.py
from django.utils.safestring import mark_safe

from wagtail import hooks


@hooks.register("insert_editor_js")
def get_global_admin_js():
    return mark_safe(
    """
    <script>
    window.addEventListener('DOMContentLoaded', function () {
        document.addEventListener('wagtail:images-upload', function(event) {
            // replace dashes/underscores with a space
            var newTitle = (event.detail.data.title || '').replace(/(\s|_|-)/g, " ");
            event.detail.data.title = newTitle;
        });
    });
    </script>
    """
    )

Stopping pre-filling of title based on filename

# wagtail_hooks.py
from django.utils.safestring import mark_safe

from wagtail import hooks


@hooks.register("insert_global_admin_js")
def get_global_admin_js():
    return mark_safe(
    """
    <script>
    window.addEventListener('DOMContentLoaded', function () {
        document.addEventListener('wagtail:images-upload', function(event) {
            // will stop title pre-fill on single file uploads
            // will set the multiple upload title to the filename (with extension)
            event.preventDefault();
        });
    });
    </script>
    """
    )