なぜ自分でWordPressプラグインを開発するのでしょうか？
WordPressのエコシステムにおいて、プラグインはウェブサイトの機能を拡張するための鍵となる存在です。市場には何千ものプラグインが存在しますが、自分でプラグインを開発することには独自の利点があります。まず、自分のニーズに完全に合わせたカスタマイズされた機能を実現できるため、汎用のプラグインを使用する際に生じるコードの肥大化や不要な機能を避けることができます。次に、自作のプラグインはテーマやその他のカスタマイズされたコードと深く統合することができ、より高い互換性とパフォーマンスを保証できます。さらに、プラグインを開発することでビジネスロジックをテーマのコードから分離することができ、これはWordPress開発における最良の慣行の一つです。このようにすることで、将来テーマを変更してもコア機能は正常に動作し続け、ウェブサイトのメンテナビリティが向上します。
開発者にとって、プラグイン開発を学ぶことはWordPressのアーキテクチャを深く理解するための絶好の方法です。アクションフックについても触れることになるでしょう。add_actionフィルターフックadd_filterショートコードadd_shortcodeこれらの核心概念をマスターすることで、プラグインを作成するだけでなく、既存のテーマやプラグインをより効率的にカスタマイズすることもできるようになります。
開発前の環境設定と準備作業
最初のコード行を書き始める前に、適切な開発環境を構築することが非常に重要です。これにより、効率が向上するだけでなく、エラーの発生も防ぐことができます。
推薦図書 WordPressプラグイン開発入門から上級者へ：実践経験とコアテクニックの共有。
ローカル開発環境の構築
ローカルサーバーソフトウェアの使用をお勧めします。例えば、Local by Flywheel、XAMPP、MAMPなどです。これらを使えば、コンピューター上でApache、MySQL、PHPを備えたWordPressの運用環境を簡単に構築できます。オンラインサーバーと比べて、ローカル開発では迅速にテストやデバッグを行うことができ、オンラインサイトに影響を与える心配もありません。
WordPressをローカルにインストールした後、次に必要な作業は…wp-content/pluginsディレクトリ内に、新しいプラグイン用の専用フォルダを作成してください。フォルダ名には、短く、小文字で、スペースのない英語の単語を使用することをお勧めします。例えば：my-first-plugin。
プラグインの基本構造について理解する
最もシンプルなWordPressプラグインは、1つのメインファイルのみで構成されることがあります。このファイルには、プラグイン情報をWordPressが認識するための特定のヘッダーコメントが含まれていなければなりません。また、セキュリティ対策として、直接アクセスを防ぐ仕組みも必要です。これは通常、アクセスをチェックすることによって実現されます。ABSPATH定数（constant）は、実際に定義されていることによって存在するのです。
以下は、最小化されたプラグインのメインファイルの例です。このファイルは「plugin_main.min.js」という名前で保存することができます。my-first-plugin.phpそして、先ほど作成したフォルダーに置いてください。
<?php
/**
* Plugin Name: 我的第一个插件
* Plugin URI: https://yourwebsite.com/my-first-plugin
* Description: 这是一个用于学习的入门级WordPress插件。
* Version: 1.0.0
* Author: 你的名字
* License: GPL v2 or later
*/
// 防止直接访问此文件
if ( ! defined( 'ABSPATH' ) ) {
exit;
}このファイルが含まれているフォルダを以下の場所に置いてください：wp-content/pluginsディレクトリにアップロードすると、WordPressの管理画面（バックエンド）の「プラグイン」ページでそのプラグインが表示され、有効にすることができます。
推薦図書 WordPressプラグイン開発の究極ガイド：ゼロからカスタム機能の拡張を構築する。
最初のコア機能を作成します。
では、このプラグインにいくつか実際の機能を追加しましょう。まず、記事の内容の最後に自動的にカスタムテキストを追加するというシンプルな機能を作成します。
フィルターを使って記事の内容を変更する。
WordPressには多数のフィルターフック（Filter Hooks）が用意されており、データがデータベースに保存される前やブラウザに出力される前にそれを変更することができます。記事の内容を変更するには、これらのフィルターフックを利用することができます。the_contentフィルター。
あなたのメインプラグインファイル内で、フックを有効にした後に、以下の関数とフックの呼び出しを追加してください：
// 定义向文章内容追加文本的函数
function my_first_plugin_add_text_to_content( $content ) {
// 确保只在主循环的单篇文章页面执行
if ( is_single() && in_the_loop() && is_main_query() ) {
$additional_text = '<p><em>この記事をお読みいただき、ありがとうございます！この記事は「My First Plugin」のサポートによって作成されました。</em></p>';
$content .= $additional_text;
}
return $content;
}
// 将函数挂载到‘the_content’过滤器上
add_filter( 'the_content', 'my_first_plugin_add_text_to_content' );この関数はまず一連の条件判断を行い、追加されたテキストが個別の記事ページにのみ表示され、ホームページやアーカイブページに影響を与えないようにします。その後、カスタムされたHTMLパラグラフを元のコンテンツに追加します。$content変数の後に、修正後の内容を返します。
シンプルな管理設定ページを作成します。
ユーザーが追加したいテキストを自分でカスタマイズできるようにするためには、設定オプションを作成する必要があります。これには、WordPressの管理画面にメニューアイテムと設定ページを追加する作業が含まれます。
まず、を使用してadd_actionフックを使用して、管理者メニューにサブメニューページを追加します：
推薦図書 WordPressプラグイン開発をマスターしよう：ゼロから始めて、あなたの最初のカスタムプラグインを作成しましょう。。
// 创建管理菜单
function my_first_plugin_add_admin_menu() {
add_options_page(
'我的第一个插件设置', // 页面标题
'我的插件设置', // 菜单标题
'manage_options', // 所需权限
'my-first-plugin', // 菜单slug
'my_first_plugin_settings_page' // 显示页面的回调函数
);
}
add_action( 'admin_menu', 'my_first_plugin_add_admin_menu' );次に、表示設定ページを表示するためのコールバック関数を定義します。my_first_plugin_settings_pageそして、フォームの保存ロジックも処理する必要があります。
// 设置页面的HTML内容
function my_first_plugin_settings_page() {
?>
<div class="wrap">
<h2>私の最初のプラグインの設定</h2>
<form method="post" action="/ja/options.php/" data-trp-original-action="options.php">
<?php
settings_fields( 'my_first_plugin_settings_group' );
do_settings_sections( 'my-first-plugin' );
submit_button();
?>
<input type="hidden" name="trp-form-language" value="ja"/></form>
</div>
<?php
}
// 注册设置、区域和字段
function my_first_plugin_settings_init() {
register_setting( 'my_first_plugin_settings_group', 'my_first_plugin_custom_text' );
add_settings_section(
'my_first_plugin_section',
'自定义文本设置',
null,
'my-first-plugin'
);
add_settings_field(
'my_first_plugin_text_field',
'要在文末添加的文本',
'my_first_plugin_text_field_render',
'my-first-plugin',
'my_first_plugin_section'
);
}
add_action( 'admin_init', 'my_first_plugin_settings_init' );
// 渲染文本输入字段
function my_first_plugin_text_field_render() {
$option = get_option( 'my_first_plugin_custom_text', '感谢您阅读这篇文章！本文由“我的第一个插件”提供支持。' );
echo '<textarea name="my_first_plugin_custom_text" rows="3" cols="50">' . esc_textarea( $option ) . '</textarea>';
}最後に、以前に追加されたテキストを処理する関数を修正し、その処理がオプションに基づいて行われるようにします。my_first_plugin_custom_text中から内容を読み取る：
function my_first_plugin_add_text_to_content( $content ) {
if ( is_single() && in_the_loop() && is_main_query() ) {
$custom_text = get_option( 'my_first_plugin_custom_text', '' );
if ( ! empty( $custom_text ) ) {
$additional_text = '<p><em>'`. wp_kses_post($custom_text)`.'</em></p>';
$content .= $additional_text;
}
}
return $content;
}プラグインのセキュリティ対策、最適化、および配布の準備
優れたプラグインとは、単に正常に動作するだけでなく、安全性が高く、効率的であり、かつメンテナンスも容易でなければなりません。
データ検証、エスケープ処理、およびセキュリティ
セキュリティはプラグイン開発において非常に重要です。ユーザーが入力したデータやデータベースから直接取得したデータを絶対に信頼してはいけません。データをページに出力する際には、必ずエスケープ処理を行う必要があります。前のコードでは、その処理を行っていました。esc_textarea()管理ページで出力をエスケープ処理し、それを使用します。wp_kses_post()記事ページでHTMLをフィルタリングする際には、安全な投稿コンテンツのタグのみが通過するように設定する必要があります。フォーム処理については、WordPressが提供する検証機能や権限チェックを使用するべきです。sanitize_text_field()などの関数を使用してデータをクリーニングします。
コードの整理とパフォーマンスの最適化
プラグインの機能が増えるにつれて、すべてのコードを1つのメインファイルに書くと管理が困難になります。良い方法は、機能に応じてコードを別々のファイルに分割することです。例えば、以下のようにできます：includes/admin/ディレクトリには管理バックエンドに関連するすべてのコードが保存されています。includes/public/ディレクトリにはフロントエンド機能のコードが保存されています。includes/class-*.phpクラス定義を格納する場所。
パフォーマンスの観点から、フックの使用には注意が必要です。フック内の関数は、条件判断などにより必要な場合にのみ実行するようにしてください。データベースから読み取る必要があるオプション値については、特にフロントエンドで何度も使用される場合には、グローバル変数に保存したり、オブジェクトキャッシュを利用したりすることで、データベースへの繰り返しアクセスを避けることができます。
プラグインの公開を準備しています。
もしプラグインをWordPressの公式プラグインディレクトリに公開したり、より多くの人に利用してもらいたいと考えているのであれば、いくつかの点を改善する必要があります。まず、プラグインのヘッダーにあるコメント情報を完全かつ正確に記述することです。次に、分かりやすい説明文を書くことが重要です。readme.txtこのファイルでは、WordPressの公式フォーマットに従って、プラグインの機能、インストール手順、よくある質問などについて説明します。最後に、異なるPHPバージョン、異なるWordPressバージョン、さらには異なるテーマや他の人気のあるプラグインとの互換性も含めて、徹底的なテストを行います。
概要
このガイドを通じて、ゼロから機能が完備されたWordPressプラグインを作成するまでの全過程を完了しました。プラグインの基本構造、アクションやフィルターフックを利用してWordPressのコアとどのように相互作用するか、管理ページの作成方法について学び、プラグインのセキュリティや組織化の重要性についても初歩的な理解を深めました。プラグイン開発の鍵は、WordPressのイベント駆動型アーキテクチャを理解し、適切なタイミングで自分のカスタムコードを組み込むことにあります。この知識を基に、カスタムの記事タイプ、メタデータ、REST APIエンドポイント、データベーステーブルの作成といったより高度な機能についても探求し、徐々に強力でプロフェッショナルレベルのプラグインを構築していくことができます。
FAQ よくある質問
WordPressプラグインを開発するには、以下のような基礎知識が必要です：
PHPプログラミング言語の基本文法やオブジェクト指向プログラミングの概念を習得し、HTML、CSS、JavaScriptについても基本的な知識を持っていることが求められます。WordPressの基本的な操作方法や、記事、ページ、カテゴリといったコア概念にも精通していると非常に役立ちます。最も重要なのは、WordPressのフック（Actions and Filters）メカニズムを理解することです。これはプラグインがWordPressと相互作用するための主要な手段です。
プラグインとテーマの機能にはどのような違いがあり、どのように選択すべきでしょうか？
テーマは主にウェブサイトの外観やレイアウトを制御するものであり、プラグインは機能を追加するためのものです。良い原則としては、機能が視覚的な表現と密接に関連している場合はテーマ内に組み込む方が適しています。一方で、連絡フォーム、SEO最適化、電子商取引といった独立した機能についてはプラグインとして作成するべきです。機能をプラグインとして実装することで、テーマを変更してもその機能が失われることがなくなります。これはWordPress開発におけるベストプラクティスです。
プラグイン内で複数のPHPファイルを作成することはできます。
もちろん可能です。特に複雑なプラグインにおいては、このようなアプローチが推奨されます。異なる機能モジュールを別々のファイルに分割し、メインのプラグインファイル内でそれらを統合することで、管理が容易になります。require_onceまたはinclude_once適切な文法や構文を使用してこれらを導入することが大切です。良質なファイル構造は、コードの整理やチームワークの促進に役立ちます。
如何调试我开发的插件
WordPressの開発においてよく使われるデバッグ方法は、デバッグ機能を有効にすることです。WP_DEBUGあなたはウェブサイト上でそれを行うことができます。wp-config.phpファイルの中で、define( 'WP_DEBUG', true );これにより、PHPのエラー、警告、および通知が画面上に表示されます。より安全な方法としては、これらを同時に設定することです。WP_DEBUG_LOGためにtrueエラーを以下の場所に記録してください：wp-content/debug.logファイル内にあります。さらに、ブラウザの開発者ツールやクエリモニター（Query Monitor）のようなデバッグプラグインを使用すると、効率が大幅に向上します。
私のプラグインは、どのくらい古いWordPressバージョンとも互換性がある必要があります。
それはあなたのターゲットユーザーによります。一般的には、現在のメインバージョンの過去2つのバージョンには少なくとも対応していることが推奨されます。WordPressの公式統計データを参照すると、バージョンの分布について詳しくわかります。コード内では、条件文を使用することで対応を実現できます。function_exists()プラグイン内で、ある関数やクラスが利用可能かどうかをチェックし、それによってバックワード互換性を確保することができます。readme.txtファイル内では、テストに合格したWordPressのバージョンを明確に記載する必要があります。
次はどうする？
拡大読書と実践的知識
以下は、この記事のトピックに関連しており、さらに深く読むのに適している。あなたの現在の問題に最も近い記事から優先順位をつけ、徐々に周辺のトピックに広げていく方が良い場合が多い。
日本語