Implement hook_help()

Created on 6 March 2023, almost 2 years ago
Updated 1 May 2024, 8 months ago

Problem/Motivation

When you enable the module, the method hook_help is not implemented.

Steps to reproduce

Download and activate the module and visit its help page.

Proposed resolution

Implement the hook_help and describe the functionality of the module and it's usage.

Remaining tasks

Implement hook_help.

User interface changes

None.

API changes

None.

Data model changes

None.

📌 Task
Status

Needs work

Version

1.0

Component

Code

Created by

🇮🇳India indrapatil Bangalore

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇮🇳India Jaspreet-Kaur

    Applied hook_help() on Drupal 9.5.1 and it's worked for me. Thanks!

  • Status changed to Needs work almost 2 years ago
  • 🇮🇹Italy apaderno Brescia, 🇮🇹
    +/**
    + * @file
    + * Tikitoki POST Module for Drupal Sites.
    + */
    + use Drupal\Core\Routing\RouteMatchInterface;
    +/**
    + * Implements hook_help().
    + */
    +function tikitoki_help($route_name, RouteMatchInterface $route_match) {
    +  switch ($route_name) {
    +    // Main module help for the tikitoki module.
    +    case 'help.page.tikitoki':
    +      $output = '<h2>' . t('About') . '</h2>';
    +      $output .= '<p>' . t('Provides a Views display that outputs data in specific JSON format in order to integrate your content with beautiful 3D and 2D timelines from Tiki Toki service. To be able to use it you need to have a Silver account.') . '</p>';
    +      $output .= '<p>';
    +      $output .= t('Visit the <a href=":project_link">Project page</a> on Drupal.org for more information.', [
    +        ':project_link' => 'https://www.drupal.org/project/tikitoki',
    +      ]);
    +      $output .= '</p>';
    +
    +      return $output;
    +  }
    +}

    There are missing empty lines. Furthermore, copying two sentences from the project page and adding a link to the project page is not sufficient.

  • Assigned to akshaydalvi212
  • 🇮🇳India akshaydalvi212

    I will update the MR and implement the hook_help().

  • Issue was unassigned.
  • Status changed to Needs review over 1 year ago
  • 🇮🇳India akshaydalvi212

    Updated the MR.
    providing the screenshot of help page.
    kindly review.

  • Status changed to RTBC over 1 year ago
  • 🇵🇭Philippines paraderojether

    Hi akshaydalvi212

    I reviewed commit 9061a32e, I applied it in my local and it woks fine for me. Drupal core 9.5.7, Tiki Toki 8.x-1.x-dev.

    I added screenshots for reference.
    Thank You.

  • Status changed to Needs work 8 months ago
  • 🇳🇴Norway matsbla

    This simply use the module description inside the help page, which is really not useful. To implement a help page it should be more detailed description about how to actually use the module.

Production build 0.71.5 2024