WordPressのプラグインを作成する方法

2019-10-29WordPress

WordPressにはプラグインと呼ばれる標準ではできない機能を独自にプログラミングして追加できる機能があります。

WordPressのプラグインは全世界のエンジニアが有益なものを数多く作成されているので、ほとんど自作することはないですが、どうしてもやりたいことができない場合はプラグインを自作することができます。

自作すると言っても基本は難しくなくプログラムを作成するだけです。

今回は指定された生年月日から現在何歳なのかを自動で計算して表示するプラグインを作成してみます。

WordPressプラグインの作り方

先ほど書きましたが、プラグインを作成するにはソースコードを記述する必要があります。

PHP自体はそれほど難しくはないのですが、WordPressプラグインを作る場合はちょっとしたお作法を守る必要があります。

WordPressプラグイン作成のお作法
  1. 保存するファイルの漢字コードはUTF-8
  2. 決まったヘッダー情報を書く
  3. アップロードするフォルダーはwp-content/plugins/独自プラグインのフォルダー/配下
守るポイント

です。

保存するファイルの漢字コードはUTF-8

実際にプラグインのファイルは公式で公開しないのであれば、該当のソースファイルを準備するだけでOKです。

ただし、ファイルを保存する漢字コードは「UTF-8」のみです。

決まったヘッダー情報を書く

WordPressプラグイン作成にはルールがあり、ソースファイルに決まったヘッダーコメントを記述する必要があります。

これを守らなければ、作成したソースコードが文法的な間違いがなくてもWordPressの管理画面にある「プラグイン」の箇所に表示されません。

ヘッダー情報の内容は以下の通りです。

<?php
/*
Plugin Name: プラグイン名
Plugin URI: 
Description: プラグインの機能
Version: プラグインのバージョン
Author: 編集者
Author URI: プラグイン作者のURI
License: GPL2
*/
?>
<?php
/*  Copyright 制作年 制作者 (email : メールアドレス)
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License, version 2, as
     published by the Free Software Foundation.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
?>

上記をソースヘッダーとしてファイルの先頭に対追加するのですが、以下の項目を編集しなければなりません。
編集が必要なのは以下の部分です。

ヘッダー情報の変更箇所
  1. Plugin Name: プラグイン名
  2. Description: プラグインの機能
  3. Version: プラグインのバージョン
  4. Author: 編集者
  5. Author URI: プラグイン作者のURI
  6. 制作年: プラグインの制作年
  7. 制作者: プラグインの制作者
  8. メールアドレス: 制作者のメールアドレス
変更箇所

※上記以外の箇所を変更してはいけません。
※ライセンスはGPL2にする必要があります。

今回は以下のように編集しました。

<?php
/*
Plugin Name: trust_getAge
Plugin URI: 
Description: 指定された生年月日から現在日付での年齢を計算する
Version: 1.0.0
Author: SystemTrust
Author URI: https://sytem-trust.com
License: GPL2
*/
?>
<?php
/*  Copyright 2019 SystemTrust (email : info-manager@system-trust.com)
  
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License, version 2, as
     published by the Free Software Foundation.
  
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
  
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/
?>

その他の注意としてはプラグイン名はすでにあるプラグインをぶつからないようにすることが求められます。
方法として自分だけの独自な接頭語を付けるなどして対応しましょう。

ソースコード

実際のソースコードは、ヘッダーコメントを書いたファイルに追記します。

今回は指定された生年月日から本日時点の年齢を計算する処理をショートコードで呼び出せるようにします。

<?php
function trust_getAge( $birthday )
{
    extract(shortcode_atts(array(
        'birthday' => date('Ymd'),
    ), $birthday));

    $now = date('Ymd') ;
    return floor(($now-$birthday)/10000);
}
add_shortcode('tst_getAage', 'trust_getAge');
?>

ソースコードは以上です。

ファイルのアップロード

作成したプラグインをWordPressに登録するには「WordPressインストールフォルダー/wp-content/plugins」にフォルダーを作成します。
作成したフォルダーにソースファイルをアップロードします。

アップロード後、管理画面の「プラグイン」開くと自分の作ったプラグインが登録されているはずです。
独自に作成したプラグイン設定画面

これで通常のプラグインと同様に「有効化」することで利用できるようになります。

呼出方法は以下の通りで

技術部社員Xさんの年齢は[tst_getAage birthday='19660805']歳です。

呼び出した結果は

技術部社員Xさんの年齢は53歳です。

になります。

まとめ

WordPressのプラグインを作成するのは難しそうですが、ルールさえ守れば簡単に作成することができます。

やりたい機能ができない時は自分でプラグインを作成してみるのもひとつの手段ですね。

以上、WordPressのプラグインを作成する方法でした。