WordPressプラグインの基本構造を理解する
WordPressプラグインは本質的に、特定の命名規則と構成に従った1つまたは複数のPHPファイルであり、WordPressが提供する「フック」（Hooks）システムを通じてコア機能を拡張または変更します。このアーキテクチャを理解することが、開発を成功させる第一歩です。
最もシンプルなプラグインは、メインファイル1つとプラグインヘッダーコメントだけで作成できます。プラグインヘッダーコメントは、WordPressがプラグインを認識するための重要な情報で、メインのPHPファイルの先頭に記述する必要があります。たとえば、「という名前のものはmy-first-plugin.phpそのファイルの内容の開始部分は、以下のようになっています：
<?php
/**
* Plugin Name: 我的第一个插件
* Plugin URI: https://example.com/my-first-plugin
* Description: 这是一个用于演示的简单WordPress插件。
* Version: 1.0.0
* Author: 你的名字
* License: GPL v2 or later
* Text Domain: my-first-plugin
*/この注釈は、WordPressのプラグイン管理画面に、これは「私の最初のプラグイン」という名前のプラグインであることを伝えます。このファイルを作成して配置します/wp-content/plugins/my-first-plugin/ディレクトリに配置すると、WordPress管理画面の「プラグイン」ページに表示され、有効化または無効化できるようになります。
推薦図書 WordPressプラグイン開発をゼロから学ぶ：あなたの最初のカスタム機能を作成しましょう。
プラグインの中核的な仕組みは「フック」を中心に成り立っています。フックは2種類に分かれます。アクション（Action）とフィルター（Filter）です。アクションフックを使うと、特定のタイミング（記事の公開時やページの読み込み時など）でカスタムコードを実行できます。フィルターフックを使うと、処理の途中で生成されるデータ（記事の内容やタイトルなど）を変更できます。あなたのプラグインコードは主に միջոցովadd_action()とadd_filter()この2つの関数は、これらのフックに「登録」されます。
初めてのプラグイン開発環境を構築する
コーディングを始める前に、信頼できるローカル開発環境を整えることが重要です。これにより、安全にテストやデバッグを行えます。
適切なローカルサーバーツールを選ぶ
統合されたローカルサーバーソリューションの使用をお勧めします。例えば、Local by Flywheel、XAMPP、MAMPなどです。これらはPHP、MySQL、Apache/Nginxを含む完全な環境をワンクリックでインストールでき、設定プロセスを大幅に簡素化します。特にLocal by FlywheelはWordPressに非常に優れたサポートを提供しており、WordPressサイトの迅速な作成やクローンが可能です。
プラグインディレクトリとファイルを初期化
あなたのローカルWordPressサイトのwp-content/plugins/ディレクトリ内に、あなたのプラグイン用の個別のフォルダを作成します。フォルダ名には小文字、数字、ハイフンを使用し、できるだけプラグインのメインファイル名と一致させてください。たとえば、フォルダを作成しますgreeting-pluginそして、その中にメインファイルを作成します。greeting-plugin.php。
コード構成をわかりやすく保つため、最初からモジュール化された構造を採用することをおすすめします。基本的なプラグインのディレクトリ構成は、以下のようになります。
推薦図書 WordPressプラグイン開発を徹底解説：ゼロから始める効率的なカスタマイズ。
greeting-plugin/
├── greeting-plugin.php // 主文件，包含插件头部注释和核心逻辑
├── includes/ // 存放核心功能类或函数文件
├── admin/ // 存放后台管理界面相关文件
├── public/ // 存放前端功能相关文件
├── assets/ // 存放CSS、JavaScript和图片资源
│ ├── css/
│ ├── js/
│ └── images/
└── languages/ // 存放国际化翻译文件（可选）コア機能の実装とバックエンド管理
学んだ知識を実例でつなげてみましょう。Webサイトのフロント画面にパーソナライズされたあいさつを表示し、管理画面であいさつ文を自由に設定できるプラグインを作成します。
基本機能関数を作成
まず、メインファイル内で…greeting-plugin.phpヘッダーコメントの下に、コア機能を実現する関数を記述してください。その関数は…display_greeting()挨拶文を取得し、出力の準備をするためのものです。
function display_greeting() {
// 从WordPress选项中获取存储的问候语，默认为“欢迎光临！”
$greeting_text = get_option('my_greeting_text', '欢迎光临！');
// 将问候语进行安全转义后返回
return '<p class="custom-greeting">'`. esc_html($greeting_text)`.'</p>';
}この挨拶文を記事の内容の後に表示するためには、アクションフックを使用する必要があります。the_content。新しい関数を作成しますappend_greeting_to_content()、そのフックにマウントします。
function append_greeting_to_content( $content ) {
// 只在单篇文章和页面中追加问候语
if ( is_single() || is_page() ) {
$content .= display_greeting();
}
return $content;
}
// 将函数挂载到‘the_content’过滤器
add_filter( 'the_content', 'append_greeting_to_content' );プラグイン管理メニューと設定ページを追加
ユーザーが挨拶文をカスタマイズできるようにするには、WordPressの管理画面に設定ページを追加する必要があります。これは通常、admin/サブディレクトリに個別のファイルを作成して処理します。例えばadmin/settings-page.php。
まず、メインファイルで使用しますadd_action()管理メニューを作成する関数をフックします。
// 仅在后台加载时引入管理页面代码
if ( is_admin() ) {
require_once plugin_dir_path( __FILE__ ) . 'admin/settings-page.php';
}はい。admin/settings-page.phpファイルでは、メニューの作成とフォーム処理のロジックを記述します。重要な関数はadd_options_page()。
推薦図書 ゼロから始める：初めてのWordPressプラグイン構築。
function my_greeting_add_admin_menu() {
add_options_page(
'问候语设置', // 页面标题
'自定义问候语', // 菜单标题
'manage_options', // 所需权限
'greeting-settings', // 菜单slug
'my_greeting_settings_page' // 用于显示页面内容的回调函数
);
}
add_action( 'admin_menu', 'my_greeting_add_admin_menu' );
function my_greeting_settings_page() {
?>
<div class="wrap">
<h1>あいさつ設定</h1>
<form method="post" action="/ja/options.php/" data-trp-original-action="options.php">
<?php
settings_fields( 'greeting_settings_group' ); // 设置组名
do_settings_sections( 'greeting-settings' ); // 页面slug
submit_button();
?>
<input type="hidden" name="trp-form-language" value="ja"/></form>
</div>
あなたのアカウントは有効です。あなたはログインしています。次に、設定オプションを登録する必要がありますmy_greeting_text、入力フィールドを追加します。これはregister_setting()、add_settings_section()とadd_settings_field()関数が完了しました。
function my_greeting_settings_init() {
register_setting( 'greeting_settings_group', 'my_greeting_text' );
add_settings_section(
'greeting_settings_section',
'编辑问候文本',
null,
'greeting-settings'
);
add_settings_field(
'my_greeting_field',
'问候语内容',
'my_greeting_field_render',
'greeting-settings',
'greeting_settings_section'
);
}
function my_greeting_field_render() {
$value = get_option( 'my_greeting_text', '欢迎光临！' );
echo '<input type="text" name="my_greeting_text" value="' . esc_attr( $value ) . '" class="regular-text">';
}
add_action( 'admin_init', 'my_greeting_settings_init' );ユーザーは「設定」→「カスタムあいさつ」ページでテキストを変更でき、更新後のあいさつがサイト上の記事やページ本文の末尾に表示されます。
プラグインのセキュリティ対策、最適化、および公開の準備
優れたプラグインとは、単に動作するだけでなく、安全で効率的であり、かつメンテナンスも容易でなければなりません。
セキュリティベストプラクティスの実施
安全性は最優先事項です。ユーザー入力やデータベースから取得してフロントエンドに出力するすべてのデータは、必ずエスケープする必要があります。WordPressが提供する関数を使用してください。例えば、esc_html()、esc_attr()、wp_kses_post()など。フォーム送信や非AJAXリクエストを処理する際は、必ず使用してくださいwp_verify_nonce()とcheck_admin_referer()リクエストの正当性を検証し、クロスサイトリクエストフォージェリ（CSRF）攻撃を防止します。
プラグインが導入するフロントエンドのスクリプトまたはスタイルシートには、必ず使用してくださいwp_enqueue_script()とwp_enqueue_style()適切に登録して読み込みます。これにより依存関係が正しく保たれ、競合を防げます。また、スクリプトオブジェクトにはwp_localize_script()PHP変数を安全にJavaScriptに渡す方法です。
国際化・ローカライズを行う
プラグインを世界中のユーザーに利用してもらうには、国際化に対応する必要があります。つまり、プラグイン内のユーザー向けテキスト文字列をすべて用いて__()または_e()などの翻訳関数で囲みます。メインファイルの先頭コメントでは、Text Domainプラグインのディレクトリ名と一致している必要があります。例えば：
Text Domain: greeting-plugin
その後、翻訳ツール（Poedit など）を使って生成できます.pot翻訳者がこれを基に作成できるテンプレートファイル.poと.moそのファイルは、プラグイン内に保存されています。languages/フォルダの中にあります。
WordPress公式ディレクトリへの公開準備
プラグインをWordPress.orgのプラグインディレクトリに登録する予定がある場合は、追加の準備が必要です。まず、コードがWordPressのコーディング規約に準拠していることを確認しましょう。次に、詳しいreadme.txtファイルはディレクトリの要件に沿った形式にし、説明、インストール手順、スクリーンショット、更新履歴などを含める必要があります。さらに、プラグインをSVNリポジトリに提出し、ディレクトリ構成が規定に準拠していることを確認する必要があります。公開前には、異なるバージョン、テーマ、他のプラグインとの互換性を必ず徹底的にテストしてください。
概要
WordPressプラグインの開発とは、アイデアを実際の機能に変えていくプロセスです。その鍵は、フックシステムを理解し、熟知することにあります。正しいヘッダーコメントを含む単一のファイルから作成を始め、徐々に機能モジュールを構築し、セキュリティコーディングや国際化の基準を厳守することで、プロフェッショナルで信頼性の高いプラグインを作り上げることができます。ローカル環境の構築、コードのモジュール化、フロントエンドとバックエンドの連携、そして公開の準備といった一連のプロセスを実践することで、プラグインをゼロから作成するための基本スキルを身につけました。WordPressのコアAPIを継続的に学び、優れたプラグインのソースコードを深く研究することが、開発スキルを向上させる最良の方法です。
FAQ よくある質問
プラグイン開発にはPHPに精通している必要がありますか？
はい、しっかりとしたPHPの基礎知識は必須です。WordPress自体がPHPで作られており、プラグインのコードも主にPHPで書かれているためです。PHPの文法、関数、オブジェクト指向プログラミング、そしてMySQLデータベースとの連携方法を理解しておく必要があります。さらに、ユーザーインターフェースを作成するうえで、HTML、CSS、JavaScriptの基本知識もあると役立ちます。
プラグインをデバッグするには？
WordPressにはさまざまなデバッグツールが用意されています。まず、あなたのwp-config.phpファイルでデバッグモードを有効にすると、WP_DEBUG定数は次のように設定されています。true。これにより、画面にPHPのエラー、警告、通知が表示されます。さらに、error_log()この関数は、カスタム情報をサーバーのエラーログに記録したり、データベースクエリやフック、スクリプトなどを分析できる、より高度なツールであるQuery Monitorプラグインを使用したりできます。開発者にとって心強いツールです。
私のプラグインはテーマや他のプラグインと競合しますか？
可能です。競合は通常、次のような原因で発生します。一般的な関数名、クラス名、または定数名を使用していること、読み込まれたスクリプトやスタイルシートが競合していること、または同じフックの優先順位が適切に処理されていないことです。命名の競合を避けるため、すべての関数、クラス、定数には固有のプレフィックスを付ける必要があり、通常はプラグイン名またはその略称に関連付けます。使用wp_enqueue_script一連の関数で、アセットのライフサイクルを適切に管理できます。コア動作を変更する際は、フックの優先順位と依存関係を慎重に検討してください。
私のプラグイン用に独立したデータテーブルを作成する必要がありますか？
ほとんどの場合、新しいデータベーステーブルを直接作成する必要はなく、また推奨されません。WordPressには、キー値ペアのデータを保存するための強力なOptions APIや、記事やユーザーに関連するデータを保存するためのPost Meta/User Meta APIが用意されており、これらで90%以上のデータ保存ニーズに対応できます。独立したデータを大量に保存し、そのデータ間に複雑な関係があり、かつ効率的なクエリが必要な場合にのみ、新しいデータベーステーブルの作成を検討するべきです。$wpdbクラスを使ってカスタムテーブルを作成できますが、プラグインが大幅に複雑になります。
プラグインに設定オプションを追加するには？
前述のとおり、標準的な方法はWordPressのSettings APIを使うことです。このAPIは、セキュリティ（nonceの検証など）、ユーザー権限のチェック、画面のレンダリングを処理してくれます。手順は次のとおりです。使用するadd_menu_page()またはその派生関数（例えば）add_options_page()）メニューとページを追加してから使用register_setting()、add_settings_section()とadd_settings_field()具体的な設定項目を定義・表示します。手動でフォームを作成して送信を処理するよりも、安全で標準的です。
次はどうする？
拡大読書と実践的知識
以下は、この記事のトピックに関連しており、さらに深く読むのに適している。あなたの現在の問題に最も近い記事から優先順位をつけ、徐々に周辺のトピックに広げていく方が良い場合が多い。
日本語