ゼロから始める：WordPressプラグイン開発の核心ステップとベストプラクティスをマスターする
WordPressプラグインの開発は、WordPressウェブサイトの機能を拡張するための強力な方法です。カスタムプラグインを作成することで、開発者はコアコードを変更することなくウェブサイトに独自の機能を追加することができます。これにより、ウェブサイトの柔軟性が向上するだけでなく、WordPressのコアがアップデートされてもカスタム機能が安全かつ安定して動作することが保証されます。構造がしっかりしているWordPressプラグインは、特定のディレクトリ構造、コーディング規格、およびWordPress APIに従っています。
この記事では、最初のプラグインファイルの作成からプラグインの安全な公開に至るまでの全過程をご案内します。開発プロセスで理解しておくべき核心概念、ツール、およびベストプラクティスについても詳しく解説します。
推薦図書 WordPressプラグイン開発の完全ガイド：ゼロから始めて、高品質なWordPress拡張機能を構築する。
開発環境と基本構造
どんなコードを書く前にも、適切な開発環境を構築することが非常に重要です。Local by Flywheel、XAMPP、MAMPなどのローカル開発ツールの使用をお勧めします。これらのツールを使えば、PHP、MySQL、ウェブサーバーを含む環境を迅速に設定することができます。また、コードエディタ（VS Code、PhpStormなど）やデバッグツール（Query Monitor、Debug Barなど）も欠かせません。
最初のプラグインファイルを作成しましょう。
WordPressプラグインの最も基本的な形態とは、ウェブサイトのコード内に組み込まれるコードスニペット（スニペットとは、プログラムの一部を構成する短いコードのこと）です。このコードスニペットは、WordPressの機能を拡張したり、ウェブサイトの外観や動作をカスタマイズしたりするために使用されます。 /wp-content/plugins/ ディレクトリ内のPHPファイルです。プラグインのメインファイルのヘッダーには、標準的なプラグイン情報のコメントを含める必要があります。これはWordPressがプラグインを認識し、管理するための基本です。
「Create a file named…」 my-first-plugin.php そのファイルを開き、以下の内容を入力してください：
<?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
*/このファイルを「〜」に保存してください。 /wp-content/plugins/my-first-plugin/ フォルダ内にアップロードした後、WordPressの管理画面（バックエンド）にある「プラグイン」ページにログインすると、そのプラグインを確認し、有効にすることができます。現時点ではまだ何の機能もありませんが、構造自体は完成しています。
プラグインのディレクトリとファイルの構成
機能が増えるにつれて、単一のファイルのメンテナンスが困難になります。構造が整っているプラグインディレクトリには、通常、以下のような部分が含まれます：
* 主插件文件：plugin-name.php
* includes/ 目录：存放核心功能类或函数文件。
* admin/ 目次：バックエンド関連のコード、CSS、JavaScriptを格納しています。
* public/ 目次：フロントエンドに関連するコード、CSS、JavaScriptを格納しています。
* assets/ 目次：画像、スタイルシート、スクリプトファイルを保存するためのディレクトリです。
* languages/ 目次：国際化翻訳ファイル（.pot、.po、.mo）を保存するためのディレクトリです。
* uninstall.php ファイル：プラグインが削除された際にデータベースをクリーンアップするためのオプションです。
推薦図書 WordPressプラグイン開発完全ガイド：入門から実践までの詳細解説。
核心開発コンセプトと技術
WordPressのプラグイン開発の核心は、WordPressが提供するAPI（アプリケーションプログラミングインターフェース）を理解し、熟知して活用することにあります。主なAPIには、アクションフック（Action Hooks）、フィルターフック（Filter Hooks）、ショートコード（Shortcode）が含まれます。
アクションフックの使い方をマスターしましょう。
アクションフックを使用すると、WordPressが実行される特定のタイミングで自分のコードを「挿入」することができます。 add_action() 関数を使用すると、自作の関数をフックにマウントすることができます。
例えば、以下のコードはすべてのページのヘッダーにカスタムのmetaタグを1行追加します：
function myplugin_add_custom_meta() {
echo '<meta name="my-custom-meta" content="value">';
}
add_action( 'wp_head', 'myplugin_add_custom_meta' );もう一つのよく使われる例は、プラグインが有効になったときにいくつかの初期化処理を実行することです。例えば、データベースのテーブルを作成するといった処理です。これには、関数を適切な場所にマウントする必要があります。 register_activation_hook フックに。
フィルターを使用してコンテンツを変更する
フィルターフックは、WordPressがデータを処理する際にそのデータを変更するために使用されます。 add_filter() 関数を使用してテキスト内容やオプションの値などを変更することができます。フィルタ関数には必ず戻り値が必要です。
以下の例では、記事内容の末尾に自動的にカスタムテキストが追加されます。
推薦図書 WordPressプラグイン開発の完全ガイド：ゼロから始めて、あなたの最初の機能プラグインを作成する。
function myplugin_modify_post_content( $content ) {
if ( is_single() ) {
$custom_text = '<p><em>この記事をお読みいただき、ありがとうございます！</em></p>';
$content .= $custom_text;
}
return $content;
}
add_filter( 'the_content', 'myplugin_modify_post_content' );ショートコードの作成と管理
ショートコードを使用すると、ユーザーは記事、ページ、または小道具にプラグインで生成された動的なコンテンツを簡単に挿入することができます。 add_shortcode() 関数では、新しいショートコードを登録することができます。
「%s」という名前でアカウントを登録します。 [greeting] これは短いコードで、時間に応じて異なる挨拶文を表示することができます：
function myplugin_greeting_shortcode( $atts ) {
$hour = date( 'G' );
$greeting = ( $hour ? 'おはようございます！' : ( ($hour) < 18 ) ? '下午好！' : '晚上好！' );
return '<div class="greeting">'`. esc_html($greeting).`'</div>'短コードを追加するには：\n';
add_shortcode( 'greeting', 'myplugin_greeting_shortcode' );プラグインのセキュリティとデータ管理
安全なプラグインを開発することは、ウェブサイトとユーザーデータを保護するための第一歩です。これには、入力データの検証、出力データのエスケープ処理、権限のチェック、そしてデータを安全に処理することが含まれます。
データの検証とエスケープ処理を実現する
ユーザーからの入力を絶対に信じてはいけません。データをデータベースに保存したり、ブラウザに出力したりする前に、必ず検証とエスケープ処理を行う必要があります。
- 検証：使用
sanitize_text_field(),sanitize_email(),intval()などの関数がユーザー入力をクリアします。 - エスケープ処理：データをHTML、JavaScript、またはURLに出力する際には、適切なエスケープ関数を使用してください。
esc_html(),esc_js(),esc_url()。
例えば、フォームから送信されたユーザー名を安全に処理し、出力する方法は以下の通りです：
$user_input = $_POST['username'] ?? ''; // 使用空合并运算符提供默认值
$clean_username = sanitize_text_field( $user_input );
echo '你好，' . esc_html( $clean_username );WordPressのオプションAPIを使用する
保存ようなシンプルな設定（オン/オフの切り替えやテキストなど）には、WordPressのオプションAPIを使用するべきです。このAPIにより、設定情報を効率的に管理することができます。 add_option(), get_option(), update_option() と delete_option() などの関数を使用することで、データを安全に保存することができます。 wp_options 表の中に。
プラグインの設定を作成し、それを取得します：
// 保存一个选项
update_option( 'myplugin_setting_color', '#336699' );
// 获取一个选项，如果不存在则使用默认值
$color = get_option( 'myplugin_setting_color', '#000000' );カスタムデータベーステーブルの作成
プラグインで複雑な関係型データを保存する必要がある場合、カスタムのデータベーステーブルを作成する必要があります。これは通常、プラグインが有効になる際に実行され、WordPressのデータベースモデルの規則に従う必要があります。
はい。 my-first-plugin.php 中，为插件激活钩子添加创建表的函数：
function myplugin_create_custom_table() {
global $wpdb;
$table_name = $wpdb->prefix . 'myplugin_items'; // 使用 $wpdb->prefix 确保表前缀正确
$charset_collate = $wpdb->get_charset_collate();
$sql = "CREATE TABLE IF NOT EXISTS $table_name (
id mediumint(9) NOT NULL AUTO_INCREMENT,
name varchar(100) NOT NULL,
created_at datetime DEFAULT CURRENT_TIMESTAMP NOT NULL,
PRIMARY KEY (id)
) $charset_collate;";
require_once( ABSPATH . 'wp-admin/includes/upgrade.php' );
dbDelta( $sql );
}
register_activation_hook( __FILE__, 'myplugin_create_custom_table' );プラグインのバックエンド管理インターフェースを構築する
プラグイン用の直感的なバックエンド設定ページを作成することは、優れたユーザー体験を提供するための鍵となります。WordPress では、管理メニューや設定ページ、フォームの作成プロセスを簡素化するためのさまざまな API が用意されています。
管理メニューとサブメニューを追加する
利用する add_menu_page() と add_submenu_page() この関数を使用すると、WordPressの管理画面（バックエンド）のサイドバーにプラグイン用のメニューアイテムを追加することができます。
以下のコードに、トップメニュー「私のプラグイン」とサブメニュー「設定」を追加してください：
function myplugin_add_admin_menu() {
// 添加顶级菜单
add_menu_page(
'我的插件设置', // 页面标题
'我的插件', // 菜单标题
'manage_options', // 所需权限
'myplugin-dashboard', // 菜单 Slug
'myplugin_dashboard_page', // 回调函数，用于输出页面内容
'dashicons-admin-generic', // 图标
30 // 菜单位置
);
// 添加子菜单
add_submenu_page(
'myplugin-dashboard', // 父菜单 Slug
'插件设置', // 页面标题
'设置', // 菜单标题
'manage_options', // 权限
'myplugin-settings', // 子菜单 Slug
'myplugin_settings_page' // 回调函数
);
}
add_action( 'admin_menu', 'myplugin_add_admin_menu' );
// 定义“仪表盘”页面的回调函数
function myplugin_dashboard_page() {
echo '<div class="wrap"><h1>私のプラグインダッシュボード</h1></div>';
}
// 定义“设置”页面的回调函数
function myplugin_settings_page() {
echo '<div class="wrap"><h1>私のプラグイン設定</h1></div>';
}統合設定APIを使用してフォームを構築する
WordPressの設定APIは、フォーム設定を作成、検証、保存するための安全で標準化された方法を提供します。これには、設定の登録、設定エリアやフィールドの追加が含まれます。
以下は、テキストフィールドを含む設定ページを作成するための簡単な例です：
function myplugin_settings_init() {
// 注册一个新的设置项 “myplugin_settings”
register_setting( 'myplugin_settings_group', 'myplugin_settings' );
// 添加一个新的设置区域
add_settings_section(
'myplugin_section_basic',
'基础设置',
null, // 区域描述的回调函数，这里不需要
'myplugin-settings' // 页面 Slug
);
// 在区域内添加一个字段
add_settings_field(
'myplugin_field_api_key',
'API 密钥',
'myplugin_field_api_key_callback', // 渲染字段 HTML 的回调函数
'myplugin-settings',
'myplugin_section_basic'
);
}
add_action( 'admin_init', 'myplugin_settings_init' );
// 字段的回调函数
function myplugin_field_api_key_callback() {
$options = get_option( 'myplugin_settings' );
$value = $options['api_key'] ?? '';
echo '<input type="text" name="myplugin_settings[api_key]" value="' . esc_attr( $value ) . '" class="regular-text">';
}
// 修改之前的设置页面回调函数，以输出表单
function myplugin_settings_page() {
?>
<div class="wrap">
<h1>私のプラグイン設定</h1>
<form action="/ja/options.php/" method="post" data-trp-original-action="options.php">
<?php
settings_fields( 'myplugin_settings_group' ); // 输出必要的安全字段
do_settings_sections( 'myplugin-settings' ); // 输出所有设置区域和字段
submit_button(); // 输出提交按钮
?>
<input type="hidden" name="trp-form-language" value="ja"/></form>
</div>
あなたのアカウントは有効です。あなたはログインしています。概要
WordPressプラグインの開発とは、基本構造を理解することから始め、徐々にコアAPIやセキュリティについて深く学び、最終的に完全なユーザーインターフェースを構築するプロセスです。重要なのは、WordPressのコーディングスタンダードやベストプラクティスに従うことです。例えば、フックの正しい使用、データセキュリティの厳格な処理、組み込まれたオプションAPIや設定APIの活用などです。まずはシンプルなプラグインのヘッダーコメントファイルを作成し、徐々にアクション、フィルター、ショートコードを追加し、データベースやバックエンドインターフェースの管理までを行います。これらの各ステップはすべて、WordPressの強力で安定したフレームワークの上に構築されています。これらのステップを体系的に学び、実践することで、機能豊富で安全かつ信頼性の高いWordPressプラグインを開発することができ、世界中の広大なWordPressエコシステムに貢献することができるでしょう。
FAQ よくある質問
WordPressプラグインを開発するには、どのような基礎知識が必要ですか？
WordPressプラグインを開発するには、PHPプログラミング言語の習得が必要です。なぜなら、プラグインのコアコードはPHPで書かれているからです。また、HTML、CSS、JavaScriptについても基本的な知識が必要であり、これらはフロントエンドのインターフェースやユーザーインタラクションの構築に使用されます。最も重要なのは、WordPressのコアコンセプトに精通していることです。例えば、アクション（Actions）やフィルター（Filters）、The Loop（ループ処理）、テンプレートの階層構造、そしてWordPressのデータベース構造などです。
WordPressのプラグインをどのようにデバッグするか？
まず、 wp-config.php ファイル内でWordPressのデバッグモードを有効にします。 WP_DEBUG 定数は次のように設定されています。 trueこれにより、PHPのエラーや警告が画面上に表示されます。次に、以下の方法を使用することができます： error_log() この関数は、デバッグ情報をサーバーのエラーログに書き込みます。さらに、Query Monitorのような専門的なデバッグプラグインをインストールすることで、データベースクエリの実行状況、フックの処理内容、スクリプトの読み込み状況などの詳細情報をリアルタイムで確認できるため、開発プロセスにおいて非常に便利なツールとなります。
私のプラグインでは、どのようにして多言語対応（国際化）を実現するのでしょうか？
WordPressはGNU gettextテクノロジーフレームワークを使用して国際化（i18n）を実現しています。まず、プラグインのコード内で、翻訳が必要なすべての文字列に対して… () または _e() これらの翻訳関数をラップ（encapsulate）し、そして… () この関数は、プラグインのヘッダー部分で定義された「Text Domain」を指定します。その後、Poeditのようなツールを使用してプラグインのソースコードをスキャンし、必要なデータを生成します。 .pot テンプレートファイルを基にして、異なる言語用のコンテンツを作成します。 .po そしてコンパイル後の .mo ファイルをプラグインの中に配置してください。 /languages/ ディレクトリ内にあります。最後に、使用してください。 load_plugin_textdomain() 「Function loading」の翻訳です。
私のプラグインをWordPressの公式プラグインディレクトリにどのように提出するか？
プラグインを公式ディレクトリに提出する前に、それが公式のプラグイン開発規格およびガイドラインに完全に準拠していることを確認する必要があります。WordPress.orgのアカウントを持っている必要があり、その後プラグイン提出ページでフォームに記入してください。審査チームがコードのセキュリティ、ライセンス（GPL互換でなければならない）、コードの品質、ドキュメント、および互換性をチェックします。審査に合格すると、SVNリポジトリのアドレスが提供されます。そのSVNリポジトリにコードを提出すると、プラグインが公式ディレクトリに掲載されます。このプロセスには数週間かかる場合があり、詳細な審査基準が設けられています。
次はどうする？
拡大読書と実践的知識
以下は、この記事のトピックに関連しており、さらに深く読むのに適している。あなたの現在の問題に最も近い記事から優先順位をつけ、徐々に周辺のトピックに広げていく方が良い場合が多い。
日本語