WireSitemapXML::allowLanguage() method

Allow page to be rendered in sitemap for given $language? (hookable)

This method is called by the WireSitemapXML module internally and you should not call it on your own, but you may hook it to modify its return value.

Usage

$bool = $sitemap->allowLanguage(Page $page, Language $language);

Arguments

NameType(s)Description
pagePage
languageLanguage

Return value

bool


Hooking $sitemap->allowLanguage(…)

You can add your own hook events that are executed either before or after the $sitemap->allowLanguage(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $sitemap->allowLanguage(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireSitemapXML::allowLanguage', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSitemapXML = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $page = $event->arguments(0);
  $language = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $page);
  $event->arguments(1, $language);
});

Hooking after

The 'after' hooks are called immediately after each $sitemap->allowLanguage(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('WireSitemapXML::allowLanguage', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $WireSitemapXML = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $page = $event->arguments(0);
  $language = $event->arguments(1);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$sitemap methods and properties

API reference based on ProcessWire core version 3.0.244

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer