wordpressプラグインの作成方法(初期設定)





一番単純で簡単に何もしないwordpressのプラグインの作成方法について。

前提条件と前提となる知識

とりあえず前提条件としてはこんな感じでしょうか。

  • サーバとかウェブサイトとかの概念が分かる。
  • wordpressはインストール済みで基本的な設定も完了している。
  • wordpressがインストールされているサーバにftpなどでログインして、サーバ内のフォルダを作ったり、ファイルを編集できる。
  • 文字コードがUTF-8のテキストファイルを編集できるテキストエディタが使える。個人的にはSublimeTextがおすすめ。単純なやつが良いならSakuraEditorとかもいいとおもう。
  • phpの基本的な文法と書き方が分かる。

プラグインの名前を決める。

重要。なぜかというと、プラグインの名前が他のプラグインの名前と被ると競合するのでマズイ。

プラグインの名前はファイル名とかフォルダ名に使うので、半角英数文字ととハイフン「-」で構成するといいとおもう。

とりあえず今回はテストだし「my-test-plugin」とかにしてみる。

プラグインフォルダを作る

「[wordpressをインストールしたフォルダ]/wp-content/plugins/」フォルダ内にプラグイン名のフォルダを作る。

[wordpressをインストールしたフォルダ]は、wp-config.phpというファイルがあるフォルダ。

/wp-content/plugins っていうフォルダの中に今回のプラグイン名である「my-test-plugin」フォルダを作る。なので、ロリポップでftpとかから見ると「[wordpressをインストールしたフォルダ]/wp-content/plugins/test-plugin」ってなってる。

本当はファイル単体でもプラグインとして作れるけど、プラグインは複数ファイルから構成されることが多くなるのでフォルダを作ったほうが良いと思う。

もしプラグインをwordpressの管理画面からインストールできるようにしたければ、いろいろ面倒なので省略。

プラグインファイルを作る

今回のプラグイン名は「my-test-plugin」だから、「my-test-plugin.php」にする。

プラグインファイルの先頭に「プラグイン情報」を書いて保存

書ける項目は以下の通り。でも自作の野良プラグインだから別に全部書く必要はないと思う。文字コードはUTF-8で。

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

最低限必要なのはPlugin Nameの行だけ。あとできるだけ英語で書いたほうがいいけど日本語でもおk。

プラグインを作った動機とかプラグインの機能とかをあとで見た時に思い出すために、Descriptionも書いておいたほうがいいと思う。

今回はこんな感じで書いてみました。

<?php
/*
Plugin Name: my-test-plugin
Description: テスト用のプラグイン。
Version: 0.1
Author: xnonce
Author URI: https://xnonce.com
License: GPL2
*/

サーバにアップロードして管理画面で確認する

wordpressの管理画面にログインして、プラグイン→インストール済みプラグインを見てみると、自動的に認識されてプラグイン一覧に表示されます。

テスト用のプラグイン

有効化する

「有効化」のリンクをクリックして有効化してみてください。

機能としては何もしないプラグインなので有効化しても何も起こらないと思います。

もしエラーが表示されたりブログ画面が真っ白になってしまったら

たぶん、「<?php」を忘れているとか「/*」「*/」を忘れているなど、phpファイル内の書き方が間違っています。あとは全角のスペースが紛れ込んでるとか。

ftpでログインして、先ほどアップロードした「my-test-plugin.php」が正しくかけているか確認してみてください。

機能の追加とかについてはまた別の記事で。


質問・コメントなどあると嬉しいです