ctools: une plongée profonde dans la création de plugins personnalisés dans Drupal 7

CTOOLS est un module Drupal 7 indispensable, formant les bases de nombreux autres modules comme des vues et des panneaux. Ses vastes API et fonctionnalités rationalisent le développement du module en offrant des fonctionnalités telles que la mise en cache d'objet, l'exportabilité de la configuration, les assistants de formulaire, les bo?tes de dialogue et un système de plugin robuste. Cet article explore les plugins CTOOLS, en se concentrant sur la création de plugins personnalisés. Nous allons construire un module qui simplifie la définition du bloc Drupal 7, reflétant l'approche plus rationalisée de Drupal 8.

Concepts clés:

• Le r?le de Ctools: CTOOLS fournit un cadre pour des fonctionnalités réutilisables, permettant aux développeurs de résumer la logique métier dans les plugins isolés.
• Définition du plugin: La création d'un plugin personnalisé implique de définir un type de plugin à l'aide de hook_ctools_plugin_type(), de spécifier le répertoire du plugin avec hook_ctools_plugin_directory() et de créer des fichiers de plugin individuels.
• Transformation du système de blocs: Ce didacticiel montre comment exploiter les plugins CTools pour créer un système basé sur les plugins pour les blocs Drupal 7, en remplacement de l'approche traditionnelle à crochet.
• Définition de bloc rationalisée: Le système de plugin personnalisé simplifie la création de blocs en éliminant le besoin d'implémentations répétitives hook_block_info() et hook_block_view().

Construire le module block_plugin:

Nous allons créer un module qui transforme le système de blocs de Drupal 7 en une architecture basée sur un plugin. Commencez par créer le fichier block_plugin.info:

<code>name = Block Plugin
description = Simplifies Drupal 7 block definition using cTools plugins.
core = 7.x
dependencies[] = ctools</code>

Suivant, dans block_plugin.module, nous définissons notre type de plugin en utilisant hook_ctools_plugin_type():

function block_plugin_ctools_plugin_type() {
  return array(
    'block' => array(
      'label' => 'Block',
      'use hooks' => FALSE,
      'process' => 'block_plugin_process_plugin'
    )
  );
}

le calcul process, block_plugin_process_plugin(), prépare les données du plugin:

function block_plugin_process_plugin(&$plugin, $info) {
  // ... (Code to generate admin title, set 'show title', and define view/configure/save callbacks as shown in the original example) ...
}

Nous avons également besoin de hook_ctools_plugin_directory() pour dire à Ctools où trouver nos plugins:

function block_plugin_ctools_plugin_directory($module, $plugin) {
  if ($module == 'block_plugin' && in_array($plugin, array_keys(block_plugin_ctools_plugin_type()))) {
    return 'plugins/' . $plugin;
  }
}

intégrer avec le système de blocs Drupal:

Maintenant, nous connecterons notre système de plugin au système de blocs de Drupal. hook_block_info() enregistrera nos plugins en blocs:

function block_plugin_block_info() {
  $blocks = array();
  $plugins = block_plugin_get_all_plugins(); // Helper function to fetch all plugins
  foreach ($plugins as $plugin) {
    $blocks[DELTA_PREFIX . $plugin['name']] = array(
      'info' => $plugin['admin title'],
    );
  }
  return $blocks;
}

// Helper function to get all plugins
function block_plugin_get_all_plugins() {
  return ctools_get_plugins('block_plugin', 'block');
}

define('DELTA_PREFIX', 'block_plugin_');

hook_block_view() rend le contenu du bloc:

function block_plugin_block_view($delta = '') {
  $plugin = block_plugin_plugin_from_delta($delta); // Helper to get plugin from delta
  if (!$plugin) { return; }
  $block = array();
  if (isset($plugin['title']) && $plugin['show title'] !== FALSE) {
    $block['subject'] = $plugin['title'];
  }
  $block['content'] = $plugin['view']($delta);
  return $block;
}

// Helper function to get plugin from delta
function block_plugin_plugin_from_delta($delta) {
  $prefix_length = strlen(DELTA_PREFIX);
  $name = substr($delta, $prefix_length);
  $plugin = block_plugin_get_plugin($name);
  return $plugin ? $plugin : FALSE;
}

// Helper function to get a single plugin
function block_plugin_get_plugin($name) {
  return ctools_get_plugins('block_plugin', 'block', $name);
}

Création d'un plugin de bloc:

Créez un fichier (par exemple, my_block.inc) dans le répertoire plugins/block:

<?php
$plugin = array(
  'title' => t('My Custom Block'),
);

function block_plugin_my_block_view($delta) {
  return array(
    '#type' => 'markup',
    '#markup' => 'This is my custom block content!',
  );
}

Après avoir effacé le cache de Drupal, votre bloc personnalisé appara?tra dans l'interface d'administration de blocs.

Conclusion:

Cette explication améliorée fournit une compréhension plus complète de la création de plugins CTOOLS personnalisés dans Drupal 7, démontrant spécifiquement leur application pour simplifier la gestion des blocs de Drupal. N'oubliez pas de consulter la documentation CTOOLS pour plus de détails et de fonctionnalités avancées.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!