どうしたらいいのNAVI

どうしたらいいの?にお答えするサイト

【WordPressプラグイン自作】WordPressに自作プラグインを登録し認識させる方法

      2015/11/07


WordPressを使っていて、自作プラグインを作成したいと考えている人も多い事でしょう。
自作プラグインを作成する上で、まず知っておきたいのがWordPressに自作のプラグインをどうやって認識させればいいのかという事です。

 
いつも当たり前のように使っていたプラグインですが、実際に自分が作るとなると「Wordpressはこのプラグインをどうやって認識しているんだろう?」と疑問にもっている人も多い事かと思います。

 
「せっかくWordpressで使えそうな処理を作ってみたのにWordpressに処理されないんじゃあただのゴミだよ・・・」なんて思っている人は、この記事を参考にしてみてください。
自作プラグインをWordpressに登録する方法について簡単でわかりやすく詳しく紹介しているのでチェックしていってくださいね。

 

 
【Wordpressプラグイン自作】自作プラグインをWordpressに登録し認識させる方法
 

 

WordPressに自作プラグインを登録し認識させる方法

自作プラグインをWordpressに登録し認識させる方法では、自分で作成したプラグインをWordpressに認識させ、実際に管理画面などに表示する方法について紹介します。
自作プラグインをWordpressに登録し、実際に管理画面などで扱えるようにするにはポイントがあり、それは次の通りです。

  • プラグインのPHPファイル内にプラグイン標準情報を記述する
  • プラグインをプラグインのインストール先ディレクトリに保存する

 
自作プラグインをWordpressに登録する方法のポイントは思った以上に少なく、簡単なのです。
では、実際に自作プラグインをWordpressに登録する方法についてみていきましょう。

 

 

 

プラグインのPHPファイル内にプラグイン標準情報を記述する

プラグインのPHPファイル内にプラグインの標準情報を記述する事で、Wordpressがプラグインの所定のディレクトリに保存されているファイルを参照しに行った際、このプラグインの標準情報をもとにプラグインを認識する事が出来ます。

 
プラグインの標準情報を記述していないと、Wordpressからはプラグインではなく、ただのテキストファイルとして扱われてしまうのでプラグイン標準情報は「自分はプラグインファイルだよ」と伝える宣言だと思ってください。

 
このプラグイン標準情報はWordpressの管理画面の「プラグイン」関連の管理画面を開いたときに認識され、プラグインの一覧上に表示される事となります。

 
プラグインのPHPファイル内の次の形式のコメントがプラグイン標準情報となり、ハイライトされている「プラグインの名前」は最低限絶対に記述する必要があります。
プラグインの名前が記述されていないとWordpressはプラグインを認識し、登録する事が出来ません。

 

 
例えば、「dousitaraiino NAVI PLUGIN」というプラグインを作成したのであれば、最低限の情報として次のようなプラグイン情報を記述する必要があります。

 

 

 

 

プラグインをプラグインのインストール先ディレクトリに保存する

【Wordpress】インストールしたプラグインの保存場所(ディレクトリ)
Wordpressでインストールしたプラグインの保存場所というのは、Wordpressに特別なカスタマイズを加えない限りは全ての環境で同じディレクトリに保存される事になります。

 
Wordpressはプラグインが決められた場所に保存される事によって、ここに保存されているのはプラグインと判断する事が出来、読み込んでWordpressの機能として追加する事が実現できるのです。

 
Wordpressでインストールしたプラグインの保存先ディレクトリはWordpressがインストールされているルートのディレクトリから「${ドメインルートディレクトリ}/public_html/wp-content/plugins」の場所に保存される事になります。

 
プラグインの保存場所を実際に確認するにはFTPアクセスできるツールでWordpressが稼働しているサーバにアクセスして、インストールしたプラグインの保存場所まで移動する事で確認する事が出来ます。

プラグインの保存場所を確認するのに「FFFTP」などのツールを利用するようにしましょう。
プラグインの保存場所は次の流れで確認する事が出来ます。

  • WordPressを保存しているサーバにFTPアクセスする
  • プラグインの保存先ディレクトリに移動する

 
Wordpressを保存しているサーバにFTPアクセスする
Wordpressを保存しているサーバにFTPアクセスするのに必要な情報は次の通りです、これは自分が契約しているサーバによって内容が異なるので、サーバ契約時等に送信されてくるメールや契約書などを参考に調べてください。

  • サーバーのアドレス
  • サーバにアクセスするためのユーザー名(FTPユーザー名)
  • FTPユーザーのパスワード

 
プラグインの保存先ディレクトリに移動する
Wordpressを使用しているサーバにFTPアクセス出来たら、実際にプラグインの保存先ディレクトリにアクセスしましょう。
プラグインの保存先ディレクトリは「${ドメインルートディレクトリ}/public_html/wp-content/plugins」なので、パスを入力するか、実際にフォルダアイコンをクリックしてたどるなどして所定のディレクトリへ移動しましょう。

 
プラグインの保存先ディレクトリに移動したら実際に自分が今までインストールしてきたプラグインがインストールされているはずです。

 
Wordpressのプラグインの保存先については「【WordPress】インストールしたプラグインの保存場所(ディレクトリ)」で簡単でわかりやすく詳しく紹介しているのでチェックしていってくださいね。

 

 

 

 

自作プラグインをWordpressに登録し認識させてみる

ここで紹介した方法で、実際にプラグインファイルを追加してみました。

登録の方法はここで紹介している、「プラグインのPHPファイル内にプラグイン標準情報を記述する」「プラグインをプラグインのインストール先ディレクトリに保存する」方法のみで、具体的な処理内容は一切記述していません。

自作プラグインをWordpressに登録し、認識させ「プラグイン」->「プラグイン一覧」からプラグインを表示すると、次の画像のようにプラグインがWordpressに認識されているのがお分かり頂けるかと思います。
自作プラグインをWordpressに登録し認識させてみる

 

 

 

 

スポンサーリンク


この記事を読むうえで知っておきたい知識

この記事を読む上で知っておきたい事について紹介します。
何かに困った時に他の方法を思いついたり、用語がわからなくて読みづらいと感じた場合は、これから紹介する事を参考にしてみてください。

 

 

 

プラグインを自作する上で絶対に知っておきたい事

【Wordpress】プラグインを自作する上で絶対に知っておきたい事
Wordpressのプラグインを自作する上で絶対に知っておきたい事というのは、プラグインを自作する上で必須となるプラグインのモジュール(PHPやJS、CSSファイル)の保存先や、各種設定などなどプラグインを自作する上で最低限必要となるWordpressや技術的な前提知識となります。

 
Wordpressのプラグインを作成する上ではWordpress上で動かなければなりませんし、Wordpressそのものに機能を追加するとなるとWordpressそのものに対する多少の前提知識がつきものとなってきます。

 
Wordpressのプラグインを自作する上で絶対に知っておきたい事を項目として挙げると次の通りとなります。

  • WordPressのテーマ・プラグインの開発環境を構築する方法
  • プラグインの保存先
  • WordPressに自作プラグインを登録・認識させる方法
  • WordPressに自作プラグインの関数を処理させる方法
  • WordPressが一番初めに実行するプラグインの処理
  • プラグイン有効化の時だけ実行される初期化処理について
  • WordPressプラグイン開発時によく使うPHP関数について

 

WordPressのテーマ・プラグインの開発環境を構築するというのは、Wordpress上で動作するWordpressのテーマとプラグインを開発する為に必要なIDE(統合開発環境)をパソコンにインストールしてプラグインやテーマの開発を進められるようにパソコン上の環境を整える事を意味しています。

 
Wordpressのテーマやプラグインを導入する前のWordpressを使い、何の記事も投稿されていない状態のWordpressを使いたい方はWordpressを一から構築するのが良いでしょう。

 
プラグインやテーマを自作したり、公開されているプラグインをダウンロード・インストールした後に自分好みにカスタマイズするにも、Wordpressの管理画面からのカスタマイズだけでは解析作業やコーディング作業が困難な場合があります。

 
そんな時は自分のパソコン上(ローカル環境)でワードプレスをテスト出来るようにセットアップして、統合開発環境上でプラグインやテーマを開発・カスタマイズするのが良いでしょう。

 
Wordpressのテーマ・プラグインの開発環境を構築する方法は次の流れで行います。

  • WordPressのテーマ・プラグインの開発環境を構築する
  • WordPress開発環境に必要なXamppの設定を行う
  • XamppにWordpressをインストールする
  • MySQLにWordpressに必要なデータベースを作成する
  • WordPressの初期設定を行う
  • Xampp上のWordpressをEclipseに読み込ませ開発出来る状態にする
  • 開発しやすいようにEclipseの設定を変更する

 

【Wordpress】インストールしたプラグインの保存場所(ディレクトリ)
Wordpressでインストールしたプラグインの保存場所というのは、Wordpressに特別なカスタマイズを加えない限りは全ての環境で同じディレクトリに保存される事になります。

 
Wordpressはプラグインが決められた場所に保存される事によって、ここに保存されているのはプラグインと判断する事が出来、読み込んでWordpressの機能として追加する事が実現できるのです。

 
Wordpressでインストールしたプラグインの保存先ディレクトリはWordpressがインストールされているルートのディレクトリから「${ドメインルートディレクトリ}/public_html/wp-content/plugins」の場所に保存される事になります。

 
プラグインの保存場所を実際に確認するにはFTPアクセスできるツールでWordpressが稼働しているサーバにアクセスして、インストールしたプラグインの保存場所まで移動する事で確認する事が出来ます。

プラグインの保存場所を確認するのに「FFFTP」などのツールを利用するようにしましょう。
プラグインの保存場所は次の流れで確認する事が出来ます。

  • WordPressを保存しているサーバにFTPアクセスする
  • プラグインの保存先ディレクトリに移動する

 

【Wordpressプラグイン自作】自作プラグインをWordpressに登録し認識させる方法
自作プラグインをWordpressに登録し認識させる方法では、自分で作成したプラグインをWordpressに認識させ、実際に管理画面などに表示する方法について紹介します。
自作プラグインをWordpressに登録し、実際に管理画面などで扱えるようにするにはポイントがあり、それは次の通りです。

  • プラグインのPHPファイル内にプラグイン標準情報を記述する
  • プラグインをプラグインのインストール先ディレクトリに保存する

 

【Wordpressプラグイン自作】プラグインの処理をWordpressに実行させる「フック」
プラグインの処理をWordpressに実行させるフックというのはWordpressのコアにプラグインの関数を読み込ませ、実行させるために利用するAPIの概念の事を言います。

 
フックというのは「引き込む」という意味合いがあり、文字通りプラグインにフックを利用する定義を記述する事で、Wordpressにプラグインの関数を特定のタイミングやポイントなどで引き込ませ、実行させます。

 
プラグインの処理をWordpressに実行させるフックは2つ存在し、次の通りとなります。

  • アクションフック
  • フィルターフック

 

【Wordpressプラグイン自作】プラグインで一番初めに実行されるPHPファイルはどれ?
ここで言うWordpressがプラグインを認識して一番初めに実行されるPHPファイルというのは、Wordpressがインストールされたプラグインを初めて認識し、どのファイルから実行するのか?という事を指しています。

 
プラグインのモジュールセットとして使っているPHPファイルが一つであればこういった疑問は起こらないかもしれませんが、PHPファイルを設定画面用、初期化処理用、コンテンツ作成用などと分けている場合、Wordpressはどこから処理を実行してくれるんだろうか?という疑問が起こるはずです。

 
Wordpressであってもプラグインを認識して使えるようにするにはプラグインの処理の「始め」を知る必要があり、プラグイン開発や公開プラグインの編集を行う上ではこのはじめとなる「処理の入口」を知っておく事が絶対必要になってきます。

 
結論を申し上げますと、Wordpressが一番初めにプラグインを認識して実行するファイルは「プラグイン標準情報」が記述されたPHPファイルから実行されます。
プラグイン標準情報が記載された「<?php~?>」で囲まれた部分の処理から実行される事になります。

 

【Wordpressプラグイン自作】Wordpressのプラグインの初期化処理の方法(plugins loaded)
Wordpressのプラグインの初期化処理の方法というのは、Wordpressに登録したプラグインが有効化された時に、プラグイン実行の為に必要な前提情報を起動時に一度だけ実行する処理の事を指します。

 
プラグインの最初の一度だけ処理され、変数として持ちたい値などを予め設定しておくことを「初期化」または「イニシャライズ」と言います。

 
Wordpressのプラグインの初期化というと理想的なのがプラグインの一覧画面からプラグインを有効化した時でしょう。
プラグインの一覧画面からプラグインを有効化した際に、初期化処理をさせるのに利用するのが、フィルターフックの一つである「plugins loaded」の利用です。

 
Wordpressのプラグインの初期化を利用する上では次の手順を踏むようにしましょう。

  • 初期化処理関数を作成する
  • 初期化処理関数をアクションフックで呼び出す

 

【Wordpressプラグイン自作】プラグイン開発で良く使う!よく見る!PHPの関数
プラグイン開発でよく使う、よく見る関数集というのは、実際にプラグイン開発の時に知っておくと実装が楽になったり、他の人が作ってくれたプラグインの処理でよく使われるPHP標準の関数の事を指します。

 
プラグイン独自で実装されている関数については各種プラグインの処理のコードを読む必要がありますが、PHPの標準の関数について知っておくだけでプラグイン開発が効率的に作業出来るようになったり、プラグインの処理を読む労力が削減されます。

 
プラグイン開発で良く使う、よく見るPHPの関数としては次のような関数があります。

  • require_once(${ファイル名})

 
Wordpressのプラグインを自作する上で絶対に知っておきたい事については「【WordPress】プラグインを自作する上で絶対に知っておきたい事」で簡単でわかりやすく、更に詳しく紹介しているのでチェックしていってくださいね。

 

 

 

 

WordPressに自作プラグインを登録し認識させる方法 あとがき

自作したプラグインをWordpressに登録し認識させる方法について紹介しました。

 
始めてプラグインを作成した人は「プラグインを作成する人って雲の上のような存在だ・・・(遠い目)」とか思っていたかと思いますが、実際にプラグインを登録してみると、雲の上のような存在の人にグッと近づいた感じがあるのではないでしょうか。

 
実際に私は、初めてプラグインを自作し、Wordpressにプラグインを登録し、認識させる事が出来たときは「おおっ!すげえ!」とか思って興奮した覚えがあります。
Wordpressで自作プラグインを作成・登録する上ではごく当たり前のことなのですが、その当たり前の事でも感動を覚える物です。

 
なにより、「あんなものが欲しい」「こんなプラグインが欲しい」と夢のまた夢と思っていた事に近づいたときの感覚はたまらないものです。

 
自作プラグインをWordpressに登録し認識させる方法を使って小さな感動と、プラグイン自作の夢に一歩近づいてみてくださいね。

 

 

 

 

WordPressに自作プラグインを登録し認識させる方法 まとめ

自作プラグインをWordpressに登録し認識させる方法では、自分で作成したプラグインをWordpressに認識させ、実際に管理画面などに表示する方法について紹介します。
自作プラグインをWordpressに登録し、実際に管理画面などで扱えるようにするにはポイントがあり、それは次の通りです。

  • プラグインのPHPファイル内にプラグイン標準情報を記述する
  • プラグインをプラグインのインストール先ディレクトリに保存する

 
プラグインのPHPファイル内にプラグインの標準情報を記述する事で、Wordpressがプラグインの所定のディレクトリに保存されているファイルを参照しに行った際、このプラグインの標準情報をもとにプラグインを認識する事が出来ます。

 
プラグインの標準情報を記述していないと、Wordpressからはプラグインではなく、ただのテキストファイルとして扱われてしまうのでプラグイン標準情報は「自分はプラグインファイルだよ」と伝える宣言だと思ってください。

 
このプラグイン標準情報はWordpressの管理画面の「プラグイン」関連の管理画面を開いたときに認識され、プラグインの一覧上に表示される事となります。

 
プラグインのPHPファイル内の次の形式のコメントがプラグイン標準情報となり、ハイライトされている「プラグインの名前」は最低限絶対に記述する必要があります。
プラグインの名前が記述されていないとWordpressはプラグインを認識し、登録する事が出来ません。

 

 

【Wordpress】インストールしたプラグインの保存場所(ディレクトリ)
Wordpressでインストールしたプラグインの保存場所というのは、Wordpressに特別なカスタマイズを加えない限りは全ての環境で同じディレクトリに保存される事になります。

 
Wordpressはプラグインが決められた場所に保存される事によって、ここに保存されているのはプラグインと判断する事が出来、読み込んでWordpressの機能として追加する事が実現できるのです。

 
Wordpressでインストールしたプラグインの保存先ディレクトリはWordpressがインストールされているルートのディレクトリから「${ドメインルートディレクトリ}/public_html/wp-content/plugins」の場所に保存される事になります。

 
プラグインの保存場所を実際に確認するにはFTPアクセスできるツールでWordpressが稼働しているサーバにアクセスして、インストールしたプラグインの保存場所まで移動する事で確認する事が出来ます。

プラグインの保存場所を確認するのに「FFFTP」などのツールを利用するようにしましょう。
プラグインの保存場所は次の流れで確認する事が出来ます。

  • WordPressを保存しているサーバにFTPアクセスする
  • プラグインの保存先ディレクトリに移動する

 
ここで紹介した方法で、実際にプラグインファイルを追加してみました。

登録の方法はここで紹介している、「プラグインのPHPファイル内にプラグイン標準情報を記述する」「プラグインをプラグインのインストール先ディレクトリに保存する」方法のみで、具体的な処理内容は一切記述していません。

自作プラグインをWordpressに登録し、認識させ「プラグイン」->「プラグイン一覧」からプラグインを表示すると、次の画像のようにプラグインがWordpressに認識されているのがお分かり頂けるかと思います。
自作プラグインをWordpressに登録し認識させてみる

 

 
最後までお読みいただきありがとうございました。

スポンサーリンク





 - Wordpress , ,

Message

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

  関連記事

【Wordpress】データベースをバックアップするWP Database Backup
【WordPress】データベースをバックアップするWP Database Backup

WordPressでデータベースのバックアップを簡単に行いたい場合がありますよね …

【Wordpressプラグイン自作】フックに登録する関数を他プラグインの関数と衝突させない方法
【WordPressプラグイン自作】フックに登録する関数を他プラグインの関数と衝突させない方法

WordPressのプラグインを自作する上で気を付けなければいけないのが自作した …

【Wordpress】プラグインを整理しなければならない理由 ユーザと自分の為に
【WordPress】プラグインを整理しなければならない理由 ユーザと自分の為に

WordPressのプラグインはとても便利ですよね。 このブログでもWordpr …

【Wordpress】ブログを高速化するプラグイン特集! 高速化の果てへ
【WordPress】ブログを高速化するプラグイン特集! 高速化の果てへ

WordPressでブログを高速化する上で、プラグインの導入は今や必須となってい …

【Autoptimize】HTMLを縮小化するAutoptimizeの基本設定 初心者でも簡単!
【Autoptimize】HTMLを縮小化するAutoptimizeの基本設定 初心者でも簡単!

AutoptimizeはWordpressのプラグインで、HTMLを縮小化する機 …

【Wordpressプラグイン自作】管理画面の任意画面を表示する時に処理実行する方法
【WordPressプラグイン自作】管理画面の任意画面を表示する時に処理実行する方法

WordPressでプラグインを自作開発していると、Wordpressの管理画面 …

【Wordpress】ブログの定型文を簡単挿入! TinyMCE Templates
【WordPress】ブログの定型文を簡単挿入! TinyMCE Templates

WordPressでブログ記事を投稿していると、いつも使っている言い回しや、定型 …

【Quick Adsense】広告を掲載するページの種類を指定しよう
【Quick Adsense】広告を掲載するページの種類を指定しよう

Quick AdsenseでGoogle Adsenseや忍者Admaxといった …

【Autoptimize】HTMLを縮小化するAutoptimizeの高度な設定
【Autoptimize】HTMLを縮小化するAutoptimizeの高度な設定

AutoptimizeはWordpressのプラグインで、HTMLを縮小化する機 …

【Wordpressプラグイン自作】プラグインで一番初めに実行されるPHPファイルはどれ?
【WordPressプラグイン自作】プラグインで一番初めに実行されるPHPファイルはどれ?

WordPressのプラグインを自作する場合であっても、インストールして利用して …