WireSitemapXML class

Turn-key ProcessWire module for easily configuring and rendering sitemap.xml output.

Part of the ProDevTools series of modules. See documentation.

Usage example (/site/templates/sitemap-xml.php):

$sitemap = $modules->get('WireSitemapXML');
$sitemap->addPage('/some/hidden/page/');
$sitemap->setPriorityByTemplate('home', 1.0);
$sitemap->setChangefreqByTemplate('blog', 'weekly');
$sitemap->setUrlSegmentsByTemplate('blog-post', [ 'foo', 'bar', 'baz' ]);
$sitemap->execute();
return $this->halt();

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the WireSitemapXML class also inherits all the methods and properties of: WireData and Wire.

Common

Name	Return	Summary
$sitemap->execute() $sitemap->execute() $sitemap->execute()	(nothing)	Render and output sitemap
$sitemap->setCacheTime() $sitemap->setCacheTime(int $cacheTime) $sitemap->setCacheTime(int $cacheTime)	`self`	Set how long sitemap should be cached

Pages

Name	Return	Summary
$sitemap->addChildrenSelector() $sitemap->addChildrenSelector($parent, string $selectorString) $sitemap->addChildrenSelector($parent, string $selectorString)	`$this`	Add selector for finding children of given $parent page
$sitemap->addPage() $sitemap->addPage($page) $sitemap->addPage($page, $priority = null, $changefreq = null)	`self`	Add additional page to include in sitemap (including its children, if any)
$sitemap->addParent() $sitemap->addParent($page) $sitemap->addParent($page)	`self`	Add hidden or removed page that you still want to be used as a parent (i.e. have children included)
$sitemap->allowPage() $sitemap->allowPage(Page $page) $sitemap->allowPage(Page $page)	`bool`	Allow page to be rendered in sitemap? (hookable)
$sitemap->allowParent() $sitemap->allowParent(Page $page) $sitemap->allowParent(Page $page)	`bool`	Allow children to be rendered for given page? (hookable)
$sitemap->getRemovedTemplates() $sitemap->getRemovedTemplates() $sitemap->getRemovedTemplates()	`array`	Get names of removed templates
$sitemap->getRootPage() $sitemap->getRootPage() $sitemap->getRootPage()	`Page`	Get the root/starting page for the sitemap (typically homepage)
$sitemap->removePage() $sitemap->removePage($page) $sitemap->removePage($page)	(nothing)	Set a page to remove from the sitemap
$sitemap->removeParent() $sitemap->removeParent($page) $sitemap->removeParent($page)	`self`	Add page that should have its children excluded from render, even if $page itself is included
$sitemap->removeTemplate() $sitemap->removeTemplate($template) $sitemap->removeTemplate($template)	`self`	Remove all pages using given template from the sitemap
$sitemap->setRootPage() $sitemap->setRootPage($page) $sitemap->setRootPage($page)	`$this`	Set the root (starting) page for sitemap

Changefreq

Name	Return	Summary
$sitemap->getChangefreq() $sitemap->getChangefreq(Page $page) $sitemap->getChangefreq(Page $page)	`string`	Get changefreq for given page
$sitemap->setChangefreqByPage() $sitemap->setChangefreqByPage($page, string $changefreq) $sitemap->setChangefreqByPage($page, string $changefreq)	`self`	Set changefreq (change frequency) by page
$sitemap->setChangefreqByTemplate() $sitemap->setChangefreqByTemplate($template, string $changefreq) $sitemap->setChangefreqByTemplate($template, string $changefreq)	`self`	Set changefreq by template
$sitemap->setChangefreqByTemplates() $sitemap->setChangefreqByTemplates(array $changefreqsByTemplate) $sitemap->setChangefreqByTemplates(array $changefreqsByTemplate)	`self`	Set changefreq by multiple templates at once

Priority

Name	Return	Summary
$sitemap->getPriority() $sitemap->getPriority(Page $page) $sitemap->getPriority(Page $page)	`string`	Get priority for given page
$sitemap->setPriorityByPage() $sitemap->setPriorityByPage($page, $priority) $sitemap->setPriorityByPage($page, $priority)	`self`	Set priority by page
$sitemap->setPriorityByTemplate() $sitemap->setPriorityByTemplate($template, $priority) $sitemap->setPriorityByTemplate($template, $priority)	`self`	Set priority by template
$sitemap->setPriorityByTemplates() $sitemap->setPriorityByTemplates(array $priorityByTemplate) $sitemap->setPriorityByTemplates(array $priorityByTemplate)	`self`	Set priority by multiple templates at once

URL segments

Name	Return	Summary
$sitemap->allowUrlSegment() $sitemap->allowUrlSegment(Page $page, string $urlSegmentStr) $sitemap->allowUrlSegment(Page $page, string $urlSegmentStr, $language = null)	`bool`	Allow URL segment string for page? (hookable)
$sitemap->getUrlSegments() $sitemap->getUrlSegments(Page $page) $sitemap->getUrlSegments(Page $page)	`array`	Get URL segments to render for given page
$sitemap->setUrlSegmentsByTemplate() $sitemap->setUrlSegmentsByTemplate($template, array $urlSegments) $sitemap->setUrlSegmentsByTemplate($template, array $urlSegments)	`self`	Set URL segments by template
$sitemap->setUrlSegmentsByTemplates() $sitemap->setUrlSegmentsByTemplates(array $urlSegmentsByTemplate) $sitemap->setUrlSegmentsByTemplates(array $urlSegmentsByTemplate)	`self`	Set URL segments by multiple templates at once

Languages

Name	Return	Summary
$sitemap->addLanguage() $sitemap->addLanguage(Language $language, string $langCode) $sitemap->addLanguage(Language $language, string $langCode)	`self`	Add language to include in sitemap
$sitemap->allowLanguage() $sitemap->allowLanguage(Page $page, Language $language) $sitemap->allowLanguage(Page $page, Language $language)	`bool`	Allow page to be rendered in sitemap for given $language? (hookable)
$sitemap->getLanguages() $sitemap->getLanguages() $sitemap->getLanguages()	`array`	Get languages to render in indexed by hreflang code

For hooks

These methods are only useful for hooking and should not be called directly.

Name	Return	Summary
$sitemap->allowLanguage() $sitemap->allowLanguage(Page $page, Language $language) $sitemap->allowLanguage(Page $page, Language $language)	`bool`	Allow page to be rendered in sitemap for given $language? (hookable)
$sitemap->allowPage() $sitemap->allowPage(Page $page) $sitemap->allowPage(Page $page)	`bool`	Allow page to be rendered in sitemap? (hookable)
$sitemap->allowParent() $sitemap->allowParent(Page $page) $sitemap->allowParent(Page $page)	`bool`	Allow children to be rendered for given page? (hookable)
$sitemap->allowUrlSegment() $sitemap->allowUrlSegment(Page $page, string $urlSegmentStr) $sitemap->allowUrlSegment(Page $page, string $urlSegmentStr, $language = null)	`bool`	Allow URL segment string for page? (hookable)
$sitemap->getUrlSegments() $sitemap->getUrlSegments(Page $page) $sitemap->getUrlSegments(Page $page)	`array`	Get URL segments to render for given page
$sitemap->renderPage() $sitemap->renderPage(Page $page) $sitemap->renderPage(Page $page, string $urlSegmentStr = '')	(nothing)	Render row for page

Additional methods and properties

In addition to the methods and properties above, WireSitemapXML also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.244