WordPressプラグインディレクトリへのプラグインの追加方法

やりました!WordPressプラグインの準備が整いました。これで、何千人ものWordPressユーザーが見つけて利用できるように、プラグインリポジトリにどのように追加するかを疑問に思っているでしょう。

WPBeginnerでは、公式ディレクトリでいくつかの人気のあるWordPressプラグインを管理しています。そのため、プラグインの承認を遅らせる可能性のある一般的な落とし穴を含め、この提出プロセスをすべて熟知しています。

WordPressプラグインディレクトリは単なるストレージスペースではありません。何百万人ものユーザーが毎日ソリューションを探している活気のあるマーケットプレイスです。プラグインを正しくリストに載せることは、忘れ去られるか広く採用されるかの違いを生む可能性があります。

複数のプラグインを提出した経験から、多くの開発者が予想するほどプロセスが簡単ではないことを学びました。しかし、心配しないでください。WordPressプラグインディレクトリにプラグインを提出する際の正確な手順を説明します。

WordPressプラグインディレクトリへのプラグインの追加方法

WordPressプラグインディレクトリにプラグインを追加する理由

もしあなたが、他の人にも役立つと思うWordPressプラグインを作成したなら、公式のWordPressプラグインディレクトリに追加することを検討すべきです。これは開発者にとって多くのメリットがあります。

プラグインディレクトリは、多くのユーザーが自分のWordPressサイトのプラグインを探す際に最初に目にする場所です。プラグインをWordPressに追加することで、ユーザーが見つけやすくなり、開発者としての信頼性も高まります。

さらに、プラグインをダウンロードするために必要な帯域幅にお金を払う必要がなくなります。WordPressリポジトリは、何人がダウンロードしたかを自動的に追跡し、アップグレードがある場合に通知します。

ディレクトリは、プラグインのサポートにも役立ちます。ユーザーはプラグインを評価したり、フィードバックやバグレポートを残したり、サポートフォーラムを利用したりできます。

WordPress.org の AIOSEO サポートページ

もちろん、いくつかの要件と制限もあります。最初の要件は、プラグインがWordPressと互換性のあるライセンスを持っている必要があることです。GPLv2以降が推奨されます。

考慮すべき倫理的な側面もいくつかあります。プラグインは、違法または道徳的に不快な行為を行ってはならず、ユーザーの許可なしに外部ウェブサイトへのリンクを含めることはできません。

プラグインを送信すると、一般的なエラーや WordPress プラグイン提出ガイドライン への準拠について手動でレビューされます。このプロセスには1日から10日かかる場合があります。

それでは、プラグインをWordPressプラグインディレクトリに追加する方法を見ていきましょう。ここでは、以下の手順を説明します。

上記のクイックリンクを使用して、この記事をナビゲートできます。

ステップ1:プラグインのreadme.txtファイルを作成する

まず最初に行う必要があるのは、プラグインの「Read Me」ファイルを作成することです。プラグインディレクトリのプラグインページに表示され、正しいフォーマットを使用する必要があります。

これは、開始点として使用できるサンプルファイルです。これをテキストエディタに貼り付け、プラグインフォルダにreadme.txtとして保存する必要があります。

=== Your Plugin Name ===

Contributors: Your WordPress.org Username
Tags: wpbeginner, plugin tutorial
Requires at least: 6.0
Tested up to: 6.2
Stable tag: 1.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html

A WordPress plugin to teach beginners how to write a WordPress plugin. 

== Description ==

This simple plugin is part of our beginner's guide to writing a WordPress plugin. 

== Installation ==

1. Upload the plugin folder to your /wp-content/plugins/ folder.
1. Go to the **Plugins** page and activate the plugin.

== Frequently Asked Questions ==

= How do I use this plugin? =

Answer to the question

= How to uninstall the plugin? =

Simply deactivate and delete the plugin. 

== Screenshots ==
1. Description of the first screenshot.
1. Description of the second screenshot. 

== Changelog ==
= 1.0 =
* Plugin released.

WordPressプラグインのreadmeファイルの構文がどのように機能するかを説明しますので、独自のプラグインに合わせてファイルをカスタマイズする必要があります。

最初の行は「プラグイン名」であり、WordPressプラグインディレクトリにプラグインのタイトルとして表示されます。

次の行は「コントリビューター」です。これらは、プラグインの管理を担当するWordPress.orgのユーザーIDです。まだユーザーIDをお持ちでない場合は、無料のWordPress.orgユーザーアカウントを作成する必要があります。

「必須バージョン」と「テスト済みバージョン」のフィールドは、プラグインが動作するWordPressのバージョンを指します。「安定版タグ」は、ご自身のプラグインのバージョンです。

ライセンスフィールドはそのままにしておくことができます。次に、「説明」エリアを編集して、プラグインが何をするのかを説明する必要があります。

プラグインの readme ファイルを編集した後、変更を保存することを忘れないでください。また、公式の Readme Validator でファイルをチェックし、特定された問題に対処することもお勧めします。

最後に、プラグインフォルダを右クリックしてzipファイルを作成する必要があります。Macユーザーは「[プラグイン名]を圧縮」を選択し、Windowsユーザーは「送る » 圧縮 (zip形式) フォルダ」を選択してください。

プラグインフォルダのZipファイルを作成する

ステップ2:レビューのためにプラグインをディレクトリに提出する

これで、プラグインはWordPress.orgのプラグインチームによるレビューの準備ができました。

提出するには、Add Your Pluginページにアクセスしてください。まだログインしていない場合は、画面右上の「Log in」ボタンをクリックしてください。

プラグインを提出するために WordPress.org にログインする

ログイン後、プラグインをアップロードして審査に提出できるようになります。

「ファイルを選択」ボタンをクリックして、プラグインのzipファイルを選択するだけです。次に、該当するすべてのチェックボックスをオンにして、「アップロード」ボタンをクリックします。

WordPress.orgへのプラグインのアップロード

WordPress.orgのプラグインレビューチームが、一般的なエラーやセキュリティチェックのためにプラグインコードを確認します。承認されると、プラグインチームからメールが届きます。

このメールには、プラグインがWordPress.orgでホストされるSubversion(SVN)リポジトリへのリンクが含まれています。プラグインをアップロードする際に、このリンクを使用する必要があります。

ステップ 3: Subversion (SVN) を使用してプラグインをアップロードする

プラグインが承認されたら、Subversion(SVN)を使用してプラグインをアップロードする必要があります。

Subversionはオープンソースのバージョン管理システムです。ユーザーはファイルの変更を記録し、変更を管理し、さまざまなバージョンを管理し、他のユーザーと共同作業することができます。

プラグインをアップロードするには、コンピューターにSVNクライアントがインストールされている必要があります。Windowsユーザーは、SilkSVNまたはTortoiseSVN(無料)を使用できます。Macユーザーは、コンピューターにSmartSVNまたはVersionsアプリをインストールできます。

この記事では、Mac用のVersionsアプリを使用します。ただし、上記でリストされているすべてのSVNアプリで、プロセスは非常に似ています。

インストールが完了したら、Versionsアプリを開き、WordPressプラグインのリポジトリのコピーをチェックアウトする必要があります。これを行うには、単に「New Repository Bookmark」ボタンをクリックします。

新しいリポジトリのブックマーク

これによりポップアップが表示され、まずこのブックマークの名前を入力する必要があります。プラグインの名前にちなんで名前を付けることができます。その後、WordPressプラグインのSVNリポジトリURLを追加する必要があります。

ユーザー名とパスワードのフィールドは空白のままにすることができます。

リポジトリを接続する

次に、「作成」ボタンをクリックします。バージョンがリポジトリと接続され、プラグインのリポジトリのコピーがコンピューターにダウンロードされます。

次に、ブラウザビューでリポジトリ名を右クリックし、「チェックアウト」を選択する必要があります。

リポジトリをチェックアウトする

フォルダの名前を入力し、コンピュータ上のどこに保存したいかを選択するよう求められます。プラグインディレクトリと同じフォルダ名を使用し、「チェックアウト」ボタンをクリックして続行できます。

Versionsアプリが、コンピューター上でプラグインに必要なフォルダーを作成します。プラグインのリポジトリで表示するか、Finderで参照できます。

Finderでローカルリポジトリを表示

次に、プラグインファイルをコピーして、ローカルリポジトリのtrunkフォルダ内に貼り付けます。

そのようにすると、Versionsアプリの新しいファイルの横に疑問符のアイコンが表示されることに気づくでしょう。

これらのファイルは以前は存在しなかったため、追加する必要があります。新しいファイルを選択し、「追加」ボタンをクリックして、これらのファイルをローカルフォルダに追加します。

ファイルを追加

プラグインファイルがSubversionに追加されたので、アップロードする準備ができました。これは、ローカルフォルダとSubversionディレクトリの変更を同期することによって行います。

ローカルリポジトリをクリックして選択し、「コミット」アイコンをクリックしてください。

変更をコミット

新しいポップアップが表示され、変更点のリストとコミットメッセージを追加するボックスが表示されます。

「コミット」ボタンをクリックすると、Versionsアプリが変更を同期し、プラグインのリポジトリにコミットします。

コミットメッセージの追加

プラグインファイルをトランクにアップロードしたので、バージョンにタグ付けする時期です。

プラグインのローカルコピーに移動し、trunkフォルダー内のファイルをコピーします。その後、tagsフォルダーを開き、その中に新しいフォルダーを作成する必要があります。

このフォルダにはバージョン名を付けてください。プラグインのヘッダーに入力したバージョンと一致していることを確認してください。上記のサンプルコードでは、プラグインにバージョン 1.0 を使用しています。

1.0フォルダを追加した後、その中にプラグインファイルを貼り付ける必要があります。これは新しいフォルダなので、フォルダとそのすべてのファイルをリポジトリに含めるために「追加」ボタンをクリックする必要もあります。

ファイルを追加

その後、「コミット」アイコンをクリックして、先ほど行ったように変更を同期できます。これでWordPressプラグインディレクトリにアクセスして、プラグインをプレビューできます。

プラグインファイルを編集する必要があるときはいつでも、ローカルコピーを編集してください。変更が完了したら、「コミット」アイコンをクリックしてWordPressプラグインディレクトリと同期するだけです。

プラグインに大きな変更を加えた場合は、tagsフォルダにそのバージョン番号を持つ新しいフォルダを追加して、新しいバージョンを追加する必要があります。バージョン番号がプラグインのヘッダーと一致していることを確認してください。

ステップ4:WordPressプラグインディレクトリにアートワークを追加する

MonsterInsightsプラグインのバナー画像

次に、WordPressプラグインディレクトリにアートワークやスクリーンショットを追加できます。これらの項目は標準的な命名規則に従う必要があり、Subversionを使用してアップロードする必要があります。

プラグインヘッダーバナー

ヘッダーバナーは、プラグインページの上部に表示される大きな画像です。サイズは772×250ピクセルまたは1544×500ピクセルで、JPEGまたはPNGファイル形式を使用してください。

画像のサイズとファイルの種類によっては、ヘッダーバナーに次のいずれかの名前を付ける必要があります。

  • banner-772×250.jpg
  • banner-772×250.png
  • banner-1544×500.jpg
  • banner-1544×500.png

プラグインアイコン

アイコンは小さな正方形の画像で、検索結果やプラグインの一覧に表示されます。サイズは128×128ピクセルまたは256×256ピクセルで、JPEGまたはPNGファイル形式を使用してください。

画像のサイズとファイルの種類に応じて、アイコンに次のいずれかの名前を付ける必要があります。

  • icon-128×128.jpg
  • icon-128×128.png
  • icon-256×256.jpg
  • icon-256×256.png

スクリーンショット

好きなだけスクリーンショットを追加できます。これらのスクリーンショットは、readme.txtファイル内のスクリーンショットの説明に記載する必要があります。

スクリーンショットファイルは次のように命名してください。

  • screenshot-1.png
  • screenshot-2.png

すべてのアートワークを準備したら、プラグインのローカルコピーのassetsフォルダに配置できます。

その後、アセットフォルダの横に疑問符アイコンが表示されます。リポジトリに新しいアセットファイルを追加するには、「追加」ボタンをクリックする必要があります。

アセットを追加

最後に、「コミット」アイコンをクリックして、ファイルをWordPressプラグインディレクトリにアップロードしてください。

しばらくすると、アートワークがプラグインページに表示されるようになります。

変更をコミット

ボーナス:WordPressプラグイン開発者向けリソース

WordPress開発の旅をさらに進めたい方のために、役立つリソースをいくつかご紹介します。

このチュートリアルで、WordPressプラグインディレクトリにプラグインを追加する方法を学べたことを願っています。また、おすすめのWordPress開発会社や、iPhone、iPad、AndroidでWordPressアプリを使用する方法に関する究極のガイドもぜひご覧ください。

この記事が気に入ったら、WordPressのビデオチュートリアルについては、YouTubeチャンネルを購読してください。 TwitterFacebookでもフォローできます。

開示:当社のコンテンツは読者によってサポートされています。これは、当社のリンクの一部をクリックすると、当社が手数料を得る可能性があることを意味します。WPBeginnerがどのように資金提供されているか、それがなぜ重要か、そしてどのように私たちをサポートできるかについては、こちらをご覧ください。当社の編集プロセスはこちらです。

究極のWordPressツールキット

無料のツールキットにアクセスしましょう - すべてのプロフェッショナルが持つべきWordPress関連の製品とリソースのコレクションです!

読者とのインタラクション

18 CommentsLeave a Reply

  1. アイコンのサイズにタイポがあります。ファイル名は正しいですが、実際の画像寸法は150×150ではなく128×128、250×250ではなく256×256です。

  2. リポジトリにプラグインを追加するという、私にとってはかなり複雑なプロセスを、あなたは素晴らしい説明をしてくれました。まだ自分でプラグインを作成したことはありませんが、このプロセスがどのように機能するかを知るために、主にこの記事に興味がありました。また、プラグインがセキュリティ上の欠陥や問題についてテストされているかどうかにも非常に興味がありました。あなたはそれを非常によく説明してくれました。どうもありがとうございます。

  3. プラグインディレクトリにアップロードするための簡単なプラグインを作成しました。このガイドは、承認を得るために正しくアップロードするのに役立ちますが、まだreadmeファイルを作成していません。ここで提供されたフォーマットを使用します。ありがとうございます。

  4. ありがとうございます!
    初めてのプラグインをアップロードする際に問題を解決するのを手伝っていただきました。あなたのガイドはコマンドラインを使うよりもずっと簡単でした。
    これは数ヶ月前にあなたの記事を基に承認された私の新しいプラグインです。

  5. プラグインが初めてアップロードされた後、どうなりますか? Wordpress.orgで見つけて、Wordpressプラグイン検索から直接ダウンロードできるようになるまで、どのくらい待てばよいですか?

    素晴らしい記事をありがとうございます!

  6. Tortoise の SVN Commit オプションを使用してプラグインファイルをアップロードしようとしたところ、次のエラーが発生してコミットがブロックされました。「変更内容を説明するコミットメッセージを提供してください。」

    コミットダイアログの「メッセージ」ボックス(「最近のメッセージ」ボタンの下)に「最初のコミット」と入力することで簡単に修正できました。

    チュートリアルをありがとうございます!

  7. WordPressプラグインを作成しました

    wordpress.orgにホストしたい

    ライセンスの値はいくらにすべきか、誰か教えていただけますか?

    無料にしたい

    readme.textファイルにライセンスとして何を書くべきか

  8. これに関する簡単なチュートリアルが見つかればいいのにと思います。誰も本当に簡単に説明したがらないようです。新しいことをしているときにイライラするのは嫌いです。

  9. @mrahmadawais 初めての場合は、すべてのフォルダを SVN します...タグ、トランク、ブランチ...

    ただし、それが完了したら、必要な変更のみをコミットする必要があります。

  10. SVN経由でアップロードする場合、最後のステップについて誰か詳しく説明してもらえますか?何をどのフォルダにアップロードすればよいですか?

  11. これ、ありがとう!私のプラグイン (http://casadeblundell.com/jonathan/wordpress/) を最初にアップロードするのに大変苦労しました。最後にアップグレードした後、最新バージョンを投稿できなくなりました。

    これをじっくり見て、何が足りないのか確認する必要があります。ただし、唯一の実際の変更点は、プラグインが最新の WordPress バージョンで動作することです。

返信する

コメントを残していただきありがとうございます。すべてのコメントは、当社のコメントポリシーに従ってモデレーションされますので、ご了承ください。メールアドレスは公開されません。名前フィールドにキーワードを使用しないでください。個人的で有意義な会話をしましょう。