WordPressプラグインを開発するには、まずWordPressのインストールディレクトリ内で作業を行う必要があります。 wp-content/plugins フォルダ内に専用のフォルダを作成してください。このフォルダの名前は、あなたのプラグインの主要な機能や名称に関連しているものにし、できれば小文字とハイフン(-)を使用するとよいでしょう。例えば: my-first-plugin。
次に、このフォルダ内にメインプラグインファイルを作成する必要があります。このファイルは通常、プラグインの名前で命名されます。例えば: my-first-plugin.phpこのファイルはプラグインの入口部分であり、その上部にはWordPressの標準に準拠したプラグインヘッダーのコメントが含まれていなければなりません。このコメントブロックは、WordPressシステムにプラグインの基本情報を提供するためのもので、プラグインが認識され、有効になるための鍵となります。
典型的プラグインヘッダーのコメントは以下のようになっています:
推薦図書 ゼロからWordPressプラグイン開発をマスターする:完全ガイドと実践演習。
<?php
/**
* Plugin Name: 我的第一个插件
* Plugin URI: https://example.com/my-first-plugin
* Description: 这是一个用于演示的简单 WordPress 插件。
* Version: 1.0.0
* Author: 你的名字
* Author URI: https://example.com
* License: GPL v2 or later
* Text Domain: my-first-plugin
* Domain Path: /languages
*/ このファイルを作成して内容を記入すると、WordPressの管理画面にある「プラグイン」ページで自分のプラグインを確認できるようになり、そこから有効化することができます。これにより、あなたのプラグイン開発の旅が正式にスタートしたということになります。
プラグインの基本構造を理解する
構造がしっかりしているWordPressプラグインは、自分でのメンテナンスが容易であるだけでなく、他の開発者にとっても理解しやすいです。標準的な組織方法に従うことで、コードをより明確でプロフェッショナルなものにすることができます。
コアファイルとディレクトリの構成方法
メインのプラグインファイルに加えて、機能が完全なプラグインには通常、複数のディレクトリやファイルが含まれています。例えば、includes/ ディレクトリは、コアとなるPHPクラスや関数のファイルを格納するために使用されます。admin/ ディレクトリには、バックエンド管理インターフェースに関連するコードが保存されています。public/ または frontend/ ディレクトリには、ウェブサイトの訪問者向けのコードが保存されています。assets/ ディレクトリは、JavaScript、CSS、画像などの静的リソースを保存するために使用されます。
さらに、以下のようなものも必要になるかもしれません: languages/ ディレクトリには国際化翻訳ファイル(.po/.mo)が保存されており、さらに… uninstall.php このファイルは、プラグインが削除された際のクリーンアップ処理を行うためのものです。適切なディレクトリ構造は、メンテナンスが容易で拡張性のあるプラグインを構築するための基盤となります。
プラグインのライフサイクルと標準的なフック
WordPressのプラグインは、一連の「フック(Hook)」を通じてコアシステムとやり取りを行います。プラグインのライフサイクルを理解するためには、これらのフックがどのような順序で実行されるかを把握することが鍵となります。WordPressがリクエストを処理する際には、まずコアファイルが読み込まれ、次にテーマが読み込まれ、そして有効になっているプラグインが順番に実行されます。
推薦図書 WordPressプラグイン開発完全ガイド:入門から実践までの詳細解説。
プラグイン開発者はこれを活用することができます。 register_activation_hook プラグインが有効になったときに一度だけ実行されるタスクを設定できます。例えば、データベースのテーブルを作成するといった処理です。同様に…register_deactivation_hook プラグインが無効になった際の処理に使用されます(注意:これはプラグインの削除ではありません)。 register_uninstall_hook または、独立したものとして。 uninstall.php このファイルは、プラグインがWordPressから削除された際にデータをクリアするために使用されます。
日常運用において、最もよく使用されるフックのタイプは「アクション(Action)」と「フィルター(Filter)」の2つです。アクションを使用すると、特定のタイミング(例えば…)に何かを実行することができます。 initコードを挿入することで機能を実行できます。一方、フィルターを使用すると、他の関数に渡されるデータを変更することができます(例: the_content)。
コア機能の実装とセキュリティ対策の統合
プラグインを開発する主な目的は、WordPressに新しい機能を追加することです。ショートコードを追加すること、小さなツールを作成すること、フォームデータを処理することなど、どのような場合でも、WordPressのセキュリティ基準やインタラクション規格に従う必要があります。
コンテンツを出力するためのショートコードを作成します。
ショートコード(Shortcode)とは、ユーザーが記事やページ内で簡単なタグを使って動的なコンテンツを挿入できるようにする強力なツールです。これを活用することで、 add_shortcode 自分専用のショートコードを登録するための関数です。
たとえば、以下のコードは「example_user」という名前のユーザーを登録しています。 greet これは短縮コードであり、1つの引数を受け取ります。 name 属性を設定し、ユーザーに挨拶をします:
function myplugin_greet_shortcode( $atts ) {
// 使用 shortcode_atts 函数设置默认值并合并用户属性,确保安全性
$atts = shortcode_atts( array(
'name' => '访客',
), $atts, 'greet' );
// 在输出前对用户输入进行转义
$name = esc_html( $atts['name'] );
return '<p>こんにちは、' . $name . 'さん!このウェブサイトにようこそ。</p>'php
add_shortcode('greet', 'myplugin_greet_shortcode'); ユーザーは記事編集器内でテキストを入力することができます。 [greet name=“小明”]その場合、フロントエンドには「こんにちは、小明!このウェブサイトにようこそ。」と表示されます。覚えておいてくださいが、ユーザーから取得したすべてのデータは出力する前に、適切にエスケープ処理を行うか検証を行う必要があります。上記の例で使用されているのがその方法です。 esc_html。
推薦図書 WordPressプラグイン開発入門ガイド:ゼロから最初のカスタムプラグインを作成する方法。
为插件添加设置页面
ユーザーによる設定が必要なプラグインについては、バックエンドで設定オプションページを作成するのが標準的な方法です。WordPressの「設定API」を利用することで、ページやフィールドを安全かつ簡単に追加できます。このAPIはセキュリティ検証(nonce)やデータの保存処理も自動で行ってくれます。
まず、を使用して add_options_page または add_menu_page などの関数を管理バックエンドにメニューアイテムおよびページとして追加します。その後、それらを使用して… register_setting、add_settings_section と add_settings_field `set`や`get`などの関数を使用して、設定オプションを定義してください。
以下は、シンプルな設定ページを作成するためのフレームワークコードです:
function myplugin_add_admin_menu() {
add_options_page(
'我的插件设置', // 页面标题
'我的插件', // 菜单标题
'manage_options', // 所需权限
'myplugin-settings', // 菜单 Slug
'myplugin_settings_page' // 用于渲染页面的回调函数
);
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );
function myplugin_settings_init() {
register_setting( 'myplugin_settings_page', 'myplugin_settings' );
add_settings_section( 'myplugin_section', '基础设置', null, 'myplugin_settings_page' );
add_settings_field(
'api_key',
'API 密钥',
'myplugin_api_key_field_render', // 渲染输入字段的函数
'myplugin_settings_page',
'myplugin_section'
);
}
add_action( 'admin_init', 'myplugin_settings_init' );
function myplugin_api_key_field_render() {
$options = get_option( 'myplugin_settings' );
$value = isset( $options['api_key'] ) ? esc_attr( $options['api_key'] ) : '';
echo '<input type="text" name="myplugin_settings[api_key]" value="' . $value . '" />';
}
function myplugin_settings_page() {
?>
<form action='/ja/options.php/' method='post' data-trp-original-action="options.php">
<h2>私のプラグイン設定</h2>
<?php
settings_fields( 'myplugin_settings_page' );
do_settings_sections( 'myplugin_settings_page' );
submit_button();
?>
<input type="hidden" name="trp-form-language" value="ja"/></form>
あなたのアカウントは有効です。あなたはログインしています。 設定APIを使用することで、プラグインのオプションが安全に保存されることを確実にできます。 wp_options 表の中にあり、管理インターフェースはWordPressのスタイルに合っています。
開発のベストプラクティスに従う
長期にわたって安定して動作し、メンテナンスが容易で、他のプラグインとも調和して共存できるプラグインを作成するには、いくつかの重要なベストプラクティスに従う必要があります。
コードのセキュリティを確保する。
セキュリティはプラグイン開発において最も重要な要素です。URL、フォーム、Cookie、データベースからのすべてのユーザー入力データについて、検証、クリーニング、エスケープ処理を行う必要があります。WordPressが提供する一連の関数を利用することで、これらの処理を簡単に実現できます。 esc_html、esc_url、sanitize_text_field 出力を処理するために使用してください。 wp_verify_nonce と check_admin_referer リクエストの正当性を検証し、クロスサイトリクエストフォージェリ(CSRF)攻撃を防止します。
データベースのクエリを実行する際には、必ず以下のことを守ってください: $wpdb クラスが提供するメソッド(例えば) prepareSQLインジェクション攻撃を防ぐためには、ユーザーからの入力をSQL文に直接組み込んでは絶対にいけません。
国際化(Internationalization)とローカライゼーション(Localization)の実現
あなたのプラグインを世界中のWordPressユーザーが利用できるようにするためには、国際化(i18n)が不可欠です。つまり、ユーザーに表示されるすべてのテキストをWordPressの翻訳機能を使って処理する必要があるのです。
あなたのプラグインのヘッダーコメントでそれを定義しておいてください。 Text Domain(例えば) my-first-pluginそして Domain Pathコード内では、翻訳が必要なすべての文字列に対して同じ処理を適用してください。 __() 「进行翻译,使用」 _e() 进行翻译并直接输出,使用 _n() 単数形と複数形の処理を行います。
例えば:$text = __(‘Hello World’, ‘my-first-plugin’);その後、Poeditなどのツールを使用して生成することができます。 .pot テンプレートファイル:翻訳者が使用するためのものです。 .po と .mo ファイルです。翻訳したファイルをプラグインのルートディレクトリに置いてください。 /languages フォルダを設定すると、WordPressはウェブサイトの言語に応じて自動的に対応する翻訳データを読み込みます。
コードの最適化とパフォーマンスの検討を行う
パフォーマンスが悪いプラグインは、ウェブサイト全体の動作を遅くしてしまいます。ページが読み込まれるたびに不要なコードを大量に実行することは避けるべきです。バックグラウンドでのみ使用されるスクリプトやスタイルは、条件分岐(例えば)を利用して読み込むようにしましょう。 is_admin())バックエンドでのみ読み込みます。フロントエンドのリソースは別途処理されます。 wp_enqueue_script() と wp_enqueue_style() 適切なフック(例えば…)の中で… wp_enqueue_scripts)の中で順番に読み込まれます。
時間のかかる処理や外部APIの呼び出しについては、WordPressのTransients APIを利用することを検討してください。set_transient, get_transientキャッシュを行います。また、プラグインを無効にしたり削除したりする際にも、正常に処理が行われるようにする必要があります。 uninstall.php 自分で作成したデータベースのテーブルやオプションを削除する際には慎重に行い、ユーザーにデータを削除するかどうかの選択肢を提供する必要があります。
デバッグ、テスト、リリース
プラグインをユーザーに提供する前に、徹底的なデバッグ、テスト、および準備作業を行うことは、成功を確実にするための鍵となるステップです。
ワードプレスのデバッグツールを利用する。
開発段階では、WordPressのデバッグモードを有効にすることを強くお勧めします。 wp-config.php ファイル内に設定を行います。 define(‘WP_DEBUG’, true);これにより、すべてのPHPエラー、警告、および通知が表示されるため、問題を迅速に特定するのに役立ちます。また、これらを同時に有効にすることもできます。 WP_DEBUG_LOG エラーをログファイルに記録するか、またはその機能を有効にします。 SCRIPT_DEBUG 未圧縮のJavaScriptファイルとCSSファイルを読み込むことで、デバッグが容易になります。
プラグインのリリース情報を準備します。
もしプラグインを公式のWordPress.orgプラグインディレクトリに提出する予定であれば、一連の資料を準備する必要があります。これには、詳細な… readme.txt ファイルの形式はWordPressの要件に準拠していなければならず、説明文、インストール手順、よくある質問、アップデート履歴などを含む必要があります。また、高品質なバナーやアイコン画像も提供する必要があります。さらに、プラグインのSVNリポジトリに関する説明も記入してください。
コードレベルでは、国際化の準備が完了していることを確認し、すべてのコードがWordPressのコーディングスタンダードに準拠しているかを入念にチェックしてください。PHP_CodeSnifferを使用し、WordPressのコーディングスタンダードのルールに従ってチェックを行うことができます。
クロス環境互換性テストを実施する
公開する前に、プラグインをさまざまな環境でテストする必要があります。これには、異なるバージョンのWordPress(特に現在のバージョンと前のメジャーバージョン)、異なるPHPバージョン(例:PHP 7.4、8.0、8.1)、異なるデータベースバージョン(MySQL/MariaDB)、そして人気のあるテーマや他のプラグインとの互換性テストが含まれます。プラグインが有効化されたとき、無効化されたとき、設定されたとき、使用されているときの各段階で、エラーや警告が発生しないようにしてください。
概要
WordPressプラグインの開発とは、アイデアを実際の機能に変え、巨大なエコシステムに統合していくプロセスです。まずは標準に準拠したメインファイルを作成し、明確なファイル構造を構築していきます。そして、アクションとフィルターハックという核心的なインタラクションメカニズムを深く理解する必要があります。ショートコードや設定ページなどの具体的な機能を実装する際には、セキュリティ(検証、エスケープ処理、注入防御)と国際化をコーディングの習慣として徹底する必要があります。パフォーマンスの最適化やリソースの適切な管理といったベストプラクティスに従い、デバッグツールを活用してコードの品質を確保しましょう。最終的には、包括的なクロス環境テストと完璧なリリース準備を経て、あなたのプラグインが世界中のWordPressユーザーに安定して安全にサービスを提供できるようになります。公式マニュアルやコミュニティリソースを継続的に学ぶことが、プラグイン開発のスキルを向上させる鍵となります。
FAQ よくある質問
WordPressプラグインを開発するには、どのような基礎知識が必要ですか?
プラグインのコアロジックは主にPHPで書かれているため、しっかりとしたPHPプログラミングの基礎が必要です。また、ユーザーインターフェースやインタラクションを構築するために、HTML、CSS、JavaScriptについても基本的な知識が必要です。最も重要なのは、WordPressの基本構造に精通していることです。これには、フックシステム(アクションとフィルター)、テーマループ、データベース構造、さまざまなコア関数やクラスの使い方などが含まれます。
私のプラグインが他のプラグインと衝突するのをどのように避ければよいでしょうか?
すべての関数、クラス、定数、アクション/フィルターラベル、およびオプション名に一意の接頭辞を付けることが、衝突を防ぐ最も効果的な方法です。一般的な名前(例:「myFunction」など)は使用しないでください。 add_user() または $count逆に、あなたのプラグインに関連する接頭辞を使用すべきです。例えば: myplugin_add_user() または $myplugin_countコードをクラスや名前空間に封じ込めることも良い習慣です。さらに、キュー処理スクリプトやスタイルシートを管理する際には一意なハンドルを使用し、必要に応じてリソースをロードすることを検討してください。
プラグインのデータはどこに保存すればいいのでしょうか?
シンプルな設定オプションについては、WordPressのOptions APIを使用します。add_option, get_option, update_optionデータを保存するには wp_options 表は最もシンプルで標準的な方法です。大量の構造化されたカスタムデータ(例えば製品や注文など)を保存する必要がある場合は、カスタムのデータベーステーブルを作成するべきです。 $wpdb オブジェクトは、プラグインがアクティブになったときに作成されます。 dbDelta() 関数を使用してテーブル構造を作成および更新することで、異なるデータベースバージョン間の互換性を確保できます。
プラグインが削除された後、そのプラグインによって作成されたデータをどのように削除するか?
WordPressでは主に2つの方法が提供されています。1つ目は、そのままWordPressを使用する方法です。 register_uninstall_hook() 関数はアンインストール用のフックを登録します。もう一つの、より推奨される方法としては、プラグインのルートディレクトリ内に独立したファイルを作成することです。 uninstall.php ファイルです。このファイルの中で、WordPress 内部から何かが呼び出されているかを確認する必要があります。 WP_UNINSTALL_PLUGIN まず定数を設定し、その後でカスタムオプションの削除を実行します(使用する場合)。 delete_optionプラグインの設定やカスタムデータベーステーブルなどのクリーニング操作についても説明してください。また、削除操作によってどのデータが削除されるかをプラグインの説明文に必ず明記するようにしてください。
次はどうする?
拡大読書と実践的知識
以下は、この記事のトピックに関連しており、さらに深く読むのに適している。あなたの現在の問題に最も近い記事から優先順位をつけ、徐々に周辺のトピックに広げていく方が良い場合が多い。