WordPressプラグイン開発の基礎
コードを深く掘り下げる前に、WordPressプラグインの基本概念と構造を理解することが非常に重要です。WordPressプラグインとは、本質的には追加のPHPスクリプトであり、WordPressが提供するフック（Hook）システムを通じてコアと相互作用し、ウェブサイトの機能を拡張したり変更したりします。プラグインは単一のファイルであることも、複数のファイル、CSSスタイルシート、JavaScriptスクリプトを含む完全なディレクトリであることもあります。
プラグイン開発の最優先事項は、標準に準拠したメインファイルを作成することです。通常、このメインファイルはプラグインの名前で命名されます。例えば：my-custom-plugin.phpこのファイルのヘッダー部分には、標準的なプラグイン情報のコメントブロックを含める必要があります。このコメントは、WordPressにプラグインについて説明するためだけでなく、バックエンドのプラグイン管理ページにも表示されます。
/**
* Plugin Name: 我的自定义功能扩展
* Plugin URI: https://example.com/my-custom-plugin
* Description: 这是一个用于演示的WordPress插件，用于添加自定义功能。
* Version: 1.0.0
* Author: 开发者名称
* Author URI: https://example.com
* License: GPL v2 or later
* Text Domain: my-custom-plugin
*/コメント内のPlugin Nameこれは必須項目です。その他はすべてオプションですが、記入することをお勧めします。このファイルを作成したら、それを以下の場所に置いてください。/wp-content/plugins/ディレクトリ内の独立したフォルダ（例えば…）my-custom-pluginそのプラグインは、WordPressの管理画面（バックエンド）にある「プラグイン」ページで確認し、有効にすることができます。
推薦図書 初心者から実践まで：WordPressプラグイン開発の完全なガイドと高度なテクニック。
WordPressプラグインの核心的な動作メカニズムは、「フック」に基づいて構築されています。フックには2種類あります：アクションフックとコールバックフックです。(Action Hooks)フィルターハンガー(Filter Hooks)アクションフックを使用すると、特定のタイミング（例えばページのヘッダーが読み込まれるときや記事が投稿されたとき）にカスタムコードを実行することができます。add_action()この関数は、あなたの関数をアクションフックにマウントします。
フィルターフックは、処理の過程で生成されるデータを変更することを可能にします。例えば、記事の内容は表示される前に一連のフィルターを通過します。add_filter()関数はこれらのデータを変更することができます。
国際化（Internationalization）とローカライゼーション（Localization）は、プロフェッショナルなプラグインにとって欠かせない要素です。これらを活用することで…__( ‘文本’, ‘text-domain’ )または_e( ‘文本’, ‘text-domain’ )この関数は、ユーザーに表示されるすべての文字列をラップし、テキストを読み込むためのドメインと組み合わせることで、プラグインが多言語をサポートできるようになります。Text Domainプラグインのヘッダ情報で定義された内容と一致していなければなりません。通常、これはプラグインのディレクトリ名やメインファイル名のスラグ（slug）バージョンを指します。
最初の機能プラグインを作成しましょう。
まずは、シンプルなプラグインの作成から始めましょう。このプラグインは、ウェブサイトの記事一覧にカスタムの管理バーを追加し、記事の文字数を表示する機能を持ちます。この例では、プラグインの作成方法、フックの使用方法、そして安全な出力処理の基本手順について説明します。
まず、あなたの…/wp-content/plugins/カタログの下に新しいフォルダを作成し、名前を付けます。my-first-extensionそのフォルダ内に、メインファイルを作成してください。my-first-extension.phpそして、前のセクションで説明したプラグインヘッダー情報も追加してください。
推薦図書 WordPressプラグイン開発入門ガイド：ゼロからカスタマイズされた機能モジュールを作成する方法。
次に、記事管理リストに新しい列を追加する必要があります。これには2つのアクションフックが関与します：manage_posts_columnsとmanage_posts_custom_column前者は新しい列の見出しを定義するために使用され、後者はその列の各行の内容を埋めるために使用されます。
// 为文章列表添加“字数统计”列
function mfe_add_word_count_column( $columns ) {
$columns['word_count'] = __( '字数统计', 'my-first-extension' );
return $columns;
}
add_filter( 'manage_posts_columns', 'mfe_add_word_count_column' );
// 填充“字数统计”列的内容
function mfe_display_word_count_column( $column, $post_id ) {
if ( $column === 'word_count' ) {
$post_content = get_post_field( 'post_content', $post_id );
$word_count = str_word_count( strip_tags( $post_content ) );
echo esc_html( $word_count );
}
}
add_action( 'manage_posts_custom_column', 'mfe_display_word_count_column', 10, 2 );このコードの中で、mfe_add_word_count_columnこの関数は、既存の列の配列を受け取り、新しい列を追加します。word_countキーを使用して配列を修正し、修正後の配列を返します。add_filterそれを接続してください。manage_posts_columnsフィルターの上にあります。mfe_display_word_count_columnこの関数はまず、現在処理している列が私たちが追加した「word_count」であるかを確認し、その後記事の内容を取得して使用します。strip_tags()HTMLタグを削除した後で使用してください。str_word_count()単語数（中国語では文字数）を計算し、その後に…esc_html()セキュリティエスケープ処理を行った後に出力します。
このシンプルなプラグインには基本的な機能がすでに備わっていますが、よりプロフェッショナルなプラグインであれば、プラグインがアクティブになったり非アクティブになったりした際に何らかの処理を実行することも考慮すべきです。例えば、カスタムのデータベーステーブルを作成したり、一時的に保存されたデータを削除したりすることができます。これは、アクティブ化や非アクティブ化のためのフック（hook）を登録することで実現できます。
// 插件激活时执行的操作
function mfe_plugin_activation() {
// 例如：添加一个版本号选项，用于后续升级判断
if ( ! get_option( 'mfe_plugin_version' ) ) {
add_option( 'mfe_plugin_version', '1.0.0' );
}
// 触发一个自定义动作，供其他开发者扩展
do_action( 'mfe_plugin_activated' );
}
register_activation_hook( __FILE__, 'mfe_plugin_activation' );
// 插件停用时执行的操作
function mfe_plugin_deactivation() {
// 例如：清除计划任务或临时数据
// 注意：通常不在停用时删除用户数据（如表）
}
register_deactivation_hook( __FILE__, 'mfe_plugin_deactivation' );ご注意ください。register_activation_hookとregister_deactivation_hookメインファイルの完全なパスが必要です。FILE定数を最初のパラメータとして使用します。アクティブ化、非アクティブ化、およびアンインストール（プラグインがユーザーによって削除された場合に発生）のロジックは、それぞれ別々に処理する必要があります。
プラグイン設定ページの実装
機能が充実したプラグインでは、通常、ユーザーに設定オプションを提供する必要があります。最も標準的な方法は、WordPressの管理画面（バックエンド）内に設定ページを作成することです。これは、以下のような方法で実現できます：add_menu_page()またはadd_options_page()などの関数を使用して実現します。
まず、トップレベルのメニューアイテムを作成しましょう。以下の例では…mfe_create_admin_menu関数の使用方法add_menu_page()新しいページを追加するための関数です。この関数には、ページのタイトル、メニューのタイトル、必要な権限、メニューのスラグ（slug）、ページ内容を出力するためのコールバック関数、アイコンのURL、そしてメニュー内での表示位置が必要です。
推薦図書 ゼロから始める：WordPressプラグイン開発の完全ガイドとベストプラクティスの共有。
// 创建后台管理菜单
function mfe_create_admin_menu() {
add_menu_page(
__( '我的扩展设置', 'my-first-extension' ), // 页面标题
__( '我的扩展', 'my-first-extension' ), // 菜单标题
'manage_options', // 权限（管理员）
'mfe-settings', // 菜单slug
'mfe_settings_page_html', // 显示页面内容的函数
'dashicons-admin-generic', // 图标
80 // 位置
);
}
add_action( 'admin_menu', 'mfe_create_admin_menu' );次に、定義する必要があります。mfe_settings_page_htmlこの関数を使用してページのコンテンツをレンダリングします。プロフェッショナルな設定ページでは、WordPressの標準的な設定APIを使用するべきです。このAPIは、フォームの送信処理、フィールドの検証、セキュリティ上の問題などの面倒な作業を担当してくれます。まず、以下の手順を実行する必要があります：register_setting()設定グループとフィールドを登録します。
// 初始化设置
function mfe_settings_init() {
// 注册一个新的设置组 “mfe_settings_group” 到页面 “mfe-settings”
register_setting( 'mfe-settings', 'mfe_settings_options' );
// 在设置组内添加一个区域（Section）
add_settings_section(
'mfe_settings_section',
__( '基本设置', 'my-first-extension' ),
'mfe_settings_section_cb',
'mfe-settings'
);
// 在区域内添加一个字段
add_settings_field(
'mfe_field_api_key',
__( 'API密钥', 'my-first-extension' ),
'mfe_field_api_key_cb',
'mfe-settings',
'mfe_settings_section',
[ 'label_for' => 'mfe_field_api_key' ]
);
}
add_action( 'admin_init', 'mfe_settings_init' );その後、HTMLを出力するために「エリアコールバック（region callback）」および「フィールドコールバック（field callback）」関数を定義する必要があります。特に「フィールドコールバック」関数は重要で、フォームの入力ボックスをレンダリングし、その値が保存された設定と一致するようにする役割を果たします。
// 设置区域的说明文本
function mfe_settings_section_cb( $args ) {
?>
<p id="<?php echo esc_attr( $args['id'] ); ?>"><?php esc_html_e( '请在此配置插件的基本参数。', 'my-first-extension' ); ?></p>
<?php
}
// API密钥字段的回调函数
function mfe_field_api_key_cb( $args ) {
// 从已注册的设置选项中获取值
$options = get_option( 'mfe_settings_options' );
$value = $options[ $args['label_for'] ] ?? '';
?>
<input type="text"
id="<?php echo esc_attr( $args['label_for'] ); ?>"
name="mfe_settings_options[<?php echo esc_attr( $args['label_for'] ); ?>]"
value="<?php echo esc_attr( $value ); ?>"
class="regular-text">
<p class="description"><?php esc_html_e( '请输入您的服务API密钥。', 'my-first-extension' ); ?></p>
あなたのアカウントは有効です。あなたはログインしています。最後に、メイン設定ページを作成する関数を作成します。そのためには、以下の手順を踏みます：settings_fields()とdo_settings_sections()安全にフォーム全体を出力します。
// 设置页面的HTML结构
function mfe_settings_page_html() {
// 检查用户权限
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
?>
<div class="wrap">
<h1></h1>
<form action="/ja/options.php/" method="post" data-trp-original-action="options.php">
<?php
// 输出安全字段、区域和字段
settings_fields( 'mfe-settings' );
do_settings_sections( 'mfe-settings' );
submit_button( __( '保存设置', 'my-first-extension' ) );
?>
<input type="hidden" name="trp-form-language" value="ja"/></form>
</div>
あなたのアカウントは有効です。あなたはログインしています。この方法で設定ページを作成すると、すべてのフォームデータの検証、クリーニング、保存がWordPressの設定APIによって自動的に処理され、データは保存されます。wp_options表内の名称は「%s」です。mfe_settings_optionsそのオプションにより、安全性と利便性が大幅に向上しました。
プラグインのセキュリティとベストプラクティス
プロフェッショナルで安全かつメンテナンスが容易なプラグインを開発するには、一連のベストプラクティスに従う必要があります。最も重要な原則は、「ユーザーの入力を絶対に信じてはならない」ということです。外部からのすべてのデータや情報についても同様です。$_GET、$_POST、$_COOKIEデータベースを含むすべてのデータは、出力、使用、または保存する前に、適切な検証、クリーニング、およびエスケープ処理を行う必要があります。
データの検証とクリーニング：データを論理的な判断に使用する前に、そのデータが期待される形式に合致しているかを確認する必要があります。例えば、あるフィールドが数字であることが期待されている場合は、適切な処理を行う必要があります。intval()またはis_numeric()WordPressには多くの補助関数が用意されています。sanitize_text_field()テキスト文字列をクリーンアップするために使用されます。sanitize_email()電子メールアドレスをクリーンアップするために使用されます。
データのエスケープ：HTML、JavaScript、またはURLにデータを出力する際には、クロスサイトスクリプティング（XSS）攻撃を防ぐために必ずエスケープ処理を行う必要があります。esc_html()输出纯文本到HTML中，esc_attr()HTML属性に出力する。esc_url()出力URL：wp_json_encode()組み合わせwp_slash()JavaScriptに出力します。
よくあるセキュリティ上の間違いの一つは、検証されていない変数をそのままデータベースクエリに使用することで、これによりSQLインジェクションが発生します。絶対にSQL文を手動で組み立ててはいけません。WordPressが提供する機能を使用するべきです。$wpdbクラスとそのクエリを準備するためのメソッド。
global $wpdb;
$user_input = $_POST['search_term'];
// 错误做法：直接拼接
// $sql = “SELECT * FROM {$wpdb->posts} WHERE post_title LIKE ‘%$user_input%’”;
// 正确做法：使用prepare方法
$sql = $wpdb->prepare(
“SELECT * FROM {$wpdb->posts} WHERE post_title LIKE %s”,
‘%’ . $wpdb->esc_like( $user_input ) . ‘%’
);
$results = $wpdb->get_results( $sql );権限チェック：プラグインが実行するすべての管理操作、データの変更、または機密情報の表示に先立ち、現在のユーザーがその操作を実行する権限を持っているかどうかを必ず確認しなければなりません。current_user_can( $capability )またはcheck_admin_referer()などを確認します。
スクリプトとスタイルシートの読み込みは順番に行うべきです。プラグイン内で直接これらを読み込むことは絶対に避けてください。<link>または<script>タグを使用してCSSおよびJSファイルを読み込むには、以下の方法を使用します：wp_enqueue_style()とwp_enqueue_script()関数を実装し、適切なフック（例えば）で正しく呼び出されるようにしてください。wp_enqueue_scriptsフロントエンド用です。admin_enqueue_scriptsバックエンドで実行されます。これにより、競合を避け、依存関係が正しく読み込まれることが保証されます。
コードの組織化と命名規約：プラグインの関数、クラス、変数、オプションの名前には、一意な接頭辞を使用してください（例：mfe_これにより、テーマ、他のプラグイン、またはWordPressのコアとの衝突を防ぐことができます。複雑なプラグインを複数のファイルに分けて構成し、オブジェクト指向プログラミング（OOP）を使用することで、コードの可読性と再利用性を向上させることができます。
アンインストール時のクリーニング機能の提供：プラグインがデータベーステーブルやカスタムオプションを作成した場合、ユーザーがプラグインを「無効化」するのではなく「削除」した際にクリーニング処理を行うことを検討すべきです。これは、別途用意されたアンインストールファイルを通じて実現できます。プラグインのメインファイル内で、以下のように処理を行うことができます：register_uninstall_hook( FILE, ‘mfe_plugin_uninstall’ )アンインストール関連の関数を登録する方法もありますが、より一般的な方法はプラグインディレクトリ内にファイルを作成することです。uninstall.phpこのファイルについては、WordPressがプラグインを削除する際に自動的に実行されます。
概要
WordPressプラグインの開発は、構造化された思考とWordPressのコアアーキテクチャに対する深い理解を組み合わせたプロセスです。標準に準拠したプラグインヘッダ情報の作成から、アクションフックやフィルターフックの理解と習熟した利用に至るまで、これらはあらゆる機能拡張を構築するための基盤となります。実用的なプラグインを作成するには、フロントエンドの機能を実装するだけでなく、WordPressの設定APIを通じて効率的に実現できる、明確で安全なバックエンドの設定インターフェースも構築する必要があります。
セキュリティは常に最優先事項です。入力データの検証、出力データのエスケープ処理、権限のチェック、そして安全なデータベース操作に至るまで、どのステップも見落としてはなりません。スクリプトの読み込みを適切に並行処理する、一意なプレフィックスを使用する、コード構造を明確に整理するといったベストプラクティスに従うことで、プラグインの信頼性とメンテナビリティが向上し、WordPressの広大なエコシステムと調和して動作するようになります。このガイドの手順を通じて、ゼロからプロフェッショナルレベルのWordPressプラグインを構築するために必要な核心的な知識とスキルを習得しました。
FAQ よくある質問
私のプラグインにショートコードを追加するにはどうすればいいですか？
ショートコードを使用すると、ユーザーは記事やページにプラグインの機能を簡単に挿入することができます。add_shortcode()この関数を使って、あなたのショートコードを登録してください。
ショートコードの処理ロジックを実行するコールバック関数を作成してください。この関数は、属性を受け取ります。$atts）および内容（$content）参数，并返回处理后的HTML。记住，短码回调函数必须返回（return）内容，而不是直接输出（echo）。返回的内容也需要进行适当的转义以确保安全。
プラグインの設定オプションは、どこに保存すべきでしょうか？
シンプルなキー値ペアの設定については、WordPressのOptions APIの使用を強くお勧めします。add_option()、get_option()とupdate_option()これらのデータは自動的に保存されます。wp_optionsデータベースのテーブルの中にあります。
もしプラグインで大量の構造化データ（例えばフォームの入力内容やログデータなど）を保存する必要がある場合は、カスタムのデータベーステーブルを作成することを検討すべきです。dbDelta()関数を使用して、テーブル構造の作成と更新が安全かつ互換性のあるものになるようにします。カスタムテーブルの作成は、通常、プラグインのアクティベーションフック内で処理されます。
私のプラグインは、他のプラグインやテーマとどのように互換性を持たせることができるのでしょうか？
互換性を向上させるための鍵は、WordPressのコーディング基準に従い、一意の接頭辞を使用し、フック（Hooks）を通じて拡張ポイントを提供することです。コアファイルやグローバル変数を直接変更することは避けてください。
あなたのプラグインの中で、使用してください。do_action()またはapply_filters()カスタムフックを作成することで、他の開発者があなたのプラグインの動作を変更したり拡張したりできるようになります。また、スタイルやスクリプトの追加など、競合が生じる可能性のある操作を実行する前には、条件チェックを行ったり、オプションを提供したりしてください。
如何为插件添加更新机制？
WordPressの公式プラグインディレクトリにホストされているプラグインについては、アップデートは自動的に処理されます。しかし、プライベートまたは商用のプラグインの場合は、カスタムのアップデートチェッカーを実装する必要があります。
これは通常、クラスを作成し、定期的にリモートサーバーで新しいバージョンがないかをチェックし、ユーザーがワンクリックでアップデートできるようにするという処理を意味します。「Plugin Update Checker」のようなライブラリを参考にすることもできますし、自分で実装することもできます。その核心となるのは、新しいバージョンがあるかどうかを確認し、ユーザーにアップデートを促す機能を実装することです。set_site_transient()フック（例えば）pre_set_site_transient_update_plugins）を使用して更新情報を注入してください。更新サーバーが安全で信頼できるものであることを必ず確認してください。
次はどうする？
拡大読書と実践的知識
以下は、この記事のトピックに関連しており、さらに深く読むのに適している。あなたの現在の問題に最も近い記事から優先順位をつけ、徐々に周辺のトピックに広げていく方が良い場合が多い。
日本語