ぱんぶろ

パンジーの「いいね!」ブログ

WordPressプラグインを公式ディレクトリに申請して登録する方法

     

plugin-up7

去年(2015年)の10月にWordCampという毎年一回行われるWordPressの大きなイベントがあって、そこでプラグインの作成から公式ディレクトリの登録まで実践形式で行うことができました。(関連→WordCamp Tokyo 2015 コントリビューターデイに参加した感想など!

「教えてもらった内容を近々ブログに書きます!」と言っておきながら早半年ほどが経過しようとしてます。月日の流れは早いものですね。

懺悔の気持ちも込めてプラグインをWordPress公式ディレクトリに登録する方法を紹介します!

落ちる人はほぼいないので、かなり敷居は低い(と思います。)

スポンサード リンク

WordPressの公式ディレクトリに登録する方法

まずはプラグインを作ることです。
プラグインを登録するわけですから当然ですよね。

どんなにしょぼいプラグインでも大丈夫です。WordPressにプラグインとしてインストールし動作すれば問題ありません。つまりエラーとか初歩的な問題がなければ。

なお、プラグインの作り方が分からないって方は、次の記事を参考に作ってください。→WordPressで自分用プラグインを作り方!

ヘッダー情報を追記

自分用のプラグインではプログラム本体のphpコードにヘッダー情報を記載しましたが、「プラグイン名」しか記載してません。

公式ディレクトリに登録するためには、その他に計8個の記載が必要です。

サンプルとしては以下のような感じです。

/*
Plugin Name: PLUGIN NAME
Version: 1.0
Description: PLUGIN DESCRIPTION HERE
Author: Panzee
Author URI: https://www.panzee.biz
Plugin URI: https://www.panzee.biz
Text Domain: plugin-name
Domain Path: /languages
*/
  • Plugin Name・・・プラグイン名
  • Version・・・バージョン
  • Description・・・プラグインの説明文
  • Author・・・作者
  • Author URI・・・作者のサイト
  • Plugin URI・・・プラグインの紹介ページ
  • Text Domain・・・国際化用のテキストドメイン名
  • Domain Path・・・国際化用のファイルパス

国際化以外はなんとなく分かると思います。バージョンは自分の管理しやすい付け方で問題ありません。

注意が必要なのは、全部英語で書かなければいけない点です。

国際化については初めの内は、Text Domainは、プラグイン名を小文字にしてハイフンで繋いだもの。Domain Pathは、/languagesと覚えておいてください。

readme.txtの作成

そしてもう一つ。必ず必要なのがreadme.txtファイルです。

こちらも英語で書かなければいけないので面倒くさいですが、フォーマットが決まっているので翻訳片手に作っていってください。

フォーマットはこちら→https://wordpress.org/plugins/about/readme.txt

フォーマットが長すぎる気がするので自分が申請した時のを例に出すと、以下のような感じです。

=== プラグイン名を書く ===
Contributors: panzee ←作者
Requires at least: 4.3 ←最低限必要なWordPressのバージョン
Tested up to: 4.3 ←テストしたWordPressのバージョン
Stable tag: 1.0 ←バージョン。phpのヘッダ情報に書いたバージョンと合わせる。
License: GPLv2 or later ←このままでOK
License URI: http://www.gnu.org/licenses/gpl-2.0.html ←このままでOK

ここに説明文を書きます。(日本語でOKだった。)

== Description ==

ここにも説明文を書きます。(日本語でOKだった。)

== Installation ==

1. Upload the entire `プラグインのフォルダ名を書く(小文字でハイフンでつなげたやつ)` folder to the `/wp-content/plugins/` directory.
1. Activate the plugin through the 'Plugins' menu in WordPress.

== Changelog ==

= 1.0 =
* first release.

こんな感じでした。
今見返したら説明文のところは日本語で申請出してたので、日本語でもOKなんだと思います。厳密には英語じゃないとダメなんでしょうが。

readme.txtとphpヘッダ情報がフォーマット通りに書けていて、かつエラーがないプラグインが作れていれば申請はほぼ確実に通るはずです。

プラグインとreadme.txtの格納されたフォルダを圧縮

例えば「Plugin Name」という名前のプラグインを作るとしたら、
plugin-nameというフォルダとその配下にplugin-name.phpというファイルが作られているはずです。
plugin-nameフォルダにreadme.txtも格納してplugin-nameフォルダを圧縮します。

フォルダの中身。
plugin-up2

圧縮。
plugin-up

インターネット上に公開

圧縮したフォルダをインターネット上のアクセスできるどこかに置きます。
アクセスできればどこでも大丈夫です。要はWordPressのプラグインを審査する人が覗ける場所に置いてくださいということですね。

WordCampの時はほとんどの人がGithubに置いてました。わたしはアカウント持ってなかったので自分のレンタルサーバー上に置きました。

公式ディレクトリへ申請手続き

ここまで準備ができたら後は申請を残すのみです!次の申請ページにアクセスしてください。→Requests — WordPress Plugins

WordPress.orgのアカウントが必要です。持っていない人はまず取得してください(必須(Required)のところだけで大丈夫ですよ)。持っている方はログインしてください。
plugin-up3

プラグインの登録画面になります。プラグイン名、プラグイン説明文、インターネット上に置いたzipファイルの配置場所を記載してください。(英語)
plugin-up4

これで公式ディレクトリへのプラグイン申請は完了です!

数日後メールが届く

問題なく申請が通れば、以下のようなメールが届きます。
plugin-up5

WordPressの公式にプラグインが登録されるとサブバージョンのリポジトリが与えられるようになります。今後、プラグインを更新する際は、サブバージョンでバージョン管理していくということですね。

サブバージョン???はて?という方には、Eclipseがおすすめです。GUIで比較的簡単にサブバージョンを使えますよ。→Eclipseにサブバージョン(SVN)を導入する方法とWordPressプラグインをEclipseで管理する方法

公式ページを見てみよう!

自分の作成したプラグイン名で検索してみましょう。たぶん出てくるはずです。

ちなみにわたしが作成したプラグインは「One Year Info」というもので、クソしょぼいですが、申請は通って公式にあります。
plugin-up6

このレベルでも通るということと、プラグインを作ろうと思っている方はダウンロードして中身を見てもらうと、この記事の内容もより具体的に理解できるかもしれません。

まとめ

WordPressプラグインを公式ディレクトリに申請し登録する方法でした。

プラグインが作れる人なら公式に登録するのは簡単です。やり方を知ってるか知ってないかの差だけで技術的なハードルはとてつもなく低いです。

ということで、みなさん素敵なプラグインをたくさん公式にアップして使わせてくださいね。