modX.filterPathSegment

modX::filterPathSegment¶

Delegates to the static modResource::filterPathSegment() — the pipeline that converts a pagetitle into a Resource alias. In order, it:

1. strips tags and decodes entities;
2. transliterates and restricts the character set;
3. applies word delimiters, lowercases and trims;
4. cuts the segment to friendly_alias_max_length when the setting is above zero.

The same method runs as the filterPathSegment output filter, and media sources pass upload names through it.

Syntax¶

string filterPathSegment (string $string, [array $options = []])

• $string (string) text to convert
• $options (array) friendly_alias_* overrides for this call, by default []

Example¶

$segment = $modx->filterPathSegment('My News Title');
// 'my-news-title'

$segment = $modx->filterPathSegment('My News Title', array(
    'friendly_alias_lowercase_only' => false,
));
// 'My-News-Title'

See Also¶

• modX
• modResource
• Transliteration
• Output filters