function quickedit_help in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/quickedit/quickedit.module \quickedit_help()
2. 9 core/modules/quickedit/quickedit.module \quickedit_help()

Implements hook_help().

File

core/modules/quickedit/quickedit.module, line 26

Provides in-place content editing functionality for fields.

Code

function quickedit_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.quickedit':
      $output = '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Quick Edit module allows users with the <a href=":quickedit_permission">Access in-place editing</a> and <a href=":contextual_permission">Use contextual links</a> permissions to edit field content without visiting a separate page. For more information, see the <a href=":handbook_url">online documentation for the Quick Edit module</a>.', [
        ':handbook_url' => 'https://www.drupal.org/documentation/modules/edit',
        ':quickedit_permission' => Url::fromRoute('user.admin_permissions.module', [
          'modules' => 'quickedit',
        ])
          ->toString(),
        ':contextual_permission' => Url::fromRoute('user.admin_permissions.module', [
          'modules' => 'contextual',
        ])
          ->toString(),
      ]) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Editing content in-place') . '</dt>';
      $output .= '<dd>';
      $output .= '<p>' . t('To edit content in place, you need to activate quick edit mode for a content item. Activate quick edit mode by choosing Quick edit from the contextual links for an area displaying the content (see the <a href=":contextual">Contextual Links module help</a> for more information about how to use contextual links).', [
        ':contextual' => Url::fromRoute('help.page', [
          'name' => 'contextual',
        ])
          ->toString(),
      ]) . '</p>';
      $output .= '<p>' . t('Once quick edit mode is activated, you will be able to edit the individual fields of your content. In the default theme, with a JavaScript-enabled browser and a mouse, the output of different fields in your content is outlined in blue, a pop-up gives the field name as you hover over the field output, and clicking on a field activates the editor. Closing the pop-up window ends quick edit mode.') . '</p>';
      $output .= '</dd>';
      $output .= '</dl>';
      return $output;
  }
}