ブログ

WordPress のプラグインを作る為にまずすべき第1歩

plugin

WordPressでは、プラグインにより新しい機能を各ユーザーが自由に追加できるようになっています。
その多くは公式ディレクトリから検索し自由に導入することができるようになっていますが、独自のプラグインを作成することもあるでしょう。

プラグインといえば、wp-content/plugins の下に専用のフォルダ(ディレクトリ)を作っているイメージも強いと思いますが、実は必ずしも専用のフォルダ(ディレクトリ)を作る必要はなく、1ファイルだけで実装可能な場合は、plugins 直下に置いてもプラグイン一覧から確認し、有効化して動作させることができます。
なぜ一般には専用のフォルダ(ディレクトリ)を設けているかといえば、WordPress の公式プラグインディレクトリの仕様上そのようになっているという一点に尽きてしまいますが、別の理由としては動作に必要なライブラリ類や関連するファイル(画像やスタイルシート、スクリプトなど)があり、関連する一式として管理する目的もあるためと考えられます。

プラグインとして動作させるために必要なものは、PHPのプログラムと、プログラムの先頭に所定の形式でコメントがあることです。

たとえば、ランキングプラグイン「WP-Ranking PRO」では、中心となるPHPプログラム wp-ranking-pro.php の先頭には以下のように指定しています。

 

<?php
/**
 * Plugin Name: WP-Ranking PRO
 * Plugin URI: https://plugmize.jp/product/wp-ranking-pro
 * Description: "WP-Ranking PRO" totals a page view, and into which a popular article can be formed by various elements or periods.
 * Version: 1.0.0
 * Author: PLUGMIZE
 * Author URI: https://plugmize.jp/
 * Text Domain: wp-ranking-pro
 * Domain Path: /languages
 */

 

要するに、「標準プラグイン情報」と呼ばれる、指定された形式で、ブロックコメントによりプラグイン名や説明文、バージョン等が指定されていることとなります。

ここで指定できるプラグイン情報の種類とその内容は以下のようになっています。

Plugin Name プラグインの名前
Plugin URI プラグインの説明と更新を示すページのURI
※URLではなくURIであることに注意
Description プラグインの短い説明
Version プラグインのバージョン番号(例: 1.0、1.0.0 など)
Author プラグイン作者の名前
Author URI プラグイン作者のURI
License プラグインを提供するライセンスの名称(例: GPLv2 など)
License URI プラグインを提供するライセンスの条文のURI
Text Domain プラグインを国際化するためのTEXTドメイン名
Domain Path プラグインを国際化するための翻訳ファイルのパス

(参考:https://developer.wordpress.org/plugins/the-basics/header-requirements/

 

最低限、プラグイン名、説明、バージョン番号があれば、それ以外のものは記載がなかったり未記入であっても、動作に支障なく動作すると思いますので、試験的に作成する際はすべて決めることなく、最小限の指定を行ってからプラグインの作成を行うと良いでしょう。

ちなみに、URL ではなく URI という表現になっていますが、これは、インターネット上の住所を示す概念の考え方によるもので、それぞれ「URL」は Uniform Resource Locator、「URI」はUniform Resource Indentifier の略となっています。この違いは、URL は場所を示す書き方を定めたもの、URI はそれらの名前や場所を識別するための基本ルールとなっていて、URL は URI の概念に含まれています。従って、名前や場所を識別するという意味から、URI という表現が適切という解釈になっているものと考えられます。

また、Description は「短い説明」とされていますが、長い説明文を記入する場所が別にあるためで、WordPress の公式プラグインディレクトリで公開されているプラグインの概要タブの内容がそれにあたります。この指定は、readme.txt に専用のフォーマットで作成の上で公式ディレクトリで公開すると表示されるようになります。

関連記事

WP-Ranking PRO
ページ上部へ戻る