WordPressプラグインを自作。制作方法まとめ

（1）自作プラグインの本体となるPHPファイルにコメントで必要な情報を書きます

ファイル名もプラグインの名前に準拠します。

/*
* Plugin Name: プラグインの名前
* Plugin URI: 配布元のサイト、ページURL。プラグインの情報があるページがベスト。
* Description: プラグインの説明
* Version: プラグインのバージョン
* Author: プラグイン開発者
* Author URI: プラグイン開発者のサイトURL
* License: ライセンス
* License URI: ライセンス情報の記載があるページ
* Text Domain: プラグインのドメイン。これは翻訳時にも使用する
* Domain Path: 翻訳言語のフォルダを指定（/languages）
*/

（2）セキュリティ対策を行う

外部から不正にアクセスされ処理を実行されるのを防ぐためのコードを記述します。「ABSPATH」はWordPressのインストール先のディレクトリ（wp-config.phpが置かれたディレクトリ）のパスを示す定数なので、定義されていなければスクリプトが実行できずに終わるので、『WordPressを起動している本体のみPHP処理の実行を可能にする』ことができるようになります。

if (
    !defined('ABSPATH')
) exit;

（3）パフォーマンス対応

もし、サイトオプションを新規に作るのなら、プラグインをアインストールしたときに削除しておきます。ゴミとなるデータは残したくないしね！
「register_uninstall_hook」は、プラグインのアインストール字に呼び出される関数を登録する関数です。

（本音）テストのためにインストール・アインストールを繰り返していたのですが、その度にデータが復活してしまったのが気になったのとデータベース上で直接消さないと消えなかったから、ちゃんと消しておきたいなと思いました。

register_uninstall_hook(__FILE__, '呼び出す関数');
function 呼び出される関数名()
{
    delete_option('サイトオプションのキー');
}

（4）翻訳ファイルの読み込み

プラグイン（テーマもだけど）は基本英語なので、翻訳ファイルが必要となるため、翻訳ファイルがあれば読み込むように設定します。

日本語で作ってもいいんだろうけど、日本人固有で必要な機能というわけじゃないなら、英語で統一した方がいいと思う。

プラグインのドメインの指定が最初の頃は、いまいち理解できず、レビューで指摘された上で改めて調べ直してやっと理解できたので、ここでは予め「同じものを指定するんだよー」と書くようにしました。

add_action('init', function () {
    load_plugin_textdomain('プラグインのドメイン');
});

レンタルサーバーナレッジ

WordPress 初めてのプラグイン作成〜Hello Worldプラグインと多言語対応する方法｜レンタルサーバーナレッ… WordPressプラグインについて、作成するときに知っていると役に立つ情報を紹介していきます。 初回はプラグイン作成の基本となるHello Worldプラグインと、多言語対応する…

以降、翻訳対象文字は次のように記述します。

 __('（英語訳）', '（プラグインのドメイン）')

けーちゃんの個人サイト

WordPress: __()や_e()だけじゃない。翻訳関数の一覧 ｜ けーちゃんの個人サイト WordPressには__()や_e()などの翻訳機能があります。 調べてみるとこれ以外にもあるようです。 そこでソースコードから抜き出してみました。 翻訳関数の一覧 WordPressの翻…

プラグインの翻訳フォルダ「languages」の中には、下記のファイル「readme.txt」を入れます。

Translations have moved to
https://translate.wordpress.org/projects/wp-plugins/プラグインのURL

Thank you for your contribution.

他の人のプラグインにあった記述を参考に書いています。
この前に翻訳ファイルを試行錯誤して作っていた名残ですが……。
後ほど出てきますが、「WordPressの翻訳側で翻訳しているのでファイルはないよ。引っ越したよ」というようなことを書いています。

（5）ここから自作プラグインの本体の制作に入ります。最初にメニュー登録をします

プラグインのメニュー登録をします。設定画面を用意するなら、必要になります。

設定画面や説明画面等のないプラグインも中にはありますが、「これをするだけ！」のように一言で説明できるプラグインじゃないなら、用意してあげた方が親切かなと個人的には思います。既にあるメニュー「設定」や「ツール」に含めるやり方もあるはずですが、探していませんでした。改めて今思うと、プラグイン追加した後に「設定画面どこー？」ってなりやすいので、独自メニューがあった方が自分にとっては有り難いですね……。

色々試行錯誤したのだけれど、結果的に「メインページ表示呼び出し用」は「サブページ表示呼び出し用」と同じものを指定して、登録しておいた方がいいと思う。

必要な権限の設定は、管理者で指定しておけばいいかなと思っていますが、プラグインの用途で選ぼう。また、メニューが表示される位置のインデックスはサンプルコードでは「0」としていますが、クリエイトアコードが作ったときは「81」で指定しました。そんな重要な設定じゃないなら、下に配置するのが良さそう。

add_action('admin_menu', function () {
    // メイン設定
    add_menu_page(
        '', // ページのタイトル
        '', // 左メニューテキスト
        'manage_options', // 必要な権限の設定
        '', // 左メニューのスラッグ名
        '（以下のメニューの「サブページ表示呼び出し用」で使う関数名を登録）', // メインページ表示呼び出し用（サブメニューを使う場合は空）
        '', // メニューアイコン https://developer.wordpress.org/resource/dashicons/#awards
        0 // メニューが表示される位置のインデックス(0が先頭)
    );
    // サブメニュー（親メニュー）
    add_submenu_page(
        '', // 親メニューのスラッグ
        __('（英語訳。ページのタイトル名）', '（プラグインのドメイン）'), // ページのタイトル
        __('（英語訳。ページのタイトルと同じものを指定）', '（プラグインのドメイン）'), // 左メニュー（サブメニュー）テキスト
        'manage_options', // 必要な権限の設定
        '（親の「左メニューテキスト」を指定）', // サブメニューのスラッグ名（親と同じにすると親メニューもサブメニューに連動）
        '（メインページ表示呼び出し用とおなじものを指定）', // サブページ表示呼び出し用（任意）
        0
    );
    // サブメニュー「（サブメニュー名）」（事実上の子メニュー）
    add_submenu_page(
        '', // 親メニューのスラッグ
        __('（英語訳。ページのタイトル）', '（プラグインのドメイン）'), // ページのタイトル
        __('（英語訳。ページのタイトルと同じものを指定）', '（プラグインのドメイン）'), // 左メニュー（サブメニュー）テキスト
        'manage_options', // 必要な権限の設定
        '', // サブメニューのスラッグ名
        '（サブページ表示呼び出し用の関数名を指定）', // サブページ表示呼び出し用（任意）
        81
    );

（増やしたかったら、【サブメニュー「（サブメニュー名）」（事実上の子メニュー）】をコピペして中身を変えて使ってください）

});

タルト株式会社

【初心者】自作のWordPressプラグインを作成する ～コピペで開発できる作り方で解説 | タルト株式会社 自作のWordPressプラグインを作成するこの記事では「WordPressプラグインを自分で作成する方法」を解説します。初心者でもわかりやすいようにレベル別に徐々にステップアッ…

もう一つ、プラグインの親子メニューで詰まったときに見ていたページ、サイトごとなくなってた！
引っ越したのかなと思って記事名で探しても見つからず……。
数ヶ月でサイトが消えるって……とこれを書いていて知ったときは衝撃を受けました。

（6）自作プラグインの本体の制作の続きです。実際に画面を作ったり実行する処理を書いたりします

メニューがあるなら表示する画面を用意しましょう。
表示や設定処理については、それぞれ作る内容が異なると思うので、サンプルソースの記載をしていません。

自分が作ったプラグインの処理をさらっと書くと「get_optionで既に保存してある値があれば取得する」「POSTされたデータがあれば取得し、サニタイズして、サニタイズしたデータを保存する更新時の処理を書く」「表示用の関数に入れて、画面に更新したことを示すメッセージを表示する」「フォームを作り、同じPHPファイルにデータをPOSTする」「wp_headまたはwp_body_openのアクションフックを使って、保存してある値を使ったコードを生成する」です。オープンソースなので、プラグインの中のコードを見た方が早いかも。

function メニューで登録したメイン設定の関数名()
{
    // アクセスしたときに権限があるか確認
    if (!current_user_can('manage_options')) {
        // エラー文章
        wp_die(__('英語訳。「権限がないよ」という内容を記述', 'プラグインのドメイン'));
    }

    // 表示
?>
（表示部分や設定処理を記述します）
<?php
}

心が折れた人向け

WordPressテーマ「SWELL」の制作者の了さんはプラグインも作っているのですが、作り方について自身のサイトで解説ページを投稿しています。
デモファイルを配布しているので参考にしてみてくださいね！

WEMO

超簡単！WordPressプラグインの作り方（デモファイルの配布あり） | WEMO WordPressの勉強を始めようとすると、基本的には「テーマ」の作り方についての情報ばかり出てきます。 しかし、 既存テーマを自分でちょろっとカスタマイズしたい時細かい…

（1）プラグイン・テーマを登録するなら、wordpress.orgの登録は必須なので、予め登録しておく。

日本語版あるの、有り難いよね。

サポートフォーラム

WordPress.org アカウントの作成とログイン フォーラムに投稿したり、コメントするには、WordPress.org (今見ているこのサイト)にアカウントを作…

（2）プラグインの申請をするために「readme.txt」を用意します。

=== Hide GTM code ===
Contributors: 作成者名（WordPress.orgのアカウント名になります。複数人のときはカンマ区切りで記述）
Tags: プラグインのカテゴリ的なタグ。検索のため。カンマ区切りで記述
Requires at least: 動作するWordPressの最低バージョンだけど、WordPressは常に最新にしておこうと思うので、基本的に最新にしています。
Tested up to: 検証した最新のWordPressのバージョン
Stable tag: プラグインのバージョン
License: ライセンスの種類
License URI: ライセンス情報の記載があるページ
Requires PHP: 必要なPHPのバージョン。基本的には、WordPress本体の推奨PHPバージョンに合わせています。
ここに「Donate link」という寄付用のリンクを書くこともできるけど、日本は寄付制度あんまり受け入れられていないから、書いてない。

プラグインの検索したときの画面やプラグイン一覧で表示される説明文（英語訳で記述）


== Description ==


プラグインの説明文（英語訳で記述）


== Installation ==


プラグインのインストール方法（英語訳で記述）


== Frequently asked questions ==


よくある質問・FAQ（英語訳で記述）


== Screenshots ==

スクリーンショットの説明（英語訳で記述）


== Changelog ==


更新履歴（英語）
最初はリリースとかそんな感じになると思う。


== Upgrade notice ==


アップグレード履歴（英語）
リリース後のバージョンアップから記載。


== Arbitrary section ==

他に説明があれば記載（英語）

できたら、検証用ツールで問題がないか調べます。

（3）問題がなければ、ZIPファイルに圧縮して申請します。

WordPressプラグインディレクトリトップページの下部に「プラグインを追加」「プラグインを作成」の項目があり、プラグインを掲載する方法のところにリンクがあるので、そこからでもたどり着けます。

レビューは英語なので、Google翻訳等をなんとかうまく使って対応してみてください。
個人的なコツは、日本語で文章を作成して英語に翻訳して更に日本語に翻訳する、複数回翻訳をしながら、どちらでも不自然にならないように文章を整えることです。（参考に見ていたページでも書いてましたね）

プロガジ.DEV

開発したWordPressプラグインを公式サイトで公開する手順 どうも、まちゃと申します。 この記事では自分で作成したWordPressプラグインを公式サイトに登録する申請から初期設定までの流れについて紹介します。 プラグインの申請は2…

プロガジ.DEV

【実例付き】WordPressプラグイン開発で使用するreadme.txt 公式サイト個別プラグインのページや管理ページからのインストール画面に表示される内容はこのreadme.txtから自動的に生成されます。 プラグインを使用できるPHPのバージョ…

（4）SVNを使ってコミットする

WordPressのレビューチームから承認されるとシステムのアップロード（チェックイン）の仕方などが案内されますが、英語。
コマンドラインで対応したことはないし、ソフトは随分と昔に使ったことはあるけど、記憶が曖昧なので、改めて調べました。
「TortoiseSVN」というソフトを使った方が楽かなと個人的には思います。

ネットビジネスで自由に生きる！会…

【WordPress】TortoiseSVNでプラグインを公式ディレクトリにアップロード！手順の詳細解説 ワードプレスのレビューチームから承認をもらったら（レビューが終了したら）いよいよ公式ディレクトリへのアップロード（チェックインなんて表現しますね）。 何か難しそ…

（5）「GlotPress」で翻訳

プラグイン作成者と翻訳編集者は別なので、プラグイン作成者が日本語訳を登録しようと思った場合、翻訳編集者になる必要があります。
または「Poedit」ツールを使って翻訳用ファイルを作るやり方もありますが、今は「GlotPress」という便利なものがあるから、こっちを使っていこうよと思うので、やり方は載せません。クリエイトアコードも最初は調べながら「Poedit」ツールを使うやり方で対応したので、調べたら情報が出てくると思うよ！

「GlotPress」で翻訳するやり方に変更するときに、「GlotPress」のやり方を調べても最新の情報が載っていなかったのってなんでだろうね……。
参考ページのリンクを貼ろうとしたけど、かえって分かりづらいかな……画面のスクリーンショットもあるから良いかなーとは思いつつ……。

参考ページを見ながらPTEリクエストするやり方で対応したのですが、投稿があるのかないのか分からずに何度も投稿しちゃったり、Slackでも「該当チャンネルどこー？」と探すなど、かなり手間取ってしまったため、最初から日本語のSlackで申請した方が早いし混乱なく対応できるかと思います。
後から続く皆はSlackメンバーになって、Slackから申請しようね！
（もし、PTEリクエストで対応したい場合は、英語でも公式ヘルプページの方が画像付きで説明されているので分かりやすいよ）

翻訳するためには、Slackのメンバーになる必要があります。

サポートフォーラム

Slack への参加方法 WordPress コミュニティでは Slack をメインのリアルタイムコミュニケーションツールとして使用して…

リンクをクリックした後、左側はユーザー名（アットマークは不要です）を入力して送信するとリンクが届くので、ユーザー登録をしてください（英語版と日本語版の両方登録します）

ネットビジネスで自由に生きる！会…

【WordPress】翻訳を手伝いませんか？で readmeの日本語翻訳追加！翻訳編集者になって商品するまでを解説 自作プラグインの承認後、公式ディレクトリのSVNにコミットした後に readme.txt も英語に直してます。 プラグインのページを見てみるとすぐ反映されてますが、日本語環境の…

見出し「翻訳編集者になる！」以降のコンテンツはPTEリクエストするやり方のため、閲覧をオススメしません。

（6）プラグインのバージョンアップ、更新のときの備忘録

プラグインの更新の間隔が空いたことで、更新と翻訳に手間取ってしまい、コミット回数が増えてしまったので、再発防止も兼ねて備忘録を作成しました。

• プラグイン本体のファイルのバージョンを変更することを忘れない
• Readmeテキストファイルのバージョンを変更することを忘れない
• 動作確認バージョンの更新はReadmeテキストファイルのみ。WordPress本体のバージョンアップと同時期に動作確認バージョンを合わせて変更することを忘れない（動作確認していない場合は更新しない）
• バージョンアップしたときは「Changelog」「Upgrade notice」の2箇所に追記することを忘れない

クリエイトアコードの場合は自分で使っているプラグインなので、必然と動作確認はできる

（7）フォーラムの投稿通知の設定をする

ガイドライン違反で掲載停止されることを防ぐためにも、フォーラムへの投稿を確認するようにしましょう。
きちんと確認していても、なかなか難しいと思いますし、即座に掲載停止されるのではなく、フォーラムで投稿してくれると思うので、気づかずに対策しないで掲載停止されないように設定しておきましょう。

株式会社ベクトル

WordPress公式ディレクトリで公開している自分のプラグインについて、フォーラムの投稿通知設定方法 先日 自社で開発・管理しているプラグイン VK All in One Expansion Unit で盛大にガイドライン違反をしていて一時掲載停止された石川です。その節はユーザーの皆様には多…

さすがに、「wp_head()」と「wp_body_open()」がないテーマには使えないです

どこに出力したら良いのか分からないし、ページ表示速度の問題も出てくる可能性もあるので、ここまではフォロー無理です……。
この場合は、テーマ制作者に相談いただくか、別なテーマを使うか、リニューアルするかで対応してほしいところ。
プラグインを使わずにテーマの機能や別のプラグインを使って対応するでも良いと思います。

自分以外にも使ってくれると思って、これからもしっかりとメンテナンスしていきたい

自分で使うだけなら、ある程度妥協していたかもしれませんが、WordPressプラグインディレクトリに登録した、自分以外も使ってくれているかもしれないプラグイン。だからこそ、これからもしっかりとメンテナンスしていきたいと思っています。

自作プラグインで、初回データ登録時にコードの表示が消えてしまう（コードが表示されない）ので表示されるようにする修正を行ったのですが、今後、特に新規プラグインの動作テストするときは新規サイトにもプラグインを入れてテストすることを徹底したい所存。