WordPressプラグイン開発記 vol.2 – プラグインヘッダーの書き方と有効化

このサイトはアフィリエイト広告(Amazonアソシエイト含む)を掲載しています。
ノートパソコンにWordPressの管理画面を描いたイラスト

前回の記事で自分のPC上で動くWordPressが準備できたので、本格的にプラグインの作成に入っていきます😆

今回作っていくプラグインは具体的に〇〇するためのプラグインというより自分用のいろいろカスタマイズなのでChun Log Customizeと命名します!

今回はプラグイン用のPHPファイルを作り管理画面の一覧に表示して有効化するところまで進めます。ヘッダーコメントで最低限必要なのはPlugin Nameです。具体的な機能は次回から追加していきます。

目次

WordPressにプラグインを認識させる

プラグイン用のPHPファイルを配置する

WordPressにプラグインを認識させるにはプラグイン用のPHPファイルにPlugin Nameを含むヘッダーコメントを記載します。今回はあとからファイルを増やしやすいように専用ディレクトリを作ります。

  1. wp-content/plugins/配下にプラグイン専用ディレクトリを作成する。
  2. その中にPHPファイルを作成して先頭にプラグイン用のヘッダーコメントを記載する。

PHPファイルをwp-content/plugins/直下に置く構成でも認識されますが、今回は専用ディレクトリにまとめて進めます。

今回はChun Log Customizeというプラグインを作っていくのでディレクトリ名・ファイル名ともにchun-log-customizeにしました。

ファイル・ディレクトリ構成

前回作成したDocker環境ではPC側のD:/wordpress/wordpress_files/がWordPressの配置先です。ここからwp-content/plugins/を開きます。別の環境を使っている場合は、WordPressを設置したフォルダー内のwp-content/plugins/に読み替えてください。

D:/wordpress/wordpress_files/
 ├wp-admin/
 ├wp-content/
 │ ├languages/
 │ ├plugins/
 │ │ └chun-log-customize/
 │ │   └chun-log-customize.php   ← ここが今回作るファイル
 │ ├themes/
 │ ├upgrade/
 │ ├uploads/
 │ │
 ├wp-includes/
 │

最小限のヘッダーコメント

続いてchun-log-customize.phpに最小限のプラグイン用のヘッダーコメントを記載します。

chun-log-customize.php
<?php
/*
 * Plugin Name: Chun Log Customize
 */

たったこれだけでインストール済みプラグインの画面でこのように認識されました!

WordPressのプラグイン一覧にChun Log Customizeが表示され、有効化リンクがある状態
Plugin Nameだけを記載したPHPファイルが、プラグイン一覧に表示されました。

プラグイン一覧に表示されないとき

作成したプラグインが一覧に出ない場合は次を確認してみてください。

  • ファイル名が(今回の例では)chun-log-customize.phpになっているか。末尾に.txt等の余計な拡張子が付いていないか。
  • PHPファイルの先頭に<?phpと、Plugin Name:を含むヘッダーコメントがあるか。
  • 保存先がwp-content/plugins/chun-log-customize/chun-log-customize.phpになっているか。
  • Dockerを使っている場合編集したファイルがWordPressコンテナからも参照できる場所にあるか。

wp-content/plugins/chun-log-customize/chun-log-customize/chun-log-customize.phpのようにフォルダーが二重になっていると通常のプラグイン一覧では認識されません。保存先を直してから管理画面の一覧を再読み込みしてください。

ヘッダーコメントをもう少し充実させる

最小限の状態だと管理画面の表示が少し寂しいので、よく使われる項目を追加してみます。

chun-log-customize.php
<?php
/*
 * Plugin Name:       Chun Log Customize
 * Plugin URI:        http://localhost/chun-log-customize/
 * Description:       chun-log用にWordPressに機能を追加するプラグインです。
 * Version:           0.0.1
 * Author:            chun-log
 * Author URI:        https://chunlog.jp/
 */

このようにヘッダーコメントを変更することで、表示がちょっとソレっぽくなりました。

Chun Log Customizeの説明、バージョン0.0.1、作者、プラグインサイトへのリンクが表示された一覧
ヘッダー項目を追加すると、説明・バージョン・作者情報も一覧に表示されます。
Plugin Name

この項目だけは必須です。そのまんまですが、プラグインの名称です。管理画面のプラグインリストに表示されます。

Plugin URI

プラグインのサイトがあればURLを指定することでプラグインリストにプラグインのサイトを表示のリンクで表示されます。WordPress.orgのURLは使用できません。

Description

管理画面のプラグイン一覧に表示する説明文です。公式ガイドでは140文字未満で簡潔に記載するよう案内されています。

Version

プラグインの現在のバージョン番号です。バージョンアップの際はPHPのversion_compare()関数で新しいバージョンと認識されるような注意が必要みたいです。※1

Author

プラグイン作者の名前です。カンマを使って複数の作者を列挙できます。

Author URI

作者のWebサイトやWordPress.orgのようなWeb サイト上のプロフィールのURLを指定できます。プラグインリストのプラグイン作者の箇所にここで指定されたURLがリンク先に設定されます。※2

(※1)

プロジェクトにバージョン番号を割り当てる際には、WordPress はプラグインのバージョン番号を比較するために PHP の関数 version_compare() を使うことを覚えておいてください。よって、プラグインの新バージョンをリリースする前に、この PHP 関数が新バージョンを旧バージョンより「大きい」とみなすかどうかを確認する必要があります。たとえば、1.02は1.1よりも実際には大きいのです。

ヘッダーの必要条件 – Japanese Team – WordPress.org 日本語

(※2)

Authorはカンマ区切りで設定可能ですが、Author URIは1つしか認識しません。これは「そのプラグインの代表的な作者(または組織)のサイト」を指すものと想定されているためのようです。
Authorに<a href="http://localhost/user/a">Author A</a>, <a href="http://localhost/user/b">Author B</a>のようにタグごと記載、Author URIは省略するという手法でプラグインリスト内のそれぞれのプラグイン作者にリンクを貼ることは可能です。

その他ヘッダーコメントに設定可能な項目

今回は配布予定がないプラグインのため簡単なものだけ設定しましたが、他にも下記のような項目が設定可能です。公式ドキュメントもどうぞ。

Requires at least

プラグインが動作するWordPressの最低バージョンです。

Requires PHP

プラグインが動作するために最低限必要な PHP のバージョンです。

License

プラグインの配布ライセンスをGPLv2 or later等の短い名前(スラッグ)で指定します。WordPress自体がGPLライセンスなので、公式ディレクトリに登録する場合は「GPL互換」である必要があります。

License URI

ライセンス全文が記載されたWebページのURLを指定します。

Text Domain

プラグインの翻訳に使う識別名です。プラグインのスラッグに合わせ今回ならchun-log-customizeとすると日本語翻訳ファイルはchun-log-trans-ja.mo、英語翻訳ファイルはchun-log-trans-en_US.moとなります。翻訳用の関数でも同じ名前を使います。ヘッダーに記載するだけで本文や画面の文字が自動的に翻訳されるわけではありません。そしていろいろ書きましたが今回は国際化は考えていません。

Domain Path

こちらも国際化の設定で、上述の翻訳ファイルがある場所を指定します。一般的には/languagesとするようで、これはプラグインディレクトリー内のlanguagesを参照します。

Network

WordPressの「マルチサイト」機能を使っている場合に使用する項目です。trueに設定するとこのプラグインはサイトネットワーク管理者だけが有効化できるようになり、個別のサイト管理者は勝手にON/OFFできなくなります。

Update URI

WordPress.org以外で配布するプラグインが同じスラッグの別プラグインで誤って上書き更新されるのを防ぐための項目です。

GitHubなどで配布する場合はそのプラグインを識別できるURLを指定できます。URLを書くだけでGitHubから更新されるわけではなく、更新情報を取得する処理が別途必要です。

今回のように自分用で更新配信を行わないプラグインではUpdate URI: falseを指定する方法もあります。WordPress.orgで配布するプラグインでは通常はこの項目を省略します。

プラグインを有効化する

それではプラグインリストで有効化を押してみましょう!

プラグインを有効化しましたという通知と、Chun Log Customizeの無効化リンクが表示された画面
「無効化」のリンクが表示され、有効化できたことを確認できます。

無事有効状態になりました🎉🎉🎉 まだ何も機能をつけていないのでなーんにも変わりませんが。



WordPressプラグイン開発の環境構築や機能実装、WordPress本体の新機能を続けて確認したい場合はまとめページから探せます。

  • URLをコピーしました!
目次