We will need to use the FormPageSelectorHelper class, which we will need to load using the Loader library.

This recipe will need to be written inside of an HTML form somewhere in your site. We have created a basic single page for this purpose, which can be downloaded with the code from the website for this book. To install the single page, copy the code for this recipe to your concrete5 site directory and visit /dashboard/pages/single. Add a new single page with a path of /example.

concrete5 includes a helper to generate the necessary JavaScript and HTML text needed to show the sitemap selector widget. We will use the Loader class to include and return the PageSelectorHelper class, which will then return the entire HTML that we need. The steps are as follows:

The selectPage function returns the HTML and JavaScript necessary to produce a page selector field. There is only one parameter required, and that is a string indicating the name of the field. concrete5 will add a hidden <input> element to the form, which will allow the selected page ID to be read from a POST request.

In this example, once the form is submitted, you could retrieve the selected page ID by looking in the $_POST super variable.

$pageId = $_POST['page_id'];

You can specify a page ID in the optional second parameter, which will populate the page selector with an existing page.

$page = Page::getByCollectionPath('/about-us');
echo $pageSelector->selectPage('page_id', $page->getCollectionID());

The pageSelector helper also has a function to display a sitemap in a modal window.

$args = array(
'display_mode' => 'full'
);
$pageSelector->sitemap($args);

Note that the sitemap() function loads an element, which is automatically printed to the screen, so there is no need to echo or print the result.