カスタムブロックのテーマを設定する方法

hook_block_infoand hook_block_themeなどを使用してブロックを作成しました。しかし、どうすればテーマを設定できますか？

キー'subject'とキーで配列を返すように動作しています'content'。しかし、hook_block_view()フック内で直接マークアップを作成しましたが、それは私が望むものではありません。

ドキュメントでは、コンテンツはマークアップとしてではなく、レンダリング可能な配列として返されることが望ましいとされています。しかし、このレンダリング可能な配列は何ですか？彼らはマークアップではなくデータであるべきだと言っていますが、例で見るのはマークアップのラッパーとして使用されているだけで、そこで何も得られません。

block--MYMODULE--DELTA.tpl.phpテーマにを含めることができますが、それをどのように呼び出し、どのようにデータをブロックに渡すことができますか？

私がこれを行う方法は次のとおりです...

function MYMODULE_block_info() {

  $blocks = [];

  $blocks['my_block_machine_name'] = [
    'info'  => t('My Block Title'),
    // @see https://api.drupal.org/api/drupal/includes!common.inc/group/block_caching/7.x
    // You can use different caching options.
    'cache' => DRUPAL_NO_CACHE,
  ];

  return $blocks;
}

function MYMODULE_block_view($delta = '') {

  $block = [];

  switch ($delta) {
    case 'my_block_machine_name':
      // Good idea to check user permissions here.
      if (user_access('access content')) {
        $block['subject'] = t('My Block Title');
        $block['content'] = MY_BLOCK_CONTENT_CALLBACK();
      }
      break;
  }

  return $block;
}

function MY_BLOCK_CONTENT_CALLBACK()() {

  $items = [];

  // This is the simplest kind of renderable array.
  $items['VAR_ONE'] = ['#markup' => 'VAR_ONE_OUTPUT'];

  // Here I added a prefix and a suffix.
  $items['VAR_TWO'] = [
    '#prefix' => '<div class="foo-bar">',
    '#markup' => 'VAR_TWO_OUTPUT',
    '#suffix' => '</div>',
  ];

  // This is where the $items get sent to your my-template.tpl.php template
  // that got registered below.
  return theme('my_cool_block', ['items' => $items]);
}

function MYMODULE_theme() {

  // Here you are registering your template for the block output above.
  $module_path = drupal_get_path('module', 'MYMODULE');

  // Drupal will now look up your modules /theme folder first to grab the
  // template.
  $base = [
    'path' => "$module_path/theme",
  ];

  return [
    'my_cool_block' => $base + [
        // Leave off .tpl.php.
        'template'  => 'my-template',
        // Define variables you want to pass to the template.
        // Here I just pass items, but you can pass any other data as well.
        'variables' => [
          'items' => NULL,
        ],
      ],
  ];
}

そして、あなたのモジュールのサブフォルダには、これを含むことができるthemeファイルが必要ですmy-template.tpl.php：

<?php 

$items = $variables['items'];

print render($items['VAR_ONE']); 
print render($items['VAR_TWO']); 

また、必要に応じてmy-module.tpl.php、テーマで作成したばかりの「デフォルト」モジュール実装を、実際に上書きすることもできますblock--MYMODULE--DELTA.tpl.php。

テーマ開発者モジュールをお試しください。有効にすると、Drupalページの左下隅にあるチェックボックスをオンにできます。その後、ブロックをクリックして、テーマを考慮した有用な情報を取得できます。たとえば、ブロックの可能な.tpl.phpファイルの名前を確認できます。

それらの名前の1つを選択します。最初は最も具体的なものです。テーマは1ブロックのみです。テーマフォルダにその名前のファイルがまだない場合は作成します。整理したい場合は、サブフォルダーに配置できます。

ファイル内のblock.tpl.phpの内容をコピーし、希望どおりに変更を開始します。

ファイルを保存し、キャッシュをクリアして、ページをリロードします。

この質問にはすでに多くの答えがありますが、私は非常に単純なアプローチを提供しようとしました。ブロックコンテンツを返すときにDrupalが期待する配列構造を開発者に特定することを願っています。

これを行うために、質問を個別のコード例に分解しました。

/**
 * Implements hook_theme().
 */
function examplemodule_theme() {
  return array(
    'examplemodule_output' => array(
      'variables' => array(
        'title' => NULL,
        'content' => NULL,
        'popular_content' => NULL,
       ),
      'template' => 'templates/examplemodule-sweet--block',
    ),
  );
}

ここで完全な説明を参照してくださいdrupal 7テーマのカスタムブロックの作成

これは古い投稿ですが、Drupal 7のカスタムモジュールからブロックテンプレートをオーバーライドするためのより良いソリューションを見つけました。

これをカスタムモジュールに追加します。

/**
 * Implements hook_theme().
 */
function MYMODULE_theme($existing, $type, $theme, $path) {

  // Custom template for that overrides the default block.tpl.php.
  $themes['block__my_custom_module'] = [
    'template'      => 'block--my_custom_module',
    'original hook' => 'block',
    'path'          => drupal_get_path('module', 'my_custom_module') . '/templates',
  ];

  return $themes;
}

次に、次のコードが必要です。

/**
 * Implements hook_block_info().
 */
function MYMODULE_block_info() {

  $blocks = [];

  $blocks['my_custom_module'] = [
    'info'  => t('My Custom Module Block'),
    'cache' => DRUPAL_CACHE_PER_ROLE,
  ];

  return $blocks;
}

/**
 * Implements hook_block_view().
 */
function MYMODULE_block_view($delta = '') {

  $block = [];

  switch ($delta) {
    case 'my_custom_module':
      $block['content'] = _my_custom_module_helper_function();
      break;
  }

  return $block;
}

/**
 * Helper function to generate HTML.
 *
 * @return string
 *   generated HTML
 */
function _my_custom_module_helper_function() {

  $output = '';

  // ...

  return $output;
}

templates/block--my-custom-module.tpl.phpモジュールのフォルダ内に作成するだけです。

このDrupalチュートリアル-カスタムモジュールからブロックテンプレートをオーバーライドする方法に関するチュートリアルを作成しました