Support overriding default item in page action menu

docs/reference/hooks.rst

@@ -524,7 +524,7 @@ Hooks for customising the way users are directed through the process of creating
 
   Add an item to the popup menu of actions on the page creation and edit views. The callable passed to this hook must return an instance of ``wagtail.admin.action_menu.ActionMenuItem``. The following attributes and methods are available to be overridden on subclasses of ``ActionMenuItem``:
 
-  :order: an integer (default 100) which determines the item's position in the menu. Can also be passed as a keyword argument to the object constructor
+  :order: an integer (default 100) which determines the item's position in the menu. Can also be passed as a keyword argument to the object constructor. The lowest-numbered item in this sequence will be selected as the default menu item; as standard, this is "Save draft" (which has an ``order`` of 0).
   :label: the displayed text of the menu item
   :get_url: a method which returns a URL for the menu item to link to; by default, returns ``None`` which causes the menu item to behave as a form submit button instead
   :name: value of the ``name`` attribute of the submit button, if no URL is specified
@@ -566,12 +566,28 @@ Hooks for customising the way users are directed through the process of creating
 
   Modify the final list of action menu items on the page creation and edit views. The callable passed to this hook receives a list of ``ActionMenuItem`` objects, a request object and a context dictionary as per ``register_page_action_menu_item``, and should modify the list of menu items in-place.
 
+
   .. code-block:: python
 
     @hooks.register('construct_page_action_menu')
     def remove_submit_to_moderator_option(menu_items, request, context):
         menu_items[:] = [item for item in menu_items if item.name != 'action-submit']
 
+
+  The order of items in this list determines the menu ordering, and the first item in the list will be selected as the default action. For example, to change the default action to Publish:
+
+  .. code-block:: python
+
+    @hooks.register('construct_page_action_menu')
+    def make_publish_default_action(menu_items, request, context):
+        for (index, item) in enumerate(menu_items):
+            if item.name == 'action-publish':
+                # move to top of list
+                menu_items.pop(index)
+                menu_items.insert(0, item)
+                break
+
+
 .. construct_page_listing_buttons:
 
 ``construct_page_listing_buttons``

docs/releases/2.7.rst

@@ -86,6 +86,30 @@ This release introduces a new setting :ref:`WAGTAILDOCS_SERVE_METHOD <wagtaildoc
 In Wagtail 2.7, the default behaviour on remote storage backends is to redirect to the storage's underlying URL after performing the permission check. If this is unsuitable for your project (for example, your storage provider is configured to block public access, or revealing its URL would be a security risk) you can revert to the previous behaviour by setting ``WAGTAILDOCS_SERVE_METHOD`` to ``'serve_view'``.
 
 
+Template change for page action menu hooks
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When customising the action menu on the page edit view through the :ref:`register_page_action_menu_item <register_page_action_menu_item>` or :ref:`construct_page_action_menu <construct_page_action_menu>` hook, the ``ActionMenuItem`` object's ``template`` attribute or ``render_html`` method can be overridden to customise the menu item's HTML. As of Wagtail 2.7, the HTML returned from these should *not* include the enclosing ``<li>`` element.
+
+Any add-on library that uses this feature and needs to preserve backward compatibility with previous Wagtail versions can conditionally reinsert the ``<li>`` wrapper through its ``render_html`` method - for example:
+
+  .. code-block:: python
+
+    from django.utils.html import format_html
+    from wagtail import VERSION as WAGTAIL_VERSION
+    from wagtail.admin.action_menu import ActionMenuItem
+
+    class CustomMenuItem(ActionMenuItem):
+        template = 'myapp/my_menu_item.html'
+
+        def render_html(self, request, parent_context):
+            html = super().render_html(request, parent_context)
+            if WAGTAIL_VERSION < (2, 7):
+                html = format_html('<li>{}</li>', html)
+            return html
+
+
+
 ``wagtail.admin.utils`` and ``wagtail.admin.decorators`` modules deprecated
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

wagtail/admin/action_menu.py

@@ -57,6 +57,7 @@ def render_html(self, request, parent_context):
 
 
 class PublishMenuItem(ActionMenuItem):
+    label = _("Publish")
     name = 'action-publish'
     template = 'wagtailadmin/pages/action_menu/publish.html'
 
@@ -121,6 +122,31 @@ def get_url(self, request, context):
         return reverse('wagtailadmin_pages:delete', args=(context['page'].id,))
 
 
+class SaveDraftMenuItem(ActionMenuItem):
+    name = 'action-save-draft'
+    label = _("Save Draft")
+    template = 'wagtailadmin/pages/action_menu/save_draft.html'
+
+    def get_context(self, request, parent_context):
+        context = super().get_context(request, parent_context)
+        context['is_revision'] = (context['view'] == 'revisions_revert')
+        return context
+
+
+class PageLockedMenuItem(ActionMenuItem):
+    name = 'action-page-locked'
+    label = _("Page locked")
+    template = 'wagtailadmin/pages/action_menu/page_locked.html'
+
+    def is_shown(self, request, context):
+        return ('page' in context) and (context['page'].locked)
+
+    def get_context(self, request, parent_context):
+        context = super().get_context(request, parent_context)
+        context['is_revision'] = (context['view'] == 'revisions_revert')
+        return context
+
+
 BASE_PAGE_ACTION_MENU_ITEMS = None
 
 
@@ -133,6 +159,8 @@ def _get_base_page_action_menu_items():
 
     if BASE_PAGE_ACTION_MENU_ITEMS is None:
         BASE_PAGE_ACTION_MENU_ITEMS = [
+            PageLockedMenuItem(order=-10000),
+            SaveDraftMenuItem(order=0),
             UnpublishMenuItem(order=10),
             DeleteMenuItem(order=20),
             PublishMenuItem(order=30),
@@ -163,13 +191,19 @@ def __init__(self, request, **kwargs):
         for hook in hooks.get_hooks('construct_page_action_menu'):
             hook(self.menu_items, self.request, self.context)
 
+        try:
+            self.default_item = self.menu_items.pop(0)
+        except IndexError:
+            self.default_item = None
+
     def render_html(self):
         return render_to_string(self.template, {
+            'default_menu_item': self.default_item.render_html(self.request, self.context),
             'show_menu': bool(self.menu_items),
             'rendered_menu_items': [
                 menu_item.render_html(self.request, self.context)
                 for menu_item in self.menu_items
-            ]
+            ],
         }, request=self.request)
 
     @cached_property

wagtail/admin/templates/wagtailadmin/pages/action_menu/menu.html

@@ -1,6 +1,13 @@
+{% if default_menu_item %}
+    {{ default_menu_item }}
+{% endif %}
 {% if show_menu %}
     <div class="dropdown-toggle icon icon-arrow-up"></div>
     <ul>
-        {% for item in rendered_menu_items %}{{ item }}{% endfor %}
+        {% for item in rendered_menu_items %}
+            <li>
+                 {{ item }}
+            </li>
+        {% endfor %}
     </ul>
 {% endif %}

wagtail/admin/templates/wagtailadmin/pages/action_menu/menu_item.html

@@ -1,7 +1,5 @@
-<li>
-    {% if url %}
-        <a href="{{ url }}">{{ label }}</a>
-    {% else %}
-        <input type="submit" name="{{ name }}" value="{{ label }}" class="button" />
-    {% endif %}
-</li>
+{% if url %}
+    <a class="button" href="{{ url }}">{{ label }}</a>
+{% else %}
+    <input type="submit" name="{{ name }}" value="{{ label }}" class="button" />
+{% endif %}

wagtail/admin/templates/wagtailadmin/pages/action_menu/page_locked.html

@@ -0,0 +1,2 @@
+{% load i18n %}
+<button type="submit" class="button action-save {% if is_revision %}warning{% endif %}" disabled>{% trans 'Page locked' %}</button>

wagtail/admin/templates/wagtailadmin/pages/action_menu/publish.html

@@ -1,4 +1,2 @@
 {% load i18n %}
-<li>
-    <button type="submit" name="action-publish" value="action-publish" class="button button-longrunning {% if is_revision %}warning{% endif %}" data-clicked-text="{% trans 'Publishing…' %}"><span class="icon icon-spinner"></span><em>{% if is_revision %}{% trans 'Publish this revision' %}{% else %}{% trans 'Publish' %}{% endif %}</em></button>
-</li>
+<button type="submit" name="action-publish" value="action-publish" class="button button-longrunning {% if is_revision %}warning{% endif %}" data-clicked-text="{% trans 'Publishing…' %}"><span class="icon icon-spinner"></span><em>{% if is_revision %}{% trans 'Publish this revision' %}{% else %}{% trans 'Publish' %}{% endif %}</em></button>

wagtail/admin/templates/wagtailadmin/pages/action_menu/save_draft.html

@@ -0,0 +1,2 @@
+{% load i18n %}
+<button type="submit" class="button action-save button-longrunning {% if is_revision %}warning{% endif %}" data-clicked-text="{% trans 'Saving…' %}"><span class="icon icon-spinner"></span><em>{% if is_revision %}{% trans 'Replace current draft' %}{% else %}{% trans 'Save draft' %}{% endif %}</em></button>

wagtail/admin/templates/wagtailadmin/pages/create.html

@@ -26,12 +26,11 @@ <h1 class="icon icon-doc-empty-inverse">
         <footer role="contentinfo">
             <nav aria-label="{% trans 'Actions' %}">
                 <ul>
-                    <li class="actions">
-                        <div class="dropdown dropup dropdown-button match-width">
-                            <button type="submit" class="button action-save button-longrunning" data-clicked-text="{% trans 'Saving…' %}"><span class="icon icon-spinner"></span><em>{% trans 'Save draft' %}</em></button>
-                            {{ action_menu.render_html }}
-                        </div>
-                    </li>
+                  <li class="actions">
+                      <div class="dropdown dropup dropdown-button match-width {% if is_revision %}warning{% endif %}">
+                          {{ action_menu.render_html }}
+                      </div>
+                  </li>
 
                     <li class="preview">
                         {% trans 'Preview' as preview_label %}

wagtail/admin/templates/wagtailadmin/pages/edit.html

@@ -39,8 +39,6 @@ <h1 class="icon icon-doc-empty-inverse">
                 <ul>
                     <li class="actions">
                         <div class="dropdown dropup dropdown-button match-width {% if is_revision %}warning{% endif %}">
-                            <button type="submit" class="button action-save button-longrunning {% if is_revision %}warning{% endif %}" data-clicked-text="{% trans 'Saving…' %}" {% if page.locked %}disabled {% endif %}><span class="icon icon-spinner"></span><em>{% if page.locked %}{% trans 'Page locked' %}{% else %}{% if is_revision %}{% trans 'Replace current draft' %}{% else %}{% trans 'Save draft' %}{% endif %}{% endif %}</em></button>
-
                             {{ action_menu.render_html }}
                         </div>
                     </li>

wagtail/admin/tests/pages/test_edit_page.py

@@ -854,6 +854,36 @@ def hook_func(request, page):
         # page should be edited
         self.assertEqual(Page.objects.get(id=self.child_page.id).title, "I've been edited!")
 
+    def test_override_default_action_menu_item(self):
+        def hook_func(menu_items, request, context):
+            for (index, item) in enumerate(menu_items):
+                if item.name == 'action-publish':
+                    # move to top of list
+                    menu_items.pop(index)
+                    menu_items.insert(0, item)
+                    break
+
+        with self.register_hook('construct_page_action_menu', hook_func):
+            response = self.client.get(reverse('wagtailadmin_pages:edit', args=(self.single_event_page.id, )))
+
+        publish_button = '''
+            <button type="submit" name="action-publish" value="action-publish" class="button button-longrunning " data-clicked-text="Publishing…">
+                <span class="icon icon-spinner"></span><em>Publish</em>
+            </button>
+        '''
+        save_button = '''
+            <button type="submit" class="button action-save button-longrunning " data-clicked-text="Saving…" >
+                <span class="icon icon-spinner"></span><em>Save draft</em>
+            </button>
+        '''
+
+        # save button should be in a <li>
+        self.assertContains(response, "<li>%s</li>" % save_button, html=True)
+
+        # publish button should be present, but not in a <li>
+        self.assertContains(response, publish_button, html=True)
+        self.assertNotContains(response, "<li>%s</li>" % publish_button, html=True)
+
 
 class TestPageEditReordering(TestCase, WagtailTestUtils):
     def setUp(self):