function path_help

Implements hook_help().

File

core/modules/path/path.module, line 23

Code

function path_help($route_name, RouteMatchInterface $route_match) {
    switch ($route_name) {
        case 'help.page.path':
            $output = '';
            $output .= '<h3>' . t('About') . '</h3>';
            $output .= '<p>' . t('The Path module allows you to specify an alias, or custom URL, for any existing internal system path. Aliases should not be confused with URL redirects, which allow you to forward a changed or inactive URL to a new URL. In addition to making URLs more readable, aliases also help search engines index content more effectively. Multiple aliases may be used for a single internal system path. To automate the aliasing of paths, you can install the contributed module <a href=":pathauto">Pathauto</a>. For more information, see the <a href=":path">online documentation for the Path module</a>.', [
                ':path' => 'https://www.drupal.org/documentation/modules/path',
                ':pathauto' => 'https://www.drupal.org/project/pathauto',
            ]) . '</p>';
            $output .= '<h3>' . t('Uses') . '</h3>';
            $output .= '<dl>';
            $output .= '<dt>' . t('Creating aliases') . '</dt>';
            $output .= '<dd>' . t('If you create or edit a taxonomy term you can add an alias (for example <em>music/jazz</em>) in the field "URL alias". When creating or editing content you can add an alias (for example <em>about-us/team</em>) under the section "URL path settings" in the field "URL alias". Aliases for any other path can be added through the page <a href=":aliases">URL aliases</a>. To add aliases a user needs the permission <a href=":permissions">Create and edit URL aliases</a>.', [
                ':aliases' => Url::fromRoute('entity.path_alias.collection')->toString(),
                ':permissions' => Url::fromRoute('user.admin_permissions', [], [
                    'fragment' => 'module-path',
                ])->toString(),
            ]) . '</dd>';
            $output .= '<dt>' . t('Managing aliases') . '</dt>';
            $output .= '<dd>' . t('The Path module provides a way to search and view a <a href=":aliases">list of all aliases</a> that are in use on your website. Aliases can be added, edited and deleted through this list.', [
                ':aliases' => Url::fromRoute('entity.path_alias.collection')->toString(),
            ]) . '</dd>';
            $output .= '</dl>';
            return $output;
        case 'entity.path_alias.collection':
            return '<p>' . t("An alias defines a different name for an existing URL path - for example, the alias 'about' for the URL path 'node/1'. A URL path can have multiple aliases.") . '</p>';
        case 'entity.path_alias.add_form':
            return '<p>' . t('Enter the path you wish to create the alias for, followed by the name of the new alias.') . '</p>';
    }
}