TOP > note > 0からのWordPress公式ディレクトリ登録〜プラグイン編 #wckansai

この記事は WordCamp Kansai 2014 のリレーブログ記事です。

6/7、8、WordCamp Kansai 2014 という WordPress のカンファレンスを大阪で行います。
WordCamp って何?どんなことをするの?という方はぜひ公式サイトをごらん頂ければと思います。
今回私は実行委員長をさせて頂いているのですが、ご挨拶を公式サイトにて書いておりますので、そういったものを読みたい方はぜひこちらをどうぞ。

さて、今回は WordCamp Kansai 2014 の 2日目コントリビューターデイの準備ブログとして、プラグインのWordPress公式ディレクトリでの公開の仕方をまとめました。
(コントリビューターデイについてはこちらをどうぞ日本のWordCampで初めての試み!コントリビューターデイってなんだ?

0からのプラグインWordPress公式ディレクトリ登録への道、です。

公式ディレクトリとは?

公式ディレクトリというのはWordPress.orgのPlugin Directoryで、ここに登録すると、WordPressのダッシュボードからもインストールできるようになります。

1

プラグインを作る

PHPができない私は今回あのWordPressで世界最初のプラグイン「Hello Dolly」と作り方を同じくして、自分の写真と言葉のサイト「僕等は人生における幾つかの事柄において祈ることしかできない」の言葉を管理画面(ダッシュボード)の右上にランダムに表示させるプラグインを作りました。

プラグインの作り方についてはこちらをどうぞ。 プラグインの作成 – WordPress Codex 日本語版

公式ディレクトリに登録する場合、最初から「同じプラグイン名のものはないか」を探して重複を避けることと、プラグイン名には半角英字とハイフンしか使えないということを想定して作っておくと後からの変更が無くてすみます。

公式ディレクトリに登録を申し込む

プラグインができたら公式ディレクトリに登録を申し込みます。

WordPress.orgアカウント登録

もしWordPress.orgのアカウントを持っていない場合は登録をしましょう。
このアカウントはWordPress.orgの日本語フォーラムと同じです。 登録はこちらから。UsernameとEmailの入力が必要となります。 2 https://wordpress.org/support/register.php

登録申請

WordPress.orgのPluginsより左サイドメニュー「Developer Center」→「Add Your Plugin」より申請画面に入れます。 3 こちらからPlugin Name(プラグイン名)とPlugin Description(プラグインの説明)とPlugin URL(プラグインをzip形式でサーバーにアップしてそのURLを記入)を入力して送ります。

すると、1日〜1週間ぐらいでSubversionのリポジトリのURLがメールで送られてきます。
(私は次の日に送られてきましたが、申請画面にレビュー待ちのプラグイン数でわかるように時間がかかる場合もあるようです。)

4

Subversionをインストールする

WordPressの公式ディレクトリではSubversion(SVN)でバージョン管理をしています。
ですので、プラグインを公式ディレクトリにアップするにはSubversionが必要となります。
以下、Mac版(OS 10.9.2)となりますが、0からのSubversionです。

Xcodeのインストール

AppStoreよりXcodeをインストールします。

5

Command Line Toolsのインストール

Xcodeを起動して、ツールバーの「Xcode」→「Open Developer Tool」→「More Developer Tools…」をクリック。

6

するとブラウザでApple Developerのサイトが開き、AppleIDの入力を求められます。
AppleIDを入力して進むとDownloadsのページに進むのでそこで「Command Line Tools (OS X Marverics) for Xcode」の最新版をダウンロードし、インストールします。

7

MacPortsのインストール

MacPortsのサイトよりOS X Marverics用のpkgファイルをダウンロードして、画面の指示に従ってインストールを行います。 http://www.macports.org/install.php 8 インストールが終わったら、ターミナルを開きます。
(アプリケーション→ユーティリティ→ターミナルで開くことができますが、私はSpotlight(Macの虫メガネアイコン)でターミナルと打って開いています。)

port help

と打ち込んでportコマンドに関する情報が返ってくれば問題なくMacPortsがインストールできています。

Subversionのインストール

さて、ここまでは準備のお話でした。
これでSubversionをインストールすることができます。 ターミナルで

sudo port install Subversion

と入力してください。
Macのユーザーパスワードを聞かれるのでそれも入力してください。(ターミナルではこの場合良くあるパスワード入力の“※※※”などは表示されませんが入力はできています。)
インストールされます。

port installed

と入力して、Subversionの表記が出てくるか確認してください。
出てくればインストール成功です。

公式ディレクトリへ登録

ここからはターミナルでの作業となります。
Subversionのコードを保持している領域を「リポジトリ(repository)」、リポジトリからコードを取り出す作業を「チェックアウト(checkout)」、戻す作業を「コミット(commit)」と呼びます。

Subversionリポジトリをチェックアウトするため空ディレクトリを作成する

ターミナルで作成するのであれば

mkdir plugin-name

※plugin-name部分はその時によって変わります。 ターミナルではなく「新規フォルダ」で作成しても良いです。

メールで送られてきていたSubversionリポジトリをチェックアウトします。

svn co http://svn.wp-plugins.org/plugin-name plugin-name

チェックアウトが成功すると該当のディレクトリの中にtrunk・tags・branches・assetsの4つのディレクトリができています(コピーされています)。 9

このtrunkディレクトリの中に作ったプラグインファイル(readme.txt含む)をコピーして、コミットします。
ターミナルでtrunkへディレクトリを移動します。
cdコマンドで打っても良いですし、移動したい先のディレクトリをターミナルにドラッグアンドドロップしても移動できます。
そしてtrunk内のファイルをコミットします。

svn add plugin-name.php readme.txt
svn commit -m "first release."

ファイル名とコミットメッセージを入れると、PCのユーザーアカウントのパスワードと、WordPress.orgアカウントのユーザ名とパスワードの入力を求められますので入力してください。

バージョン管理をしたいので、SVNリポジトリの tags/ ディレクトリに追加してみました。
trunk/ ディレクトリの内容を tags/1.0 にコピー。

svn cp trunk tags/1.0

コミット。

svn ci -m "tagging version 1.0"

公式ディレクトリを確認すると無事プラグインが公開されていました!(キャプチャはversion1.1へのアップデートを試した後のもの) 10

ヘッダー画像を登録する

せっかくなのでヘッダー画像も登録しましょう。
ヘッダー画像はassetsディレクトリの中に

  • banner-772×250.png
  • banner-1554×500.png(Retinaディスプレイ用)

上記名のpngもしくはjpgファイルをassetsディレクトリの中に準備した後にコミットします。

svn add assets/banner-772x250.jpg

反映は15分ほどでされるということなのですが、私の場合1時間経っても反映されません。
何故?と思ったらxが大文字になっていました…。(Takayuki Miyauchiさん、thanksです。)
※この半角xの件、数字x数字でWordPressに投稿すると表示が数字×数字で表示されるとのこと、コピーして使う方は半角xを使うように気をつけてください。Hitoshi Omagariさん情報ありがとうございます。)

気を取り直して再度アップ。無事反映されました。 11

公式ディレクトリ(僕祈ファンというものがもし居らっしゃったらどうぞ)
http://wordpress.org/plugins/pray-in-life/

Github
https://github.com/nukaga/pray-in-life

今回はローカルの作業はGithubとSubversionとわけて行ったのですが、更新していくことを考えると一緒にできると便利だなと思いました。
いくつか関連記事があがっているので次は挑戦してみたいな。

そして次はもっと便利なプラグインを作りたいと思ったのでした。(野望)

参考にさせて頂いた記事
ターミナル×SVN初心者として必須なコマンド
  • 現在入っているフォルダの一つ上の階層へ移動。
    cd ..
  • ディレクトリの移動は、ターミナル画面へ移動したいディレクトリをドラッグアンドドロップでもできる。
  • キーボードの上下矢印で過去に使ったコマンドが出てくる。
  • 一度コミットしているファイルの変更をアップする際には
    svn update

コントリビューターデイ事前準備に参考になりそうな記事

WordCamp Kansai 2014

今回はWordCamp Kansai 2014の2日目コントリビューターデイの中でも1部分であるプラグイン登録について書きましたが、1日目のセッションデイも、開発、コミュニティ、ビジネス、これからWordPressに関わりたい人、様々な視点で楽しんでいただけ、持ち帰っていただけるもの満載となっています。
WordPressに関わるということは世界と関わるということだな、と思います。
そして1人じゃできなくても、誰かと一緒ならできることも広がる。
WordCamp Kansai 2014 で皆さんとお会いできることを楽しみにしています。


WordCamp Kansai 2014 参加者ブログリスト #wckansai arrow-right
Next post

arrow-left WordPressの「メディアの追加」が効かなくなった時の対処法メモ
Previous post

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です