なぜカスタムプラグインを開発する必要があるのでしょうか？
WordPressエコシステムにおいて、プラグインはウェブサイトの機能を拡張するための核心です。市場には何千もの既製プラグインがありますが、カスタムプラグインを開発することには独自の利点があります。特にニーズが非常に具体的である場合や、既存のプラグインの組み合わせが複雑すぎて効率が悪い場合には、オーダーメイドのプラグインが最適な解決策となります。カスタムプラグインはビジネスロジックに完璧に合わせることができ、複数のプラグインを使用することによる潜在的な衝突を避けることができます。また、多機能な汎用プラグインよりもパフォーマンスが優れていることが多いです。さらに重要なのは、自分で開発することで、コードの品質とセキュリティを完全にコントロールできるという点です。
学習の観点から見ると、プラグイン開発の仕組みを理解することは、WordPressを深く習得するための必要なステップです。これにより、「ユーザー」から「クリエイター」へと変わることができ、さまざまなカスタマイズニーズにより柔軟に対応できるようになります。さらに、将来の製品開発やキャリアアップのための堅固な基盤を築くこともできるでしょう。
準備作業：開発環境の構築
コードの作成を始める前に、安定したかつ隔離された開発環境を用意することが非常に重要です。これにより、本番サイトを保護するだけでなく、自由にテストやデバッグを行うことができます。
ローカル開発環境の設定
ローカルサーバーソフトウェアパッケージ（Local by Flywheel、XAMPP、MAMPなど）の使用をお勧めします。これらのツールは、お使いのコンピューター上でウェブサーバー環境（Apache/Nginx、MySQL、PHP）をシミュレートし、オフラインで開発を行うことができます。インストールが完了したら、新しいWordPressサイトを作成して「サンドボックス」として使用してください。
コードエディターの選択
機能豊富なコードエディターは開発効率を大幅に向上させることができます。Visual Studio Codeは現在非常に人気のある選択肢で、軽量で無料であり、PHPやWordPress向けの専用の構文ハイライト、コードヒント、デバッグツールなど、多くの拡張機能を備えています。PHPStormもまた強力な統合開発環境（IDE）であり、より高度なコード分析やリファクタリング機能を提供しています。
プラグイン基本ファイル構造
最もシンプルなWordPressプラグインは、単なる1つのPHPファイルだけで構成されていることもあります。しかし、標準的なプラグインには、明確なファイル構造とディレクトリ構造が備わっています。これは、あなたのローカルのWordPressインストールディレクトリ内においても同様です。 wp-content/plugins フォルダ内で、あなたのプラグイン用に新しいフォルダを作成してください。例えば： my-first-pluginこのフォルダには、プラグインのすべてのファイルが格納されます。
あなたの最初のプラグイン「Hello Admin」を構築しましょう。“
「Hello Admin」という名前のプラグインを作成します。その機能は非常にシンプルで、WordPressの管理画面（ダッシュボード）の上部にカスタマイズされたウェルカムメッセージを表示するだけです。この例では、プラグイン開発の核心要素であるメインファイル、フック（Hooks）、および基本関数について説明します。
メインプラグインファイルの作成
あなたのプラグインフォルダに my-first-plugin 内側に、``という名前のものを作成してください。 my-first-plugin.php これはプラグインのエントリーファイルです。このファイルを開いて、まずファイルの冒頭に標準的なプラグイン情報のコメントを追加してください。これらのコメントはWordPressがプラグインを認識するために必要なものです。
<?php
/**
* Plugin Name: Hello Admin
* Plugin URI: https://yourwebsite.com/hello-admin
* Description: 一个简单的插件，用于在管理后台显示欢迎信息。
* Version: 1.0.0
* Author: 你的名字
* License: GPL v2 or later
* Text Domain: hello-admin
*/フックを使用して機能を追加する
WordPressの核心的な仕組みは「フック（Hooks）」であり、これにより特定のタイミングで自分のコードを実行することができます。フックには主に2種類あります：アクションフック（Action Hooks）とフィルターフック（Filter Hooks）です。管理画面でコンテンツを表示するには、アクションフックを使用する必要があります。
WordPressは、管理画面のヘッダー部分を読み込む際に、以下のような名前の機能を提供しています： admin_notices アクションフック。私たちは、それを通じて add_action() この関数によって、私たちが定義したカスタム関数がそのフックにマウントされます。
メインファイルのコメントの下に、以下のコードを追加してください：
// 钩子函数：在管理后台显示通知
function hello_admin_display_message() {
// 确保只对管理员显示，使用 current_user_can() 检查权限
if ( current_user_can( 'manage_options' ) ) {
echo '<div class="notice notice-success is-dismissible"><p>ようこそ戻ってきました、管理者！これはあなたがカスタマイズした「Hello Admin」というプラグインが実行中です。</p></div>';
}
}
// 将我们的函数挂载到 ‘admin_notices’ 这个动作钩子上
add_action( 'admin_notices', 'hello_admin_display_message' );テストとアクティベーション
ファイルを保存しましょう。次に、ローカルのWordPressウェブサイトの管理画面にアクセスしてください（通常は、ブラウザで「http://localhost:5000/」などのURLにアクセスします）。 /wp-admin「プラグイン」メニューに移動すると、プラグインの一覧の中に「Hello Admin」という項目が表示されるはずです。そこをクリックして「有効にする」を選択してください。有効化した後、ダッシュボードページを更新すると、ページの上部に緑色の成功通知が表示され、定義したウェルカムメッセージが表示されます。これで、最初のプラグインが正常に動作したことになります！
プラグインに設定可能なオプションを追加する
固定情報のみを表示するプラグインの実用性は限られています。次のステップとして、管理者が設定ページを通じて表示するメッセージをカスタマイズできるようにする必要があります。これには、管理メニューページの作成、フォームデータの処理、およびオプションAPIを使用したデータの保存が含まれます。
管理メニューページを作成します。
管理バックエンドに設定ページを追加する必要があります。これは以下の方法で実現できます： add_menu_page() または add_submenu_page() 関数の実装です。プラグインのメインファイルにコードを追加し続けましょう。
まず、設定ページのHTMLコンテンツを生成する関数を作成し、メニューアイテムを登録します：
// 创建插件设置页面
function hello_admin_add_settings_page() {
add_options_page(
'Hello Admin 设置', // 页面标题
'Hello Admin', // 菜单标题
'manage_options', // 所需权限
'hello-admin', // 菜单slug
'hello_admin_render_settings_page' // 用于渲染页面的回调函数
);
}
add_action( 'admin_menu', 'hello_admin_add_settings_page' );
// 渲染设置页面的HTML
function hello_admin_render_settings_page() {
?>
<div class="wrap">
<h1>こんにちは、Adminさん。設定についてお尋ねします。</h1>
<form method="post" action="/ja/options.php/" data-trp-original-action="options.php">
<?php
settings_fields( 'hello_admin_settings_group' ); // 设置组名称
do_settings_sections( 'hello-admin' ); // 页面slug
submit_button(); // 提交按钮
?>
<input type="hidden" name="trp-form-language" value="ja"/></form>
</div>
あなたのアカウントは有効です。あなたはログインしています。登録設定、フィールド、およびデータの保存
次に、WordPressのSettings APIを使用して、オプションを安全に登録、検証、保存する必要があります。別の関数を作成し、そこで… admin_init フックにそれを取り付けてください。
// 初始化设置
function hello_admin_settings_init() {
// 注册一个设置，将其存储在 wp_options 表中
register_setting( 'hello_admin_settings_group', 'hello_admin_custom_message', 'sanitize_text_field' );
// 在页面上添加一个设置区域（可以省略，此处为清晰而加）
add_settings_section(
'hello_admin_section',
'自定义消息设置',
null, // 可选的区域描述回调函数
'hello-admin'
);
// 在区域中添加一个字段
add_settings_field(
'hello_admin_message_field',
'欢迎消息',
'hello_admin_message_field_callback',
'hello-admin',
'hello_admin_section'
);
}
add_action( 'admin_init', 'hello_admin_settings_init' );
// 渲染消息输入字段
function hello_admin_message_field_callback() {
$message = get_option( 'hello_admin_custom_message', '欢迎回来，管理员！' ); // 获取已保存的值，没有则用默认值
echo '<input type="text" name="hello_admin_custom_message" value="' . esc_attr( $message ) . '" class="regular-text" />';
echo '<p class="description">ここに、管理バックエンドに表示したいウェルカムメッセージを入力してください。</p>';
}表示関数を修正し、設定項目を使用できるようにする。
最後に、最初の通知表示関数を修正する必要があります。 hello_admin_display_message()データベースのオプションからそれを選択してください。 hello_admin_custom_message ハードコーディングするのではなく、コンテンツを読み込みます。
function hello_admin_display_message() {
if ( current_user_can( 'manage_options' ) ) {
$custom_message = get_option( 'hello_admin_custom_message', '欢迎回来，管理员！' ); // 获取自定义消息
if ( ! empty( $custom_message ) ) {
echo '<div class="notice notice-success is-dismissible"><p>'`. esc_html($custom_message).`'</p></div>';
}
}
}今、すべての変更を保存しましょう。WordPressの管理画面に戻ると、「設定」メニューの中に「Hello Admin」という項目が表示されます。そのページにアクセスし、メッセージの内容を変更して保存してください。ダッシュボードを更新すると、表示されるメッセージが先ほど設定した内容に変わっているはずです。これで、基本的な機能を持つカスタムプラグインの作成が完了しました。
プラグイン開発のベストプラクティスとその後の手順
基本機能が実装された後、ベストプラクティスに従うことで、プラグインをよりプロフェッショナルなものにし、より安全にし、メンテナンスしやすくすることができます。
セキュリティが最優先です：ユーザーが入力したデータは常に検証し、エスケープ処理を行い、クリーニングしてください。WordPressが提供する関数を活用してください。 esc_html(), esc_attr(), sanitize_text_field(), wp_nonce_field() などです。ユーザーやデータベースからのデータを絶対に直接信頼してはいけません。
コードの整理とコメント：プラグインの機能が増えていくにつれて、コードを異なるクラスやファイルに分割していきましょう。オブジェクト指向プログラミング（OOP）を使用することで、コードの再利用性と整理性を高めることができます。関数やクラスには明確なコメントを追加してください。これは、将来の自分自身や協力者にとって非常に重要です。
国際化の準備：もしプラグインを公開する予定であれば、国際化（i18n）に対応している必要があります。つまり、以下の作業が必要になります： __() または _e() これらの関数を使用することで、ユーザーに表示されるすべてのテキストが適切に処理され、テキストドメイン（Text Domain）も設定されます。これにより、他の人々があなたのプラグインを他の言語に翻訳することが可能になります。
パフォーマンスに関する考慮事項：プラグインのリソース（CSS、JavaScript）は必要なときだけ読み込みましょう。条件判断を適切に使用し、すべてのページでバックエンドでのみ必要なスクリプトを読み込むことを避けてください。データベースクエリを最適化し、WordPressの「Transients」APIを効果的に利用してキャッシングを行いましょう。
さらに深く探求する：基礎をマスターした後は、より高度なトピックに取り組むことができます。例えば、カスタム記事タイプ（CPT: Custom Post Type）やカスタムカテゴリの作成、ショートコード（Shortcode）の追加、カスタムウィジェット（Widget）の開発、REST APIの統合、またはプラグイン用のドラッグアンドドロップ可能なブロック（Block）の作成などです。
概要
このガイドを通じて、ゼロから機能完備したWordPressカスタムプラグインを構築する全過程を完了しました。プラグイン開発の基本概念、つまりファイル構造やコアのフックシステム（Hooks）、そしてSettings APIを利用してセキュアな設定ページを作成する方法についても理解しました。「Hello Admin」というプラグインはシンプルですが、プラグイン開発の基本的なパターン——プラグインの宣言、機能の実装、データの処理、結果の出力——がすべて含まれています。これらの基礎をマスターすれば、WordPressの豊富な拡張機能をさらに探求するための鍵を手に入れたことになります。継続的な学習、ベストプラクティスの遵守、そして積極的な実践が、プラグイン開発スキルを向上させるための鍵となります。
FAQ よくある質問
WordPressのプラグインには、少なくともいくつのファイルが必要ですか？
最もシンプルな機能を持つプラグインは、1つのメインPHPファイルのみで構成されることがあります。このファイルに正しいプラグインヘッダー情報のコメントが含まれていれば、WordPressはそれを認識して有効にすることができます。しかし、機能が複雑になるにつれて、コードをより効率的に管理するために、JavaScriptやCSSのファイルを別途用意したり、機能ごとにPHPクラスを分けたりすることが一般的になります。
アクション フックの add_action とフィルター フックの add_filter の違いは何ですか？
アクションフック（Action Hooks）は、特定のタイミングでコードや機能を実行するために使用されます。これらは何らかの値を返すことを目的としていません。単に「何かを行う」だけです。例えば、記事が公開された後にメールを送信するといった処理がこれに該当します。
フィルターフック（Filter Hooks）はデータを変更するために使用されます。これらは入力値を受け取り、変更後の値を返すことを期待されます。例えば、記事のタイトルがブラウザに表示される前にその内容を変更する場合などです。最も大きな違いは、アクションは実行されるのに対し、フィルターはデータを変更してからその結果を返すという点です。
如何安全地将用户输入保存到数据库？
必ずWordPressが提供するオプションAPI関数を使用してください。update_option()とregister_setting()。register_setting()この関数では、クリーニング処理を行うコールバック関数を指定することができます（例：sanitize_text_fieldデータを保存する前に自動的に処理を行います。絶対に直接使用してはいけません。$wpdb未処理のユーザーデータをSQL文を使用して挿入すると、重大なセキュリティ上の脆弱性（例：SQLインジェクション）が発生する可能性があります。
プラグインを開発する際に、他のプラグインとの衝突を避けるにはどうすればよいでしょうか？
良いコーディング習慣は、コンフリクトを避けるための鍵です。すべての関数、クラス、変数、オプション名に一意の接頭辞を付けてください。例えば、以下のようにします：hello_admin_display_messageではなく、一般的なものではないdisplay_messageCSSスタイルとJavaScriptコードを特定のクラスやIDセレクタ内にまとめてください。フックを追加する際には、コールバック関数が必要な条件のみで実行されるようにしてください（例えば、現在のページやユーザー権限をチェックするなど）。
次はどうする？
拡大読書と実践的知識
以下は、この記事のトピックに関連しており、さらに深く読むのに適している。あなたの現在の問題に最も近い記事から優先順位をつけ、徐々に周辺のトピックに広げていく方が良い場合が多い。
日本語