wordpress 自作プラグインをwordpress.orgに登録(中編)

自作プラグインをwordpress.orgに登録(前編)では、

wordpress.orgのアカウント作成までをやりました。

ここからはプラグイン作成に必要なモノ集めや、プラグインの審査依頼です。

1.プラグインに必要な”モノ”をあつめる

http://wordpress.org/extend/plugins/about/

先にこちらを読むことをオススメします。

いわゆる、プラグインを登録(配布できるように)するにはこれを書いてね、これを入れてね。

的な”ルール”ですね。筆者が作成したプラグイン「post-category-height-edit」を登録する際にした事は、

プラグイン本体に、

まずはこの4つを集めました。(英語ばかり。。)

言語ファイル、スクリーンショットは既に配布されているプラグインを真似てなんとか作成できましたが、readme.txt ははんぱなく難しかったので、その書き方(合っているかは不明)をここで説明したいと思います。

  1. まず1行目に、「=== Plugin Name ===」とあるのですが、ここに自作プラグインの名前を書くそうです。(普通に説明文というか、無視して構わないところだと思っていました。。)
  2. 次の行からの説明として、
    Contributors
    作成者のID (これはwordpress.orgに登録したIDを記載するようです)
    Donate link
    寄付について記載しているURLの事らしいですが、特に今は寄付してねはやってないので、筆者はスルー
    Tags
    関係するキーワードを書いたらいいのではと思います。
    サンプルはhttp://wordpress.org/extend/plugins/tags/
    Requires at least
    最低限のwordpressのバージョン。例えば3.0以下では動かないとかであれば、
    requires at least : 3.0
    Tested up to
    テストで試したwordpressの最新バージョン
    Stable tag
    自作プラグインのバージョン(たぶん安定バージョンを書けばいいのではないかと思います)
    あとで何回も修整とかなるのが筆者は怖いなと思いましたので、1.0とかではなく、1.0.0とかにしました。
  3. Here is a short description of the plugin.  This should be no more than 150 characters.  No markup here.
    プラグインを150文字程度で簡単に説明してください。と。なんかいい翻訳するサイトないかな~。。
  4. == Description ==
    また説明文かよ。他に説明する事がないので、スルー。
  5. == Installation ==
    インストール方法。プラグインディレクトリにアップして、有効化してね。を英語で。。。
  6. == Frequently Asked Questions ==
    いわゆるFAQ。よくあるご質問的な。初めてアップするので、今はスルー。
  7.  = A question that someone might have =
    ここはよくある質問の質問を記入。 すぐ下に答えを記入。
    だから=が一個しかないのね。
  8.  = What about foo bar? =
    さっぱり意味が分からない。。 Google翻訳をかけると、「= fooのバーはどうですか?=」。うん、スルー。ただ、=が一個だけなんで、FAQに関係しそうな感じ。
  9. == Screenshots ==
    同封しているスクリーンショットの説明を記載。スクリーンショットの数の分だけ記載。
  10. == Changelog ==
    自作プラグインのバージョンの更新履歴を書くところ。はぁ、疲れた。。
  11. == Upgrade Notice ==
    自作プラグインの各バージョンでのアップデーの必要性を書くところ。
  12. == Arbitrary section ==
    任意で自由に記載するところ。もう、疲れたのでもちろんスルー。
    しようと思いましたが、そっか。英語ばかりで説明していたので、日本語の説明をここを使って書けばいいのか。
    ということで、日本語での説明をここに記載。

これでreadme.txtは以上になります。

あとは、http://wordpress.org/extend/plugins/about/validator/ にて記述チェックをして、

間違いがあれば直していくという方向で。

2.お待ちかねのプラグインの審査

プラグインを登録する前に、wordpress.orgにてプラグインの審査があります。

その審査をする際に、自作プラグインがダウンロードできるようにしておく必要があるので、

zipファイルなどに圧縮してサーバにアップロードしておきます。

 

まずはwordpress.orgにログインしてください。

そして、http://wordpress.org/extend/plugins/add/

からwordpress.orgに自作プラグインの審査依頼をだします。

Plugin Name (required) = プラグイン名(必須)

Plugin Description (required) = 説明文(必須)

Plugin URL (this should be a link to a ZIP file of the working plugin) = プラグインURL(さっきアップロードしたzipのURLを指定すればいいと思います)

を全て記載して審査依頼開始!みたいですが、そういった画面にならないので

よく分からないです。。

 

あとはここから何日か経つと、wordpress.orgから審査結果が来るらしいので、

それが通ると、SVNを使ってwordpress.orgにアップロード!です。

長かった~。。。

 

次は審査結果が届いた後の「wordpress 自作プラグインをwordpress.orgに登録(後編)」を

記載していきたいと思います。

 wordpress 自作プラグインをwordpress.orgに登録(後編)

wordpress 自作プラグインをwordpress.orgに登録(前編)

自作プラグインの登録自体は、様々なブロガーさんが記事にして、ご親切にお教えしていると思いますが、それを参考にしてやってみましたが、さっぱり。。

なので、このサイトでも改めてwordpressの自作プラグインを wordpress.orgに登録するまでの過程を、記事として載せていきたいと思います。

ただ、あくまでも筆者の場合はこうでした。という事であって、このやり方が正しいかどうか、不足が無いかどうかは分かりませんので、ご了承ください。

 

まずはじめに

一服しておくことをオススメします。

英語やプログラムに慣れている方ならあまり難しくないかもしれませんが、なにせ初めてでしたので、、大変でした。(冗談抜きで)

 

1.すいません、ここから本題です。改めてはじめに…

自作のプラグインを登録する前に、作成したプラグインがまず、

既に作られていないかどうか検索して探します。

http://wordpress.org/extend/plugins/

(全部見ていたらきりがないので、なんとな~くでいんじゃないかと思います。)

 

2.作成したプラグインの、エラーを完全に無くしておく。

これはよく忘れがちなんですが、分からない方もいるかもしれませんので書いておきます。

wordpressはそのままの設定では、PHPのエラー等は全て表示はされません。

※Notice とかは表示されなかったような。。うろ覚え。

なので、wp-config.php の下ら辺に、

define(‘WP_DEBUG’, false);

のデバッグモードがfalse になっていたら、 true にして、再度プラグインの動作確認をしてみてください。

(さらに忘れやすい点で、作成したプラグインに伴うDBのデータも、一度消してから確認です。

データが無くてNotice エラーが出たりします。。)

 

3.登録する前に、wordpress.org でアカウントのみを取得する

wordpress.org で作成したアカウントIDを後で使う必要が出てきますので、

先にアカウントのみ取得します。

  1. http://wordpress.org/extend/plugins/ 
    (Login のほうに、Register があるのでクリック)
  2. 基本的に全て英語での登録フォームなので、わけわかめ。。
    筆者の場合は、とりあえずオプション的な項目は後で記載すればいいだろうという事で、
    ユーザー名とメールアドレスのみを記載して登録しました。
  3. 記載したメールアドレス宛に、Enjoy! と。なんとシンプルな。。。と思うようなメールが届いているはずです。
    そのメールに、wordpress.orgのユーザー名とパスワードが記載されているはずです。 

これで、アカウントの作成は終わりです。

 

長くなりそうなので(というかプラグインを実際に登録しながら、この記事を書いている)、

この続きは次の記事として記載します。

 中編はこちら

wordpressプラグイン POST-CATEGORY-HEIGHT-EDIT

なんとなくこのプラグイン名から想像がつくかと思いますが、

wordpressの投稿の編集、投稿の新規追加の画面内の、カテゴリーを選ぶ窓を

もっと使いやすく出来るように(といってもただ伸ばすだけ)した、

機能的には超シンプル過ぎて、本当にプラグインにすべきなのか?!

といったプラグインです。

 

とりあえずこんな感じです。

カテゴリ数が多くなると、下のほうにあるカテゴリを選択する際に、わざわざスクロールするのが

いつも手間で手間でしょうがありませんでした。

かといって、カテゴリの枠を大きく”固定(たとえば縦幅1000pxとか)”にすると、

カテゴリもサイトを運営していくにつれて増えていくはずで、固定にすると面倒だと思い、

利用する時に自由に変更できるようにした、プラグインになります。

 

 使い方

まずはプラグインをダウンロードしてください。

>> ダウンロード

次に、プラグインを wp-content/plugins/ 内に解凍してアップロードしてください。

プラグインのパネルで有効化をすると、既に使える状態になっていますので、

記事投稿画面からカテゴリの高さをお好みに変更してください。

以上になります。

 

※注意※

  • 注意とまではいきませんが、このプラグインは jquery jquery-ui-resizable を使用しているので、管理画面を直接いじってjquery系を読み込まないような設定にしている場合は動作不可となります。
  • カテゴリの高さを変更したその日から、7日間だけ高さの設定を保存しています。(Cookieを使用)7日間以上経つと、元の高さに戻っているのでその際は再度高さを変更してください。