WordPress にプラグインとして認識させるコメントヘッダの書き方

WordPress のプラグイン開発の際、ヘッダの記載は最初に認識しておくべき内容です。

プラグインとして認識させる1行のヘッダ情報

WordPress へプラグインとして認識させるには、PHP ファイルにコメントの記載が必要です。

<?php
/*
 * Plugin Name: My Plugin
 * /

以上です。

PHP ファイルにコメントで、「Plugin Name: ◯◯プラグイン」と記載するだけでそのファイルをプラグインとして認識されます。

プラグインが認識されるか確認

WordPress の wp-content/plugins ディレクトリに新規ディレクトリを作るか、もしくはコメントを書いた PHP ファイルをディレクトリを含んだ ZIP ファイルにして WordPress に追加してみてください。

ヘッダコメントを書いただけの PHP ファイルでも、WordPress はプラグインとして認識してくれます。

もちろんヘッダだけでは中身がないので動作はしませんが、プラグイン開発の全てはこのヘッダから始まります。

参考

今回の内容ですがプラグインスターターキットを使用すれば、ヘッダ周りの知識なしでもジェネレータが自動生成してくれます。ジェネレータでプラグインソースを生成して中身の確認をしてみると参考になります。

最速でWordPressのプラグイン雛形・スタータキットを作る

WordPress のプラグイン開発をはじめたい方向けの記事です。

  • 新しくプラグイン開発をしたい
  • プラグインのカスタマイズをしたい

みたいに方にメリットとなる内容です。最速と書いたのですが、ジェネレータで雛形を作ると本当に速いです。プラグイン作成に5分もかかりません。

プラグインの雛形をジェネレータで作成

WordPressプラグインという色々なファイル構成や関数を学ばなければならないかと思うかもしれません。

しかし、今時はジェネレータが用意されています。ジェネレータを使えばあっさりプラグインの雛形、スターターキットを生成できます。

このようなプラグインジェネレータサービスがあるので利用しましょう。
フォームに名前など情報を入力するだけで、プラグイン開発ができてしまいます。

あとは、お好きな WordPress 環境で確認してください。管理画面にプラグインが表示されます。