function entity_redirect_help

Implements hook_help().

File

./entity_redirect.module, line 18

Code

function entity_redirect_help($route_name, RouteMatchInterface $route_match) {
    switch ($route_name) {
        case 'help.page.entity_redirect':
            $output = '';
            $output .= '<h3>' . t('About') . '</h3>';
            $output .= '<p>' . t('The Entity Redirect module adds a configurable redirect after saving a node or other entity.The redirect is configurable per bundle. Also, given sufficient permissions (and presuming it is enabled for that specific content/bundle), individual users can configure their own redirects (on their profile edit page).') . '</p>';
            $output .= '<h3>' . t('Configuration') . '</h3>';
            $output .= '<p>' . t('Configuration can be accessed for each supported entity bundle on the edit page for that entity type. For example for the Node type Article that would be at /admin/structure/types/manage/article. The configuration will be in the publishing options section if available.');
            $output .= '<h3>' . t('Uses') . '</h3>';
            $output .= '<dl>';
            $output .= '<dt>' . t('Default') . '</dt>';
            $output .= '<dd>' . t('This will not impact the entity but will just go to the default.') . '</dd>';
            $output .= '<dt>' . t('Add Form') . '</dt>';
            $output .= '<dd>' . t('Redirect to a new add form for the content type/entity.') . '</dd>';
            $output .= '<dt>' . t('Return to Edit Form') . '</dt>';
            $output .= '<dd>' . t('Redirect back to the edit form of the entity.') . '</dd>';
            $output .= '<dt>' . t('Local Url') . '</dt>';
            $output .= '<dd>' . t('provide a local url in the form of /about to go to any page on the site.') . '</dd>';
            $output .= '<dt>' . t('Created entity') . '</dt>';
            $output .= '<dd>' . t('Redirect to the view of the entity') . '</dd>';
            $output .= '<dt>' . t('Go to Layout Builder Page') . '</dt>';
            $output .= '<dd>' . t('If Layout Builder module is enabled, redirect to the layout builder page of the entity.') . '</dd>';
            $output .= '<dt>' . t('External Url') . '</dt>';
            $output .= '<dd>' . t('Same as local url but to an external location. Note: this is only available to users with the permission set external entity redirects.') . '</dd>';
            $output .= '<dt>' . t('Return to the previous page') . '</dt>';
            $output .= '<dd>' . t('Redirects to the page where the form was submited from.') . '</dd>';
            $output .= '</dl>';
            return $output;
        default:
    }
}