WordPressプラグイン開発！初心者からでも始められる、開発基礎知識編

いきなりはじめるPHP~ワクワク・ドキドキの入門教室~

posted with カエレバ

谷藤賢一リックテレコム 2011-12-09

エンジニアのためのWordPress開発入門 (Engineer’s Library)

カンタンなWordPressプラグインを作る

では、実際に超カンタンなプラグインを作ってみましょう。
意外とすぐに作れますよ！

WordPressのインストールフォルダの
「wp-content/plugins」フォルダの中に、
プラグイン名を付けたフォルダ（「testplugin」など）
を作って、その中にphpファイル（「testplugin.php」など）を置きます。

ファイル名、フォルダ名は任意です。
phpファイルに以下のようなコメント記述があれば、プラグインとして認識してもらえます。

<?php
/*
Plugin Name: (プラグインの名前)
Plugin URI: (プラグインの説明と更新を示すページの URI)
Description: (プラグインの短い説明)
Version: (プラグインのバージョン番号。例: 1.0)
Author: (プラグイン作者の名前)
Author URI: (プラグイン作者の URI)
License: GPL2

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
*/
?>

上記のコメント内の日本語のところ、すべてを必要な記述に書き換えます。
基本的には英語で書くべし、なんですが、とりあえず日本語でも大丈夫。
ファイル形式はUTF-8にしましょう。

すると、インストール済みプラグインの一覧に登場します。

これを有効化すれば、自分の思った通りの処理が実現できるわけです！
夢が広がりますね。

WordPressプラグインの処理を実装する

で、ごく簡単な処理を実装してみます。
管理画面の上部に、適当な文字列を表示させる、という処理。

WordPressにデフォルトで入っている「Hello Dolly」とほぼ同じ機能ですが。

その処理がこんな感じ。

<?php
/*
Plugin Name: testplugin
Plugin URI: http://hoge.com
Description: test
Version: 1.0
Author: densuke
Author URI: http://hoge.com
License: GPL2

Copyright 2018 densuke (email : hoge@hoge.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
*/

if( !class_exists('densuke_class') ){
    class densuke_class{
        private $myparam = 'my first plugin!!';
 
        function __construct() {
	        add_action( 'admin_notices', array($this , 'myfunction') );
        }
 
        function myfunction(){
            echo '<p class="testplugin">' . $this->myparam . '</p>';
        }
    }
    $densuke_instance = new densuke_class();
}

?>

「admin_notices」というアクションに、「myfunction」関数を「フック」しているわけですね。

アクションの登録に

add_action( 'admin_notices', array($this , 'myfunction') );

という指定の仕方をしていますが、クラス内に定義した関数を指定する場合は、

array(クラスのインスタンス, 関数名文字列)

という形式で引数に渡さないといけません。
同一クラス内では、インスタンスを「$this」で表現できるので、上記のような記述になるわけです。

ということで、上記のように実装すると、管理画面でこんな表示が出てきます。

これで、WordPress管理画面にずっと「my first plugin!!」が表示されるという、とてもうっとうしいプラグインを作れました！やったね！

まとめ

ということで、WordPressプラグインの実装、基礎知識編でした。

実装したい処理を「フックする」ことで、様々なタイミングで機能を実装することができます。
名前の衝突を考慮しながら実装していきましょう。

「plugins」フォルダにphpファイルを置いて、
コメントで必要な情報（プラグイン名など）を書いておけば、
それだけでプラグインと認識してもらえるので、
あとは処理を書いていくだけです。

次回は、より具体的な実装方法を書いていこうと思います。

それではまたー。

posted with カエレバ

野島祐慈,菱川拓郎,杉田知至,細谷崇,枢木くっくる技術評論社 2017-01-26

WordPressプラグイン & WebAPI 活用ガイドブック [Version 3.x対応]

posted with カエレバ

星野邦敏,西川伸一翔泳社 2013-01-29