メインコンテンツに移動

メインナビゲーション

  • ホーム
  • サイトマップ
  • ビデオ
  • ご連絡

パンくず

  • ホーム
  • Drupalのテーマレイヤー(theme layer)のロジック層とプレゼンテーション層が分離される構成

Drupalのテーマレイヤー(theme layer)のロジック層とプレゼンテーション層が分離される構成

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
theme

Drupalのテーマレイヤー(theme layer)がロジック層(Logic)とプレゼンテーション層(Presentation)が徹底的に分離されています

  • 初心者として、Drupalのテーマに関するソースコードを読む時に、どこで定義して、どこから呼び出されているかは分からなく、理解するときに少し難しいかもしれないです。
  • この難しい構造は、実はロジック層とプレゼンテーション層をしっかり分けたせいかもしれません。
  • ロジック層とプレゼンテーション層を分離したメリットがいろいろあります
    • オーバーライトするのは簡単にあります(拡張性がよい)
    • 簡単に、どこでも呼び出すことができます
  • 抑えるポイントとしては:
    • テーマの登録
    • テーマの実装
    • テーマの呼び出し
      Drupalのテーマレイヤーのロジック層とプレゼンテーション層が分離されている

hook_themeの実装でテーマの定義を行います

  • 任一の場所で呼び出す可能にするため、テーマをシステム登録する必要があります
  • hook_theme()でテーマを登録します
    /**
     * Implements hook_theme().
     */
    function MODULE_NAME_theme(){
        return array(
            // function テーマの定義
            // 実装時に form_a の名前で
            'form_a' => array(    
                  'render element' => 'form_element' ,
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
            // template テーマの定義
            // 実装時に form_b の名前で
            'form_b' => array(
                 'template' =>  'form_temp' ,
                  'path' => "theme_dir", // テンプレートファイルのパス
                  'variables' => array('vars' => NULL),
                  ・・・・
            );
    
        );
    }
    
  • 登録内容は抽象的に、具体的になロジックはありません:
    • テーマの実装される名前(例:form_a/form_b)
    • テンプレートファイル名
    • テンプレートファイルのパス
    • 渡すパラメーター配列のキー
    • など(具体的にはAPIを参考)
  • テーマの定義を実装するのはファンクションか、テンプレートファイルか、2種類です

カスタム関数で(theme_ARRY_KEY)/テンプレートファイル(ARRY_KEY.tpl.php)でテーマ定義の実装

  • カスタム関数を新規作成して、テーマの定義を実装します
    • カスタム関数名: theme_ARRY_EKY :  ARRAY_KEYはロジック層の定義配列のキー(例:ARRY_KEY: form_a、 関数名:theme_form_a()  となります)
    • テーマ具体的な内容を定義します
      function theme_form_a(){
          return print( '<form method="get" ・・・・</form>') ;
      }
      
  • テンプレートファイルを作成して、テーマの定義を実装します
    • テンプレートファイル名: ARRY_KEY.tpl.php (例:ARRAY_KEY:form_b、テンプレートファイル名: form_b.tpl.php となります)
    • 上記同様にテーマの内容を定義します
      <-- HTMLでの出力  -->
      <form method="get">
        ・・・・
      </form>

theme()関数でパラメータを渡したり定義されたテーマを呼び出して出力します

  • どこかでtheme()関数でテーマにパラメータを渡して、HTMLコードを出力します
  • theme('ARRAY_KEY', array(パラメーター配列) )でテーマを呼び出し
    • ARRAY_KEY:テーマ定義の配列キー(例: form_a、 theme('form_a') となります)
    • パラメーター配列(例: array('vars' => 'some words') となります)
      //  form_a テーマの呼び出し
      $output = theme('form_a', array('var' => '1234'....) ) ;
      
      //  form_b テーマの呼び出し
      $output = theme('form_b', array('var' => '1234'....) ) ;
      

 

drupal
architecture
customization
theme

Drupalの構造は複雑で、簡単に説明が難しいです。ここで、いろいろな文書を参考しながら、いろいろな角度でDrupalの構造をまとめたいと思います。

Layerと処理フロー

  • Drupalがデータからプレゼンテーションまで、いくつかのレイヤーを分けることができます
  • データ: DBからノードなどの単位でデータを取得したら、DBにデータを保存するなどに構成されます
  • モジュール: コアモジュール/Contributeモジュール/Customモジュール(独自のモジュール)があります。ほとんどの機能、表示などを纏めて処理します。
  • ブロック/メニュー: 画面の表示場所と表示条件管理を行います
  • ユーザー権限: ユーザーの各コンテンツの新規作成、更新、削除、表示などの権限管理を行います
  • テンプレート: 画面に表示管理を行います(画面から、フィールドまでのテンプレート化ができます)

Hierarchical MVC

  • Drupalの構造はPAC(Presentation-Abstraction-Control model)、またはHierarchical MVCとは言われています。​
  • 簡単に言うと、階層化されたMVC構造です
  • トップレベルから各表示のフィールドまでMVC化することができます
  • この特徴はモジュールViews、Panelsなどを利用するとよくわかります。

モジュールは縦構造

  • もし、Drupalコーアの各機能(例:データ、ビジネスロジック、プレゼンテーションなど)を横構造であれば、各モジュールが縦構造となります
  • モジュール内でデータデータ取得、ビジネスロジック、プレゼンテーションなどの機能を独自に書くことができます。
  • モジュールがコアとの連携はhookか、コアの関数で行います。
    • コーアのコード変更は行わない。hookでオーバーライドするか、コアの関数でデータやり取りを行います
    • コアのロジックは絶対に書き換えないことです(書き換えたら、次回のアップデータする際に書き換えた部分が消えます)。
  • モジュールとモジュールの連携は、モジュールに提供されたAPIで行います。
    • モジュールに提供されたAPIはhookの形で操作します
    • モジュールがAPIを提供していなければ、通常は連携できないです。
    • モジュール内の関数を利用できる場合がありますが、注意深く利用する必要があります。

hookと関数の違い

  • hookは関数(function)です
  • hookを利用して独自なロジック/データ/形で元の機能をオーバーライドすることができります
    • 例:hook_form_alter()、既存のフォームに要素の追加、削除、変更ができます。
    • 元の機能/形を完全に変えることができます
  • 関数はコアの機能/データなどの設定、利用に使われます。

ノード(Node)から積立てたもの

  • Drupalがパズルのように一ピース一ピースで積立てたものと言われています
  • そのパズルの元はノード(Node)であります。
  • 複数のノードはコンテント(Content)となります。Drupalはコンテントの表示、入力、更新を管理します
  • Coreシステム、Theme、メニュー、ブロックなどはノードをサポートします
  • ModuleなどはCoreシステムをサポートします

 

drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
drupal
module
system_management

Drupal7と比較すると、Drupal8のノード(node)のデータテーブルこう構造が変わった

  • Drupal7ではノード(node)テーブルがタイトルが含まれています
    • タイトル、編集ユーザーなどがあります
  • Drupal8ではノード(node)テーブルがタイトルなどが含まないです
    • 単にノードID(nid)、リビジョンID(vid)のみの識別情報となります

Drupal8のリビジョン管理がnode_revisionテーブルで行います

  • ノード単位のリビジョンがnode、node_revisionテーブルで行います
    Drupal8ノードリビジョン管理
  • nodeテーブルでは、単にnid、vid、typeの管理
  • node_revisionテーブルでは、nid、vidのみでリビジョンを管理しています
ホーム

古松

検索

Article Category

  • apache(7)
  • css(19)
  • drupal(295)
  • Electron(4)
  • html(34)
  • javascript(27)
  • laravel(4)
  • linux(5)
  • macOS(2)
  • mysql(13)
  • php(19)
  • python(4)
  • SEO(12)
  • video(72)
  • Visual Studio Code(4)
  • windows(13)
  • wordpress(32)