編輯“Drupal模塊開發(fā)步驟”

<span style="border:1px solid #000; text-align:center; float:right; padding:6px; margin-bottom:15px;"><strong>導(dǎo)航:</strong> [[Drupal|上一頁]] | {{Template:Drupal導(dǎo)航}}</span>
<div style="clear:both;"></div>

這里是根據(jù)[[drupal]]開發(fā)指南上的例子來展開的。準(zhǔn)備定制一個“annotate”[[模塊]]。采用Drupal 6版本。

'''第一步'''：創(chuàng)建文件。

首先為我們模塊選擇一個名稱，“annotate”比較適合我們的需求，因為其簡短并能夠讓人能夠大致看出這個模塊是做什么的。接著，我們需要一個目錄來存放這個模塊?？梢苑旁诤诵哪K一起，但那樣不利于管理和升級，所以我們放在sites/all/modules內(nèi)。

創(chuàng)建info文件，這個文件是模塊必須的。用于說明模塊的一些基本信息。我們的annotate.info文件內(nèi)容如下：
<pre>
; $Id$
name = Annotate
description = Allows users to annotate nodes.
core = 6.x
package = Pro Drupal Development
</pre>

'''說明'''：文件是簡單的keys和values格式。以[[CVS]]標(biāo)識標(biāo)簽開始，若你想將模塊貢獻(xiàn)到drupal官方，就需要寫這個。這個值將自動被CVS替代。接著我們向Drupal提供模塊名稱和描敘，它們將顯示在模塊管理界面上。再接下來聲明的是我們的模塊兼容drupal那個版本。模塊是以組的形式顯示，組是由包決定的。因此，若我們有三個不同的模塊，則是這樣的：package = Pro Drupal Development。它們將顯示在一組。除了上面列出的外，我們還可以添加一些可選項。下面的例子是一個模塊需要[[PHP]]5.2和論壇模塊、分類模塊。
<pre>
; $Id$
name = Forum confusion
description = Randomly reassigns replies to different discussion threads.
core = 6.x
dependencies[] = forum
dependencies[] = taxonomy
package = "Evil Bob's Forum BonusPak"
php = 5.2
</pre>

現(xiàn)在來創(chuàng)建模塊主文件annotate.module。代碼如下：(開始于一個[[PHP]]開始標(biāo)簽和一個CVS標(biāo)識標(biāo)簽，接著是一個注釋)
<pre>
<?php
// $Id$
/**
* @file
* Lets users add private annotations to nodes.
*
* Adds a text field when a node is displayed
* so that authenticated users may make notes.
*/
</pre>

注意下注釋風(fēng)格。我們以/**開始，在隨后的行中，我們使用的是*，并縮進(jìn)了一個空格和以*/結(jié)束注釋。@file表示下一行描敘的是這個文件是做什么的。使用了這個單行描敘，因此api.module，drupal文檔自動提取器和格式器將能夠找出這個文件是做什么的。接著一個空行，我們添加一個長句描敘主要是針對檢查我們代碼的程序員。

'''注意'''：我們故意不使用一個閉合(?>)標(biāo)簽。這在PHP內(nèi)是可選的。若包含了的話，有可能在文件內(nèi)產(chǎn)生尾部空格問題。

[[category:Drupal模塊|D]]
[[category:Drupal|D]]