WireSitemapXML::allowUrlSegment() method

Allow URL segment string for page? (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

// basic usage
$bool = $sitemap->allowUrlSegment(Page $page, string $urlSegmentStr);

// usage with all arguments
$bool = $sitemap->allowUrlSegment(Page $page, string $urlSegmentStr, $language = null);

Arguments

Name	Type(s)	Description
`page`	Page
`urlSegmentStr`	string
`language` (optional)

Return value

bool

Hooking $sitemap->allowUrlSegment(…)

You can add your own hook events that are executed either before or after the $sitemap->allowUrlSegment(…) 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->allowUrlSegment(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('WireSitemapXML::allowUrlSegment', 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);
  $urlSegmentStr = $event->arguments(1);
  $language = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each $sitemap->allowUrlSegment(…) 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::allowUrlSegment', 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);
  $urlSegmentStr = $event->arguments(1);
  $language = $event->arguments(2);

  /* 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