From d620ce9656da6e5ce535d5621105434481bb9112 Mon Sep 17 00:00:00 2001
From: Matt Westcott <matt@west.co.tt>
Date: Wed, 10 Feb 2016 12:29:18 +0000
Subject: [PATCH] Document the construct_explorer_page_queryset hook

---
 docs/reference/hooks.rst | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/docs/reference/hooks.rst b/docs/reference/hooks.rst
index 420c538ed..12a4c90a8 100644
--- a/docs/reference/hooks.rst
+++ b/docs/reference/hooks.rst
@@ -340,6 +340,29 @@ Hooks for customising the way users are directed through the process of creating
       return items.append( UserbarPuppyLinkItem() )
 
 
+Page explorer
+------------
+
+.. _construct_explorer_page_queryset:
+
+``construct_explorer_page_queryset``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+  Called when rendering the page explorer view, to allow the page listing queryset to be customised. The callable passed into the hook will receive the parent page object, the current page queryset, and the request object, and must return a Page queryset (either the original one, or a new one).
+
+  .. code-block:: python
+
+    from wagtail.wagtailcore import hooks
+
+    @hooks.register('construct_explorer_page_queryset')
+    def show_my_profile_only(parent_page, pages, request):
+      # If we're in the 'user-profiles' section, only show the user's own profile
+      if parent_page.slug == 'user-profiles':
+        pages = pages.filter(owner=request.user)
+
+      return pages
+
+
 Page serving
 ------------