ctools: menyelam mendalam ke dalam penciptaan plugin tersuai di Drupal 7

ctools adalah modul Drupal 7 yang sangat diperlukan, membentuk asas untuk banyak modul lain seperti pandangan dan panel. API dan fungsinya yang luas menyelaraskan pembangunan modul dengan menawarkan ciri -ciri seperti caching objek, pengeksportan konfigurasi, penyihir bentuk, dialog, dan sistem plugin yang mantap. Artikel ini meneroka plugin CTools, memberi tumpuan kepada penciptaan plugin tersuai. Kami akan membina modul yang memudahkan Definisi Drupal 7 Blok, mencerminkan pendekatan Drupal 8.

Konsep Utama:

• peranan ctools: ctools menyediakan rangka kerja untuk fungsi yang boleh diguna semula, membolehkan pemaju merangkumi logik perniagaan dalam plugin terpencil.
Definisi Plugin:
• Membuat plugin tersuai melibatkan menentukan jenis plugin menggunakan , menyatakan direktori plugin dengan , dan membuat fail plugin individu. hook_ctools_plugin_type() hook_ctools_plugin_directory()
Transformasi Sistem Blok:
• Tutorial ini menunjukkan cara memanfaatkan plugin CTools untuk membuat sistem berasaskan plugin untuk Drupal 7 blok, menggantikan pendekatan berasaskan cangkuk tradisional.
Definisi blok yang diselaraskan:
• Sistem plugin tersuai memudahkan penciptaan blok dengan menghapuskan keperluan untuk berulang dan pelaksanaan. hook_block_info() hook_block_view()

Membina modul

: block_plugin Kami akan membuat modul yang mengubah sistem blok Drupal 7 menjadi seni bina berasaskan plugin. Mulakan dengan membuat fail

:

block_plugin.info

Seterusnya, dalam

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

, kami menentukan jenis plugin kami menggunakan

: block_plugin.module hook_ctools_plugin_type()

panggil balik

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

,

, menyediakan data plugin: process block_plugin_process_plugin()

kami juga perlu

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) ...
}

untuk memberitahu CTools di mana untuk mencari plugin kami:

hook_ctools_plugin_directory()

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;
  }
}

Mengintegrasikan dengan Sistem Blok Drupal:

Sekarang, kami akan menyambungkan sistem plugin kami ke sistem blok Drupal.

akan mendaftarkan plugin kami sebagai blok:

hook_block_info()

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_');

menjadikan kandungan blok:

hook_block_view()

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);
}

Mewujudkan plugin blok:

3

Selepas membersihkan cache Drupal, blok tersuai anda akan muncul di antara muka Pentadbiran Blok.

my_block.inc plugins/block Kesimpulan:

<?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!',
  );
}

Penjelasan yang dipertingkatkan ini memberikan pemahaman yang lebih komprehensif untuk mewujudkan plugin CTools tersuai di Drupal 7, khususnya menunjukkan aplikasi mereka dalam memudahkan pengurusan blok Drupal. Ingatlah untuk berunding dengan dokumentasi CTools untuk butiran lanjut dan fungsi lanjutan.

Atas ialah kandungan terperinci Membina Plugin Ctools Custom di Drupal 7. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!