WordPressカスタムプラグイン開発の準備
WordPressでカスタムプラグインを作成するには、ローカル環境の整備が不可欠です。特にwp-content/pluginsディレクトリへの配置手順やPHPファイルの基本構文が分かっていれば、スムーズに開発を始められます。本セクションでは、開発に必要な準備とプラグイン配置の基本を解説します。
ローカル環境構築の手順
ローカル環境は、XAMPPやMAMPなどを使って簡単に構築可能です。以下が主な手順です。
- WordPressを公式サイトからダウンロードし、ローカルサーバーにインストールする
- データベース（MySQL）とWordPressの接続設定を行う
- ブラウザでWordPressダッシュボードにアクセスして、初期設定を完了させる
注意: 開発環境では公式テーマやプラグインではなく、ローカル専用のバージョンを使用する必要があります。
wp-content/pluginsディレクトリの確認方法
WordPressはwp-content/pluginsディレクトリにプラグインファイルを読み込みます。以下の手順で確認してください。
- WordPressのサイトルートにある
wp-contentフォルダを開く - その中にある
pluginsフォルダを確認し、カスタムプラグイン用に新規ディレクトリを作成する（例:my-plugin） - ディレクトリ内にPHPファイルを配置することで、プラグインとして認識される
| 項目 | 内容 | 補足 |
|---|---|---|
| ディレクトリの場所 | wp-content/plugins/ |
必ずこのパスに配置する |
| ファイル名のルール | .php拡張子で、英数字とアンダースコアのみ使用可 |
例: my-plugin.php |
| 動作確認方法 | WordPressダッシュボードの「プラグイン」メニューから有効化 | 標準的な挙動を確認する |
基本構造の作成
カスタムプラグインファイルは、最小限のコードで動作するよう設計します。PHPファイルの新規作成やプラグインヘッダーの記述方法が正しく理解できれば、すぐに機能を追加できます。
PHPファイルの新規作成
まず、wp-content/plugins/に配置したディレクトリ内に新規PHPファイルを作成します。以下は基本的なテンプレートです。
|
1 2 3 4 5 6 7 |
<?php /* Plugin Name: サンプルプラグイン Description: 初心者向けカスタムプラグインの例です。 Version: 1.0 */ |
ポイント: ヘッダー記述は必ず最初のコメントブロックに書く必要があります。この情報がWordPressで識別されます。
プラグインヘッダーの記述方法
プラグインヘッダーコメントは、以下のように記載します。
Plugin Name: プラグイン名（日本語可）Description: 説明文（機能を簡潔に説明）Version: バージョン番号（例: 1.0.0）Author: 開発者名
| フィールド | 必須か | 説明 |
|---|---|---|
| Plugin Name | ✅ | プラグインの名称を記述 |
| Description | ✅ | 機能や目的を簡単な文で説明 |
| Version | ⚠️ | 基本的に記入するが、デバッグ用に省略可 |
| Author | ⚠️ | 開発者名。テスト環境では任意 |
アクティベート/非アクティブ処理
プラグインを有効化・無効化する際、特定の処理を実行できます。register_activation_hook()やregister_deactivation_hook()を使って、状態変更時に動作させる関数を定義します。
アクティベート処理の記述方法
プラグインを有効化した際に実行される処理は以下のように記述します。
|
1 2 3 4 5 |
function my_plugin_activate() { // テーブル作成や初期データの挿入など } register_activation_hook(__FILE__, 'my_plugin_activate'); |
非アクティブ処理の実装方法
無効化時の処理は、register_deactivation_hook()で登録します。
|
1 2 3 4 5 |
function my_plugin_deactivate() { // キャッシュクリアやデータ削除など } register_deactivation_hook(__FILE__, 'my_plugin_deactivate'); |
| 関数 | 用途 | デフォルト動作 |
|---|---|---|
register_activation_hook() |
有効化時に実行 | カスタム処理を定義可能 |
register_deactivation_hook() |
無効化時に実行 | 環境クリーンアップが目的 |
簡単な機能実装例
プラグインの動作を確認するには、ショートコードの作成や管理画面にメニューを追加するなどの簡単な機能を実装します。ユーザーが直感的に成果を感じられるよう工夫してください。
ショートコードの作成方法
以下のように、add_shortcode()関数を使ってショートコードを作成できます。
|
1 2 3 4 5 |
function my_plugin_shortcode() { return '<p>Hello World!</p>'; } add_shortcode('test_shortcode', 'my_plugin_shortcode'); |
使用例:
記事内に [test_shortcode] と記入すると、"Hello World!"が表示されます。
管理画面にテスト用メニュー追加
以下のように、管理者向けのページを追加できます。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
function my_plugin_menu() { add_menu_page( 'テストページ', 'プラグインテスト', 'manage_options', 'my-plugin-page', 'my_plugin_display' ); } add_action('admin_menu', 'my_plugin_menu'); function my_plugin_display() { echo '<h1>このページはカスタムプラグインで作成しました</h1>'; } |
| 項目 | 説明 |
|---|---|
add_menu_page() |
管理画面に新しいメニューを追加 |
manage_options |
パーミッションレベル（管理者専用） |
開発ツールとの連携
効率的な開発には、ComposerやWP CLIなどの外部ツールを使用しましょう。コードの依存管理やコマンドラインでの操作が可能になります。
Composerで依存ライブラリを追加
composer.jsonファイルを作成し、必要なライブラリをインストールします。
wp-content/plugins/my-plugin/composer.jsonを作成-
以下のように記述して実行:
json
{
"require": {
"monolog/monolog": "^2.0"
}
} -
コマンドでインストール:
composer install
注意: Composerの利用はローカル環境でのみ推奨されます。本番環境では不要です。
WP CLIでのプラグイン管理
WP CLIを使用して、コマンドラインでプラグインを操作できます。
|
1 2 3 4 |
wp plugin activate my-plugin wp plugin deactivate my-plugin wp plugin list |
| コマンド | 用途 |
|---|---|
wp plugin activate |
プラグイン有効化 |
wp plugin deactivate |
プラグイン無効化 |
wp plugin list |
インストール済みプラグインの一覧表示 |
完成までにチェックすべきポイント
開発が終了した後、コードや環境の確認事項を忘れずに。エラーチェック方法や再配布準備をしっかり行うことで、スムーズな導入が可能になります。
コードのエラーチェック方法
以下の手順でチェックしてください。
- WordPressのエラー表示を有効化（
wp-config.phpにdefine('WP_DEBUG', true);を追加） - ブラウザでエラーがあれば、PHPファイルや関数呼び出しの修正が必要
- WP_DEBUG_LOGも併用して、ログ出力に注意
プラグインの再配布準備
他環境で利用するには、以下の点を確認してください。
wp-content/plugins/ディレクトリ内に必要なファイルが配置されているか- 独自ライブラリや依存関係が含まれている場合、
composer.jsonとvendorフォルダも含める必要がある - プラグイン名やバージョン番号が最新になっているか
| 検査項目 | 内容 |
|---|---|
| ファイル構成 | 必須ファイルの漏れがないか確認 |
| 依存管理 | Composerを使用している場合は、vendorフォルダも含める |
| バージョン番号 | Plugin NameやVersionが最新になっているか |