最近、WordPressコントリビュート活動の一貫として、公式ディレクトリ向けのテーマやプラグイン制作に取り組んでいるのですが、その中の一つであるプラグイン「Floating Top Link」が公式ディレクトリに登録されました。
『トップへ戻る』ボタンを表示するだけという、超シンプルなものですが、プラグインの作り方や、公式ディレクトリの申請フローを学習する上で、非常に良い題材になりました。今後、少しずつバージョンアップしていく予定なので、よかったら皆さんも使ってみてください。
目次
WordPress公式ディレクトリとは?
WordPressは、誰でも無料で利用できるブログツールですが、その大きな魅力の一つは、手軽にデザインを変更できる『テーマ』や、便利な機能を追加できる『プラグイン』といった拡張機能が、たくさん公開されている点だと言えるでしょう。
テーマやプラグインは、誰でも作成して配布することができるのですが、一定の審査に通過したテーマやプラグインだけが掲載されている『公式ディレクトリ』というものがあります。
公式ディレクトリに登録されたテーマやプラグインは、WordPressの公式サイトに掲載されるだけでなく、世界中のユーザーが利用しているWordPressの管理画面から、直接検索してダウンロードすることができるのです。
まさにボタン一発でインストールできるのですから、ユーザーに届ける上で最も理想的な手段だと言えるのではないでしょうか?
公式ディレクトリ向けプラグインを作るには?
公式ディレクトリの審査に通過には、WordPress公式のガイドラインに準拠した上でプラグインを開発する必要があります。他にも、公式ディレクトリへ申請には、所定の書式で記述されたドキュメント(readme.txt)を設置するなど、細かいルールがあります。
初心者がこれらのことを網羅するのはちょっと難しいのですが、私は「WordPressプラグイン開発のバイブル」という本を読んで、あらかじめポイントをチェックした上でプラグイン作りに臨みました。
「WordPressプラグイン開発のバイブル」は、プラグインの仕組みから、プログラミング的な基礎、公式ディレクトリへの申請方法まで、分かりやすくまとめられているので、プラグインを作ってみたい方にはぜひオススメの一冊です。
私の場合、HTMLとCSS、JSをサイトに追加するだけという単純なプラグインだったこともありますが、この本を参考にしたところ、かなり簡単に実装することができました。(コーディング自体は約数時間)逆に、readme.txtをきちんと書いたり、環境に依存しない作りに調整するのに時間がかかったという感じでしょうか・・?
ローカルや自分の環境で正しく動作するのが確認できたら、zipファイルにまとめて申請するだけでOKです。私の場合、申請から2日ほどで承認が降りて公開の準備が整いました。
「Floating Top Link」を作ったわけ
もうお気づきの人もいるかもしれませんが、「Floating Top Link」は、このブログの右下に設置されているリンクボタンをプラグイン化したものです。
このようにjQueryの簡単なパーツであれば、WordPressのテーマファイルに直接記述してしまうという人も多いでしょう。ブログなどで検索しても「プラグインを使わずに◯◯する方法」という記事がたくさん出てくるので、その方が玄人っぽく見えてしまうのも仕方ありませんよね。(私も最初そう思ってました)
では、自分のブログをリニューアルしたり、新たなサイトを作ったりした時に、同じように「トップへ戻る」ボタンを追加したい、と思ったらどうでしょう?いちいち変更点を洗い出して、その都度同じコードを書くのは手間ではありませんか?
また、「そういえば、この矢印にFont Awesomeを使ってたから、そいつも導入しないとね・・」なんてことも往々にして起こり得るので、単純に移植したくても一筋縄ではいかないかもしれません。
そういったことに備えて、「機能として切り出せるものはプラグイン化した方がいい」。そんなプラグインのメリットを知ったので、今回勉強も兼ねて取り組んでみようと思ったのです。
そして、どうせプラグイン化するなら、きちんとしたものを作って公式ディレクトリに公開してしまった方が、WordPressコミュニティへの貢献にもなるし、一石二鳥と言えるのではないでしょうか?
初めてのプラグインを作ってみて・・・
さて、そんなわけで私が初めて作ったプラグイン「Floating Top Link」は、現在WordPressの公式ディレクトリに公開されています。
WordPressの管理画面からも直接インストールできるようになっているので、ぜひ「Floating Top Link」という名前で検索して、ダウンロードしてみてください。
今回プラグインを作ってみて改めて感じたのは、「プラグインというのは必ずしも機能的に複雑なものでなくてもいいんだ」ということです。
私が作ったプラグインなんかも、ほとんどHTMLとCSSだけでできているので、プラグインというよりテーマから切り出された、『備品』のようなものだと思うのです。
そういったものでも、きっと需要はあると思うので、もっとデザイン寄りの人がプラグインをたくさん作るようになったら面白いんじゃないかな、と思いました。
コントリビュート活動のススメ
WordPressやPHP自体にはそれほど詳しくない私でも無事に公開できたので、WordPressのカスタマイズ程度なら問題ないという方には、プラグイン作りはぜひお勧めです。
さらに公式ディレクトリへの公開を前提に取り組むことで、より一層学習効果が高まると思うので、ぜひ皆さんもトライしてみてはいかがでしょうか?
関東では、「WordPressコントリビュート勉強会」というイベントも定期的に開催されていて、実際に公式ディレクトリへプラグインを公開している方の話を聞くこともできます。
テーマやプラグインを作成するだけでなく、自分が好きなプラグインを翻訳する、といった比較的取り組みやすいコントリビュート活動もあるので、自分の興味のある領域から、掘り下げてみると面白いかもしれません。
私自身は、プラグインだけでなく、公式ディレクトリ向けのテーマ制作も同時に進めています。こちらも、このブログのテーマをベースに、新たに作り直しているものなのですが、現在公式ディレクトリに申請中です。
テーマの方は、有志の方々でレビューを行っている等の事情もあり、審査が終わるまでもう何ヶ月かかかりそうです。(詳しくは、去年のWordCamp Tokyo コントリビューターデーの記事を参照)こちらも、無事に公開されたら紹介したいと思っているので、ぜひお楽しみに・・。
関連リンク
- 「Floating Top Link」の公式ディレクトリ
- 「Floating Top Link」のGitHubリポジトリ
- WordPressコントリビュート倶楽部 at コエド | Doorkeeper