PagesNames class

This class includes methods for generating and modifying page names.

While these methods are mosty for internal core use, some may at times be useful from the public API as well. You can access methods from this class via the Pages API variable at $pages->names().

if($pages->names()->pageNameExists('something')) {
  // A page named “something” exists
}

// generate a globally unique random page name
$name = $pages->names()->uniqueRandomPageName();

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

Manipulators

Name	Return	Summary
PagesNames::adjustNameLength() PagesNames::adjustNameLength(string $name) PagesNames::adjustNameLength(string $name, int $maxLength = 0)	`string`	If name exceeds maxLength, truncate it, while keeping any numbered suffixes in place
PagesNames::checkNameConflicts() PagesNames::checkNameConflicts(Page $page) PagesNames::checkNameConflicts(Page $page)	(nothing)	Check given page’s name for conflicts and increment as needed while also triggering a warning notice
PagesNames::incrementName() PagesNames::incrementName(string $name) PagesNames::incrementName(string $name, $num = null)	`string`	Increment the suffix of a page name, or add one if not present
PagesNames::setupNewPageName() PagesNames::setupNewPageName(Page $page) PagesNames::setupNewPageName(Page $page, string $format = '')	`string`	Assign a name to given Page (if it doesn’t already have one)

Informational

Name	Return	Summary
PagesNames::defaultPageNameFormat() PagesNames::defaultPageNameFormat(Page $page) PagesNames::defaultPageNameFormat(Page $page, array $options = [])	`string`	Get the name format string that should be used for given $page if no name was assigned
PagesNames::hasAdjustedName() PagesNames::hasAdjustedName(Page $page) PagesNames::hasAdjustedName(Page $page, $set = null)	`bool`	Does the given page have a modified “name” during this request?
PagesNames::hasAutogenName() PagesNames::hasAutogenName(Page $page) PagesNames::hasAutogenName(Page $page)	`string` `bool`	Does the given page have an auto-generated name (during this request)?
PagesNames::hasNumberSuffix() PagesNames::hasNumberSuffix($name) PagesNames::hasNumberSuffix($name, bool $getNamePrefix = false)	`int` `bool` `string`	Does the given name or Page have a number suffix? Returns the number if yes, or false if not
PagesNames::isUntitledPageName() PagesNames::isUntitledPageName(string $name) PagesNames::isUntitledPageName(string $name)	`bool`	Does the given page have an untitled page name?
PagesNames::nameAndNumber() PagesNames::nameAndNumber(string $name) PagesNames::nameAndNumber(string $name, string $delimiter = '')	`array`	If given name has a numbered suffix, return array with name (excluding suffix) and the numbered suffix
PagesNames::pageNameExists() PagesNames::pageNameExists(string $name) PagesNames::pageNameExists(string $name, array $options = [])	`int`	Is the given name is use by a page?
PagesNames::pageNameHasConflict() PagesNames::pageNameHasConflict(Page $page) PagesNames::pageNameHasConflict(Page $page)	`string` `bool`	Does given page have a name that has a conflict/collision?
PagesNames::untitledPageName() PagesNames::untitledPageName() PagesNames::untitledPageName()	`string`	Return the untitled page name string

Generators

Name	Return	Summary
PagesNames::pageNameFromFormat() PagesNames::pageNameFromFormat(Page $page) PagesNames::pageNameFromFormat(Page $page, $format = '', array $options = [])	`string`	Create a page name from the given format
PagesNames::uniquePageName() PagesNames::uniquePageName() PagesNames::uniquePageName($name = '', $page = null, array $options = [])	`string`	Get a unique page name
PagesNames::uniqueRandomPageName() PagesNames::uniqueRandomPageName() PagesNames::uniqueRandomPageName(array $options = [])	`string`	Get a random, globally unique page name

Additional methods and properties

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

Wire

API reference based on ProcessWire core version 3.0.236

This class includes methods for generating and modifying page names.

Manipulators

Informational

Generators

Additional methods and properties

Newest forum posts

Latest news

Subscribe to weekly ProcessWire news