web-dev-qa-db-ja.com

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

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

キー_'subject'_および_'content'_を持つ配列を返すように機能しています。しかし、私はhook_block_view()フックで直接マークアップを作成しましたが、それは私が望んでいることではありません。

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

テーマに_block--MYMODULE--DELTA.tpl.php_を含めることができるようにしたいのですが、どのように呼び出して、データをブロックに渡すことができますか?

26
yunzen

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

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に対して作成した「デフォルト」モジュール実装を実際に上書きすることもできます。

27
nedwardss

テーマ開発者 モジュールを試してください。あなたがそれを有効にしたとき、あなたはあなたの左下隅にあるチェックボックスをチェックすることができますDrupalページ。たとえば、ブロックの.phpファイルの名前。

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

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

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

6
jiv-e

この質問にはすでにいくつかの回答がありますが、私は非常に単純なアプローチを提供することを試みました。うまくいけば、ブロックのコンテンツを返すときに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テーマのカスタムブロックの作成

5
Nicolas

これは古い投稿ですが、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チュートリアル-カスタムモジュールからブロックテンプレートを上書きする方法

3
iStryker