web-dev-qa-db-ja.com

WordPressリポジトリにプラグインを追加するにはどうすればいいですか?

私は私の最初のプラグインを作りました、そしてそれはWordPressによって承認されました。私にとっては素晴らしいニュースですが、今はどうしたのですか。コーデックスの「指示」は私にとっては明らかなものです。 Dig WP に関する記事を見つけたので、3行目のコードにたどり着きました。それから喜びはありません。

本書全体を読む必要なしにこれを行う方法について明確な指示がありますか?私はここにいつもこのようなことをしている非常に経験豊富な人々がいることを確信しています...

前もって感謝します!

11
user2015

ステップ1 - ものが正しくフォーマットされていることを確認してください

WordPress自体は、メインプラグインファイルの先頭にあるヘッダーに依存しています。多くの場合、あなたのプラグインが "My Cool Plugin"の場合、このファイルはあなたのフォルダのメインディレクトリにあるmy-cool-plugin.phpです。ファイルの上部がこのフォーマットに従っていることを確認してください。

<?php
/*
=== [Plugin Name] ===

Plugin Name: [Plugin name]
Plugin URI: [Website where plugin information can be found - your blog, maybe]
Description: [Short description of your plugin]
Author URI: [Your website]
Author: [Your name]
Version: [This version number]
*/

WordPress.orgリポジトリはあなたのreadme.txtファイルに依存して説明とダウンロードページを作成します。それで、あなたのreadme.txtファイルが以下のフォーマットに合うことを確かめてください:

=== [Plugin Name] ===
Contributors: [Your WordPress.org username]
Donate link: [A site people can go to to give you money]
Tags: [Search terms related to your plugin]
Requires at least: [Minimum version of WordPress required]
Tested up to: [Newest version of WordPress you've tested with]
Stable tag: [This version number]

[Short, one-sentence description of your plugin]

== Description ==

[Long description of your plugin]

== Installation ==

[Steps required to install the plugin]

== Frequently Asked Questions ==

= [A question] =

[An answer]

= [Another question] =

[Another answer]

== Screenshots ==

== Changelog ==

== Upgrade Notice ==

WordPress.orgには便利な readmeバリデーター があり、あなたのreadmeに必要なものがすべて揃っていることを確認するために使うことができます。コピー&ペーストするだけで、すべてのセクションがそこにあることと、準備ができていることを確認できます。

ステップ2 - SVNリポジトリをチェックする

開発バージョンをWordPress.orgプラグインリポジトリとは別にすることをお勧めします。はい、SVNはバージョン管理に使用されますが、WordPressはそれをリリース管理に使用します。すべてのチェンジセットをリポジトリにコミットし始めると、問題が発生する可能性があります。多くの開発者がしていることの1つは、Gitを使用してローカルに開発してから、リリースを行う準備が整ったら、ファイルをSubversionリポジトリに転送することです。

これらの手順は、Windowsコンピュータを使用していることを前提としています。 Macを使用している場合は、TortoiseSVNの代わりに SCPlugin を使用できます。従う必要がある手順は同じですが、コンテキストメニューとスクリーンショットだけがUIのためにわずかに異なります。私はMacを持っていないので、チュートリアルを進めるためのスクリーンショットを作成することはできません...しかし、私を信頼してください、それは同じプロセスです。

まだ持っていなければTortoiseSVNをインストールしてください。

TortoiseSVN はWindows用のオープンソースのSubversion GUIです。私を信頼してください、GUIを使うことはコマンドラインから物事をやろうとするより無限に簡単です。問題も少なくなります。

WordPressがホストするSVNリポジトリを調べてください。

WordPressがホストするバージョンのプラグインを保存する場所を見つけます。デフォルトでは、ホストされているすべての開発作業に/My Documents/WordPress/を使用します。フォルダ内を右クリックして、ドロップダウンメニューから[SVN Checkout]を選択します。

TortoiseSVN Contextual Menu

表示されたダイアログウィンドウで、WordPress.orgのプラグインリポジトリのURLを入力し(デモ目的で使用しています)、作成したいサブフォルダを選択します。

Checkout Dialog

Tortoiseは少し考えてから、WordPress.orgからリポジトリを取得します。新しく作成されたフォルダには、必要なフォルダがすべて用意されています。コピー&ペーストしてコミットするだけです。

最新版を/tagsにコピーしてください

これは私がほとんどのチュートリアルから後ろに物事をするところです。他の誰もが最初に/trunkをコミットするようにあなたに言うでしょう、しかしWordPressがプラグインを見るときreadmeファイルを除いて何も/trunkの中で使用しないことを覚えていてください。そのため、タグをコミットする前にプラグインを/trunkに挿入してネットワーク接続を失った場合(または他の問題が発生した場合)、問題が発生します。

/tagsフォルダーに、プラグイン用にリリースしているバージョンと同じ名前のフォルダーを作成します。あなたがバージョン0.1をリリースしているのであれば、/tags/0.1フォルダを作成してください。

Repository Tags Folder

プラグイン全体をこのフォルダにコピーしてください。

フォルダ内を右クリックして、ドロップダウンメニューから[SVN Commit]を選択します。

すべての変更を示すウィンドウがポップアップ表示されます(新しいファイルはすべて「バージョン管理されていない」とマークされているはずです)。

Commit Window

プラグインのすべてのファイルの横にあるチェックボックスをオンにします(または[すべて選択]をクリックしてすべてのファイルを選択します)。

上部のボックスにコミットメッセージを入力します。タグをコミットしているので、おそらく次のようにします。

[My Plugin]のタグ付けバージョン0.1。

OKをクリックしてください。

繰り返しになりますが、Tortoiseは数分間考えてから、サーバーにコミットするためにWordPressのユーザー名とパスワードを尋ねます。それらを提供し、物事が通過するのを待って「成功」と言ってから、次のステップに進みます。

最新版を/trunkにコピーしてください

リポジトリの/trunkフォルダに移動して、もう一度そのフォルダにプラグインをコピーアンドペーストします。上記と同じ手順を実行してファイルを選択し、コミットを準備してください。しかし、メッセージについては、新しいリリースが何をするのかを説明する何かを使用してください。

[My Plugin]のバージョン0.1 - OpenIDのサポートを追加。

すべてが終わったら、WordPress.orgのサーバーが追いつくのを待つ必要があります。それらは他のものより何日か遅いかもしれませんが、1時間かそこら以内にあなたはあなたの新しいリリースをリポジトリに見るべきです。

プラグインを新しいバージョンに更新する

プラグインが公開されたら、アップデートの準備は比較的簡単です。

まず、SVN Updateコマンドを使用して、最新バージョンのリポジトリがあることを確認します。あなたが唯一の開発者であれば、あなたはすでにすべきですが、とにかくコミットする前に更新するのは良い習慣です。

次に、上記の手順を実行して、新しいバージョン用に新しいサブフォルダーを/tagsに作成します。 /tags/0.2と言います。古い/0.1フォルダに触れないでください。それは理由でそこにあり、あなたは二度とそれに触れることは決してないだろう。

新しいタグを確定してから/trunkフォルダに移動します。 /trunk内のすべてを新しいバージョンに置き換えて、上記のようにコミットします。サーバが更新されると、古いバージョンではなく新しいバージョンについて話を始めます。

12
EAMann