なぜWordPressのプラグイン開発を選ぶのでしょうか？
WordPressが世界で最も人気のあるコンテンツ管理システム（CMS）になれたのは、その強力なプラグインアーキテクチャのおかげです。プラグインを使えば、開発者はコアコードを変更することなく、シンプルな連絡フォームから高度な電子商取引システムまで、ウェブサイトにほぼあらゆる機能を追加することができます。プラグイン開発を学ぶことで、WordPressをさらにカスタマイズし、特定のビジネスニーズに応えたり、自分のアイデアを再利用可能な製品に変えたりすることができるのです。
自分でプラグインを開発することは、テーマを直接修正することに比べて、以下のような利点があります： functions.php このファイルには顕著な利点があります。プラグインはテーマから独立した機能モジュールであり、テーマを切り替えてもその機能は失われません。これにより、コードのメンテナンスや更新が容易になり、異なるプロジェクト間での共有も可能になります。プラグイン開発の核心的なメカニズムを理解することは、上級のWordPress開発者になるための必要条件です。
開発環境の構築
最初のコード行を書く前に、安定して効率的なローカル開発環境が不可欠です。これにより、オンラインサイトに影響を与えることなくテストやデバッグを行うことができます。
推薦図書 WordPressプラグイン開発実践ガイド：ゼロから始めて、あなたの最初の機能プラグインを構築する。
ローカルサーバーの環境設定
統合されたローカルサーバーソリューション、例えばLocal by Flywheel、XAMPP、MAMPの使用をお勧めします。これらはApache/Nginx、PHP、MySQLをワンクリックでインストールできます。使用するPHPのバージョンが対象のWordPressバージョンと互換性があることを確認してください。一般的にはPHP 7.4以降のバージョンの使用が推奨されます。また、プラグインのテストを行うために、ローカルサーバー上に新しいWordPressをインストールする必要があります。
コードエディタとデバッグツール
機能豊富なコードエディタを選択してください。例えば、Visual Studio CodeやPHPStormなどがあります。これらのエディタには、構文のハイライト表示、コードヒント、バージョン管理の統合機能が備わっています。デバッグを行うには、WordPressのデバッグモードを有効にする必要があります。これには、WordPressのルートディレクトリ内の設定ファイルを編集する必要があります。 wp-config.php ファイル、それを… WP_DEBUG 定数は次のように設定されています。 true。
define( 'WP_DEBUG', true );
define( 'WP_DEBUG_LOG', true ); // 将错误日志保存到 /wp-content/debug.log
define( 'WP_DEBUG_DISPLAY', false ); // 不要在页面上显示错误デバッグモードを有効にすると、発生するすべてのPHPエラー、警告、および通知が記録されるため、問題の迅速な特定に役立ちます。
最初のプラグインファイルを作成しましょう。
WordPressのプラグインは、たった1つのファイルで構成されているものもありますが、適切な構造を守ることが非常に重要です。まずは、最も基本的な「Hello World」プラグインから始めましょう。
プラグインのメインファイルの構造
まず、WordPressの中で… /wp-content/plugins/ ディレクトリ内に新しいフォルダを作成します。例えば、 my-first-pluginこのフォルダ内に、メインのPHPファイルを作成してください。ファイル名は通常、フォルダ名と同じになります。my-first-plugin.php。
推薦図書 WooCommerceプラグインのカスタム開発ガイド：オンラインストアを自分だけのものにする。
すべてのプラグインは、ファイルの冒頭に標準的なプラグイン情報のコメントブロックを含める必要があります。WordPressはこのブロックを通じてプラグインを認識し、管理画面で表示します。
<?php
/**
* Plugin Name: 我的第一个插件
* Plugin URI: https://www.yourwebsite.com/my-first-plugin/
* Description: 这是一个学习 WordPress 插件开发的示例插件。
* Version: 1.0.0
* Author: 你的名字
* Author URI: https://www.yourwebsite.com/
* License: GPL v2 or later
* Text Domain: my-first-plugin
* Domain Path: /languages
*/ファイルを保存した後、WordPressの管理画面にログインし、「プラグイン」ページに移動してください。新しく追加されたプラグインがプラグイン一覧に表示されているはずです。この時点ではまだ何の機能もありませんが、有効にすることはできます。
最初の機能を追加します：メニューの管理
次に、プラグインに簡単な機能を追加しましょう：WordPressの管理画面のサイドバーに新しいメニュー項目を追加する機能です。
私たちは使用する予定です。 add_action() 関数を使って、コールバック関数をマウントする admin_menu このアクションはフックに掛けられています。
// 在插件主文件中，插件头部注释块之后，添加以下代码
if ( ! defined( 'ABSPATH' ) ) {
exit; // 禁止直接访问
}
// 钩子到 admin_menu 动作
add_action( 'admin_menu', 'mfp_add_admin_menu' );
/**
* 注册一个自定义管理菜单
*/
function mfp_add_admin_menu() {
add_menu_page(
'我的第一个插件设置', // 页面标题
'我的插件', // 菜单标题
'manage_options', // 所需权限
'my-first-plugin', // 菜单别名 (slug)
'mfp_display_admin_page', // 显示页面内容的回调函数
'dashicons-smiley', // 菜单图标 (使用 Dashicon)
6 // 菜单位置
);
}
/**
* 管理页面的显示内容
*/
function mfp_display_admin_page() {
?>
<div class="wrap">
<h1></h1>
<p>こんにちは、世界！これが私の初めてのWordPressプラグイン管理ページです。</p>
</div>
あなたのアカウントは有効です。あなたはログインしています。ファイルを保存し、WordPressの管理画面を更新すると、左側のメニューバーに「My Plugins（私のプラグイン）」という新しいメニュー項目が表示されます。これをクリックすると、ウェルカムメッセージが表示されるシンプルなページが開きます。
核心を掘り下げる：フックとフィルター
WordPressプラグイン開発の核心的な考え方は「フック（Hooks）」です。フックを利用することで、自分のコードをWordPressのコアプロセスの特定のタイミングで呼び出し、機能を変更したり追加したりすることができます。フックには主に2種類あります：アクション（Actions）とフィルター（Filters）です。
推薦図書 WordPressテーマ開発とカスタマイズガイド：初心者から上級者まで、オリジナルウェブサイトを作成する方法。
アクションフックを理解する
アクションフックは、WordPressが特定のタイミングで実行する処理（例えば記事の保存、ページヘッダーの読み込み、ページフッターの出力など）の際にトリガーされます。あなたのプラグインはこれらのタイミングを「監視」し、自分の関数を実行することができます。先ほど私たちが使用したのも、そのようなアクションフックです。 admin_menu それは単なるアクションフック（action hook）に過ぎません。
もう一つのよくある例は、記事の内容の最後に自動的にテキストを追加することです。
add_action( 'the_content', 'mfp_append_text_to_content' );
function mfp_append_text_to_content( $content ) {
if ( is_single() && in_the_loop() && is_main_query() ) {
$append_text = '<p><em>この記事は、私の最初のプラグインによって生成されました。</em></p>';
$content .= $append_text;
}
return $content;
}フィルターを使用してデータを変更する
フィルターフックは、データがデータベースに保存される前やブラウザに送信される前にそれを変更するために使用されます。これらのフックはデータを受け取り、変更後にはそのデータを返す必要があります。典型的な例としては、記事のタイトルを変更する場合が挙げられます。
add_filter( 'the_title', 'mfp_modify_post_title' );
function mfp_modify_post_title( $title ) {
// 只在非后台的主查询中修改
if ( ! is_admin() && in_the_loop() ) {
$title = '[重要] ' . $title;
}
return $title;
}フックを理解し、熟知して使いこなすことは、柔軟で強力なプラグインを構築するための鍵です。WordPressのコアには何千ものフックが用意されており、プラグインのライフサイクル全体にわたって利用されています。
プラグインのセキュリティとベストプラクティス
安全なコードを書き、ベストプラクティスに従うことで、プラグインの安定性、効率性が保たれ、他の開発者にも受け入れられやすくなります。
データ検証とエスケープ処理
ユーザーが入力したデータやデータベースから取得したデータを絶対に信用してはいけません。どんなデータもブラウザに出力する際（HTML、JavaScript、属性などを通じて）には、必ずエスケープ処理を行う必要があります。WordPressにはそのための補助関数が用意されています。
// 输出到 HTML 内容中
echo esc_html( $untrusted_data );
// 输出到 HTML 属性中
echo esc_attr( $untrusted_data );
// 输出到 URL 中
echo esc_url( $untrusted_data );
// 在 JavaScript 变量中输出
$js_data = wp_json_encode( $untrusted_data );データをデータベースに保存したり、論理的な判断を行う前には、検証（Validation）が必要です。これにより、データが期待される形式（メールアドレスや数字など）に合致しているかを確認するのです。
命名空間とクラスの使用
複雑なプラグインについては、PHPのネームスペースとオブジェクト指向プログラミング（OOP）を使用してコードを整理することをお勧めします。これにより、関数名の衝突を効果的に防ぎ、コードのモジュール化と可読性を向上させることができます。
<?php
namespace MyFirstPluginAdmin;
class Admin_Menu {
public function __construct() {
add_action( 'admin_menu', [ $this, 'add_menu_page' ] );
}
public function add_menu_page() {
add_menu_page( ... );
}
}
// 初始化
new Admin_Menu();さらに、プラグインに国際化対応（多言語サポート）を追加するためには、以下の手順を行います： __() と _e() 関数の実装、適切なアンインストール時のクリーニングオプションの提供、WordPressのコーディング基準の遵守などは、優れたプラグインの重要な構成要素です。
概要
WordPressプラグインの開発は、初歩的な内容から徐々に高度な内容へと進んでいくプロセスです。まずはWordPressが認識できる基本ファイルを作成するところから始め、次にアクションやフィルターハックといった強力なシステムを使って機能を拡張していきます。これらすべてのステップは、WordPressのアーキテクチャを深く理解した上で行われます。ローカル開発環境はあなたの「実験室」のようなものであり、デバッグツールはその「顕微鏡」の役割を果たします。そして、セキュリティとベストプラクティスは、あなたが開発したプラグインが安定して信頼性の高いものになるための重要な基盤です。
シンプルな管理メニュープラグインを作成することで、プラグイン開発の基本的な流れを実践しました。次に、設定オプションの統合、カスタムデータベーステーブルの作成、ショートコード機能の追加、または小さなツールの開発などを試してみることができます。継続的に実践し、コアコードや他の優れたプラグインの実装を参考にしながら、より複雑な要求にも対応できるようになり、最終的にはプロフェッショナルレベルのWordPressプラグインを作り上げることができるでしょう。
FAQ よくある質問
WordPressのプラグインには、少なくともいくつのファイルが必要ですか？
WordPressのプラグインは、少なくとも1つのPHPファイルで構成されています。このファイルに正しいプラグインヘッダーのコメント情報が含まれていれば、WordPressはバックエンドのプラグインリストでそのプラグインを認識し、有効にすることができます。もちろん、機能が豊富なプラグインの場合は、メンテナビリティを高めるためにコードを複数のファイルやフォルダに分けて構成することが一般的です。
プラグイン開発中に関数名の衝突をどのように避けるか？
関数名の衝突を避ける主な方法は2つあります。1つ目は、すべての関数に一意な接頭辞を付けることです。例えば、プラグインの略称や頭字語を使用するといった方法です。 mfp_ または myplugin_2つ目は、PHPのクラスと名前空間を使用して関数をクラスメソッドの中に封じ込めることです。これはより現代的で推奨される方法であり、名前の衝突問題を根本的に解決することができます。
私のプラグインに設定オプションページを追加するにはどうすればよいですか？
プラグインに設定ページを追加するには、通常、以下のような方法が使用されます： add_options_page() または add_submenu_page() この関数を使用してページを登録し、その後WordPressの設定API（Settings API）を利用してオプションを安全に作成、検証、保存します。設定APIには以下の機能が含まれます： register_setting()、add_settings_section() と add_settings_field() これらの関数により、標準化された設定フォームの作成プロセスが簡素化され、セキュリティやデータの保存に関する処理も自動的に行われます。
開発が完了した後、プラグインをWordPressの公式ディレクトリに公開するにはどうすればよいでしょうか？
WordPress.orgの公式ディレクトリにプラグインを公開するには、まずWordPress.orgでプラグイン用のSVNリポジトリを申請する必要があります。次に、プラグインのコードが公式の要件やガイドラインに準拠していることを確認する必要があります。これには、コードの品質、セキュリティ、ライセンス（GPL互換であること）、標準的なreadme.txtファイルの存在などが含まれます。その後、SVNツールを使用してコードを指定されたリポジトリにコミットします。WordPressチームが審査を行い、承認されれば、プラグインは公式ディレクトリに掲載され、ユーザーがダウンロードしてインストールできるようになります。
次はどうする？
拡大読書と実践的知識
以下は、この記事のトピックに関連しており、さらに深く読むのに適している。あなたの現在の問題に最も近い記事から優先順位をつけ、徐々に周辺のトピックに広げていく方が良い場合が多い。
日本語