現在の位置: ホーム> 最新記事一覧> 最初のExpressionEngineEngineプラグインを作成する方法：詳細なステップ分析

最初のExpressionEngineEngineプラグインを作成する方法：詳細なステップ分析

gitbox 2025-06-13

序文

ExpressionEngine（略してEE）は、柔軟性とスケーラビリティが多くのWebサイト開発者にとって最初の選択となる強力なコンテンツ管理システムです。 EEには、さまざまなモジュールとタグが組み込まれているだけでなく、ユーザー開発プラグインもサポートしてシステム機能をさらに拡張します。この記事では、最初のExpressionEngineプラグインを作成する方法を紹介し、EEのプラグインメカニズムを最大限に活用し、Webサイト開発効率を向上させるのに役立ちます。

プラグインとは何ですか？

EEでは、プラグインはシステム機能を拡張する方法です。複雑なロジックを処理し、外部サービスやその他の機能を統合できます。プラグインは、テンプレート、コントロールパネル、静的ページなどで使用できます。単純なタグを使用して呼び出すだけです。

プラグイン分類

ExpressionEngineのプラグインは、次のカテゴリに分類できます。

  • 標準プラグイン：基本的な処理ロジックを処理するために使用されます。
  • 拡張プラグイン：新しいウィジェットの追加、URL書き換えなど、EEのコア機能を拡張します。
  • モジュールプラグイン：EEバックグラウンドコントロールパネルで使用されるプラグイン。
  • テンプレートプラグイン：動的コンテンツの出力など、ページテンプレートのプラグインで使用されます。

プラグインを作成します

プラグインの基本的な分類を理解した後、標準のプラグインを作成する方法を紹介します。

ステップ1：プラグインディレクトリを作成します

まず、EEプラグインディレクトリに新しいフォルダーを作成して、作成しようとしているプラ​​グインを保存します。通常、EEのプラグインディレクトリは/System/ExpressionEngine/Third_Party/にあり、システム設定で構成できます。

ステップ2：プラグインファイルを作成します

新しく作成されたプラグインディレクトリで、プラグインファイルを作成すると、ファイル名はプラグイン名と同じである必要があります。プラグインファイルには、プラグインの特定のロジックの処理を担当するEE_Pluginクラスが含まれている必要があります。コードの例は次のとおりです。

 
class My_plugin {
    // プラグインロジック
}

ステップ3：プラグイン情報を構成します

プラグインファイルでは、プラグイン名、バージョン番号、キャッシュをサポートするなど、いくつかの基本情報を構成する必要があります。PHPDOCを使用して構成できます。コード例は次のとおりです。

 
/**
 * Plugin Name
 *
 * @package   My_plugin
 * @version   1.0.0
 * @author    Your Name
 * @link      [あなたのウェブサイトのリンク]
 */
class My_plugin {
    // プラグインロジック
}

ステップ4：プラグインを登録します

構成情報を完了した後、システムがプラグインを認識してロードできるように、EEでプラグインを登録する必要があります。プラグイン登録は、次のコードを介して実行されます。

 
ee()->plugins->register('My_plugin', 'My_plugin');

ここで、最初のパラメーターはプラグイン名で、2番目のパラメーターはステップ2で作成されたクラス名です。

プラグインインスタンス

次に、テンプレートにカスタムタグを追加するためのサンプルプラグインを作成します。

ステップ1：プラグインディレクトリを作成します

まず、/System/ExpressionEngine/Third_Party/my_plugin/など、プラグインディレクトリを作成する必要があります。

ステップ2：プラグインファイルを作成します

次のコンテンツを使用して、このディレクトリにmy_plugin.phpという名前のファイルを作成します。

 
/**
 * My Plugin
 *
 * @package   My_plugin
 * @version   1.0.0
 * @author    Your Name
 * @link      [あなたのウェブサイトのリンク]
 */
class My_plugin {
    
    public $return_data = ''; // 返品値を初期化します
    
    /**
     * カスタムタグ
     *
     * @access  public
     * @return  string
     */
    public function custom_tag()
    {
        $output = 'Hello World!';
        return $output;
    }
}

このファイルでは、my_pluginという名前のクラスを定義し、文字列「Hello World！」を返すCustom_tag（）という名前のメソッドを作成します。

ステップ3：プラグインを登録します

プラグインコードを完了した後、プラグインをEEに登録します。コードは次のとおりです。

 
ee()->plugins->register('My_plugin', 'My_plugin');

ステップ4：カスタムタグを使用します

テンプレートでは、作成したカスタムタグを使用できます。コードの例は次のとおりです。

 
{exp:My_plugin:custom_tag}

この例では、my_pluginプラグインのcustom_tag（）メソッドを呼び出し、テンプレートに「Hello World！」が表示されます。

要約します

プラグインは、EEの強力な拡張メカニズムの1つです。プラグインを介してEEの機能を拡張し、さまざまな複雑なビジネスロジックを処理し、Webサイトをより柔軟で強力にすることができます。この記事では、シンプルなEEプラグインを作成する方法について説明します。それが役立つことを願っています。

関連内容