Please Sign In or Register

hook_help()

オンラインユーザヘルプを提供します。

モジュールの使用方法や注意事項を記載したヘルプページ (admin/help/modulename) を作成できます。
作成したヘルプページは、Drupal のヘルプページ (admin/help) にリンクを作成したり、特別なモジュールのヘルプページなどに追加で表示させることができます。

パラメータ

hook_help($section)
ヘルプを表示する場所を指定します。
基本的にはメニューの階層を示す URL にシャープ(#)記号と表示場所を組み合わせたパスを指定するようです。
  • admin/modules#name
    モジュール名の指定ですが、Drupal 5.x からは modulename.info に記載した内容が使用されるようになっています。
  • admin/modules#description
    admin/modules ページに表示されるモジュールの説明ですが、これも Drupal 5.x からは modulename.info に記載した内容が使用されるようになっています。
  • admin/help#modulename
    モジュールのヘルプページである admin/help/modulename を作成します。
    また、admin/help ページおよびモジュールの設定ページなどにヘルプページへのリンクも作成されます。
  • user/help#modulename
    分散認証に対応可能なモジュールの場合に、分散認証のヘルプページに表示にヘルプを追加できます。
  • node/add#nodetype
    ノードタイプを作成可能なモジュールの場合は、そのノードタイプの説明を表示できます。

戻り値

戻り値には、ヘルプとして表示する内容を設定します。
内容を t() で括れば、記述した内容が翻訳の対象にできます。他にも l() , url() やプレースホルダを組み合わせることで柔軟に設定できます。

サンプルコード

function hook_help($section) {
  switch ($section) {
    case 'admin/help#block':
      return t('<p>Blocks are the boxes visible in the sidebar(s)
        of your web site. These are usually generated automatically by
        modules (e.g. recent forum topics), but you can also create your
        own blocks using either static HTML or dynamic PHP content.</p>');
      break;
    case 'admin/modules#description':
      return t('Controls the boxes that are displayed around the main content.');
      break;
  }
} 

トラックバック

トラックバックは承認後に表示されます。

URLから "-nospam" を削除してトラックバックを送信してください。