All models that inherit from :class:`~wagtail.wagtailcore.models.Page` are given some extra QuerySet methods accessible from their .objects attribute.
Selecting only live pages
live_pages = Page.objects.live()Selecting published EventPages that are descendants of events_index
events = EventPage.objects.live().descendant_of(events_index)Getting a list of menu items
# This gets a QuerySet of live children of the homepage with ``show_in_menus`` set menu_items = homepage.get_children().live().in_menu()
.. automodule:: wagtail.wagtailcore.query
.. autoclass:: PageQuerySet
.. automethod:: live
Example:
.. code-block:: python
published_pages = Page.objects.live()
.. automethod:: not_live
Example:
.. code-block:: python
unpublished_pages = Page.objects.not_live()
.. automethod:: in_menu
Example:
.. code-block:: python
# Build a menu from live pages that are children of the homepage
menu_items = homepage.get_children().live().in_menu()
.. note::
To put your page in menus, set the show_in_menus flag to true:
.. code-block:: python
# Add 'my_page' to the menu
my_page.show_in_menus = True
.. automethod:: not_in_menu
.. automethod:: page
Example:
.. code-block:: python
# Append an extra page to a QuerySet
new_queryset = old_queryset | Page.objects.page(page_to_add)
.. automethod:: not_page
Example:
.. code-block:: python
# Remove a page from a QuerySet
new_queryset = old_queryset & Page.objects.not_page(page_to_remove)
.. automethod:: descendant_of
Example:
.. code-block:: python
# Get EventPages that are under the special_events Page
special_events = EventPage.objects.descendant_of(special_events_index)
# Alternative way
special_events = special_events_index.get_descendants()
.. automethod:: not_descendant_of
Example:
.. code-block:: python
# Get EventPages that are not under the archived_events Page
non_archived_events = EventPage.objects.not_descendant_of(archived_events_index)
.. automethod:: child_of
Example:
.. code-block:: python
# Get a list of sections
sections = Page.objects.child_of(homepage)
# Alternative way
sections = homepage.get_children()
.. automethod:: not_child_of
.. automethod:: ancestor_of
Example:
.. code-block:: python
# Get the current section
current_section = Page.objects.ancestor_of(current_page).child_of(homepage).first()
# Alternative way
current_section = current_page.get_ancestors().child_of(homepage).first()
.. automethod:: not_ancestor_of
Example:
.. code-block:: python
# Get the other sections
other_sections = Page.objects.not_ancestor_of(current_page).child_of(homepage)
.. automethod:: parent_of
.. automethod:: not_parent_of
.. automethod:: sibling_of
Example:
.. code-block:: python
# Get list of siblings
siblings = Page.objects.sibling_of(current_page)
# Alternative way
siblings = current_page.get_siblings()
.. automethod:: not_sibling_of
.. automethod:: public
See: :ref:`private_pages`
.. note::
This doesn't filter out unpublished pages. If you want to only have published public pages, use ``.live().public()``
Example:
.. code-block:: python
# Find all the pages that are viewable by the public
all_pages = Page.objects.live().public()
.. automethod:: not_public
.. automethod:: search
See: :ref:`wagtailsearch_searching_pages`
Example:
.. code-block:: python
# Search future events
results = EventPage.objects.live().filter(date__gt=timezone.now()).search("Hello")
.. automethod:: type
Example:
.. code-block:: python
# Find all pages that are of type AbstractEmailForm, or a descendant of it
form_pages = Page.objects.type(AbstractEmailForm)
.. automethod:: not_type
.. automethod:: exact_type
Example:
.. code-block:: python
# Find all pages that are of the exact type EventPage
event_pages = Page.objects.exact_type(EventPage)
.. automethod:: not_exact_type
Example:
.. code-block:: python
# Find all pages that are not of the exact type EventPage (but may be a subclass)
non_event_pages = Page.objects.not_exact_type(EventPage)
.. automethod:: unpublish
Example:
.. code-block:: python
# Unpublish current_page and all of its children
Page.objects.descendant_of(current_page, inclusive=True).unpublish()
.. automethod:: specific
Example:
.. code-block:: python
# Get the specific instance of all children of the hompage,
# in a minimum number of database queries.
homepage.get_children().specific()
See also: :py:attr:`Page.specific <wagtail.wagtailcore.models.Page.specific>`