Drupalのモジュール（Ctools）でPanelsのコンテントタイプのプラグインを作成

やりたいこと：モジュール（Panels）でコンテントタイプのプラグインを作成します

• 環境：Drupal7.54、Chaos tool suite 7.x-1.12、Panels7.x-3.9
• Panelsでカスタムコンテンツを表示するメリットがいつかあります
  • ページとしてのメニュー、アクセス権限などの管理がコーティングしなくてPanelsに任すことができます
  • PanelsがViews、Display Suiteなどのモジュールをサポートしているので、いろいろな加工に便利です
• 各自の目的に合わせ、カスタムコンテントタイプのプラグインをCtoolsで簡単に作成することができます

モジュール（Ctools）でPanelsのコンテントタイプを作成

• Ctoolsプラグインの作成ルールに従ってPanelsのプラグインを作成します
  • プラグインの管理画面にメッセージが入力できます
  • 入力されたメッセージを変数として保存します
  • 入力されたメッセージをプラグインの結果画面に表示させます
• 既存/新規のカスタムモジュール内でプラグインのディレクトリを作成します
  • プラグインのディレクトリ： カスタムモジュール/plugins/content_types
  • このディレクトはCtoolsプラグインの決まりの構成です
    
• カスタムモジュール内でCtoolsのコンテントタイププラグインの使用を宣言します

  /**
   * Implements hook_ctools_plugin_directory().
   */
  function example_pane_ctools_plugin_directory($owner, $plugin_type)
   {
      // ctoolsのcontent_typeプラグインのディレクトリを指定
      if ($owner == 'ctools' && $plugin_type == 'content_types') {
          return 'plugins/content_types';
      }
  }

• 指定されたディレクトリの下に、プラグイン記述のファイル（xxxx.inc、例：message_pane.inc）を新規作成します
• プラグイン記述ファイル内で、プラグインの定義を行います
  
• プラグインの管理画面を定義します
  
• プラグインの結果を表示するブロックの定義
  
• プラグインのソースは以下のようで

  
  /**
   * This plugin array is more or less self documenting
   */
  $plugin = array(
      'title' => t('Example pane'), // 管理画面のタイトル
      'single' => TRUE,  // FALSE：subtypesコンセプト、詳細は：ctools help file context-content.html
      'category' => array(t('Examples'), -9),  // プラグインのカテゴリ
      'edit form' => 'message_pane_edit_form',  // プラグインの管理画面
      'render callback' => 'message_pane_render'  // プラグインの結果表示
  );
  
  /**
   * プラグインの結果表示（ブロックとしての表示）
   */
  function message_pane_render($subtype, $conf, $context = NULL) {
      $block = new stdClass();
      // The title actually used in rendering
      $block->title = check_plain("Example Pane");
      if (!empty($conf)) {
          $block->content .= '<div>入力されたメッセージ：' .
                      $conf['example_item'] . '</div>';
      }
      return $block;
  }
  
  /**
   * プラグインの管理画面
   */
  function message_pane_edit_form($form, &$form_state) {
      $conf = $form_state['conf'];
      $form['example_item'] = array(
          '#type' => 'textfield',
          '#title' => t('Example Item'),
          '#size' => 50,
          '#description' => t('The setting for Example item.'),
          '#default_value' => !empty($conf['example_item']) ? $conf['example_item'] : '',
      );
      return $form;
  }
  
  
  /**
   * プラグイン管理画面の内容を保存
   */
  function message_pane_edit_form_submit(&$form, &$form_state) {
      $form_state['conf']['example_item'] = $form_state['values']['example_item'];
  }
  
  

   

使用するモジュール

• Views 7.x

Viewsで作成されたブロックに検索条件が表示されない

• Viewsで記事（Article）一覧表示ブロックを作成する
  • 表示項目（Fields）：タイトル
  • 検索条件（Filters）：コンテントタイプ（Content Type）、コンテントが公開済み（Published）
• 検索条件：コンテントタイプを画面に表示するように設定（Expose filter to visitors）
  
• 検索条件を画面に表示させる設定したにもかかわらず、実際にブロックに表示されていない
  • 例：作成したViewsのブロックをササイドバーに表示させる
  • ページのサイドバーを確認して、記事一覧ブロックが表示されたが、検索条件は表示されない
    

Viewsのほかの設定（Other）のAjax使用を設定すれば、Viewsで作成したブロックに検索条件が表示される

• ​Viewsで作成したブロック設定画面でほかの設定（Others）にあるAjax使用を「はい」（Yes）に変更（初期値は「いいえ」（No））
  
• ページのサイドバーを確認し、検索条件がブロックに表示された
  

この現象がViewsのページ（Page）とViewsのブロック（Block）の設定対応が違う

• 同様な条件でViewsでページとブロックを作成する
• Viewsのページ設定ではAjax使用は「いいえ」にしても、表示ページに検索条件が表示される
• Viewsのブロック設定ではAjax使用は「はい」にしないと、ブロックに検索条件が表示されない