· 14 min read
WordPressプラグインの作り方:初心者向けガイド
WordPressプラグインの作成は、あなたのサイトにカスタム機能を追加する素晴らしい方法です。プラグインは、WordPressのコアファイルを直接編集することなく、新しい機能を追加または既存の機能を変更できます。これにより、WordPressの更新時に変更が上書きされることなく、サイトのカスタマイズを維持できます。
プラグインの作成は、基本的なPHPの知識があれば始めることができます。最初のステップは、プラグインのための新しいディレクトリを作成し、その中に主要なPHPファイルを作成することです。このファイルには、プラグインの名前、バージョン、作者などの基本情報を含めます。
次に、このディレクトリをWordPressのプラグインディレクトリ(通常は/wp-content/plugins
)に移動します。これで、WordPressの管理画面からプラグインを見つけて有効化することができます。
最後に、プラグインに機能を追加します。これは、フィルターフックやアクションフックを使用して、WordPressの既存の機能に介入し、それを変更または拡張することによって行います。これらのコードスニペットは、主要なPHPファイルに追加され、プラグインが有効化されたときに実行されます。
以上が、WordPressプラグインの作成の基本的な流れです。次のセクションでは、これらのステップを詳しく見ていきましょう。それぞれのステップで必要となるコードの例も提供しますので、自分のプラグインを作成する際の参考にしてください。
プラグイン用のフォルダを作成する
WordPressプラグインの作成を始めるには、まずプラグイン用の新しいフォルダを作成します。このフォルダは、プラグインのすべてのファイルを格納する場所となります。フォルダ名は、プラグインの名前と一致するように選びます。例えば、my-plugin
という名前のプラグインを作成する場合、同じ名前のフォルダを作成します。
このフォルダは、あなたのコンピュータ上の任意の場所に作成できます。しかし、最終的にはこのフォルダをWordPressのプラグインディレクトリ(通常は/wp-content/plugins
)に移動させる必要があります。そのため、最初からこのディレクトリ内にフォルダを作成することも可能です。
フォルダを作成したら、次にこのフォルダ内に主要なPHPファイルを作成します。このファイルは、プラグインの基本情報を含むとともに、プラグインの機能を追加するためのコードを書く場所となります。このファイルの名前もプラグインの名前と一致させることが一般的です。例えば、my-plugin.php
という名前のファイルを作成します。
以上が、WordPressプラグインのためのフォルダを作成するステップです。次のセクションでは、このPHPファイルにどのようにプラグイン情報を書くかを詳しく見ていきましょう。
PHPファイルを作成する
WordPressプラグインの作成において、次に行うべきステップは、主要なPHPファイルを作成することです。このファイルは、プラグインの基本情報と、プラグインの機能を追加するためのコードを含む場所となります。
まず、先ほど作成したプラグイン用のフォルダ内に新しいPHPファイルを作成します。このファイルの名前は、通常はプラグインの名前と一致させます。例えば、my-plugin.php
という名前のファイルを作成します。
このPHPファイルの最初の部分には、プラグインの基本情報を含むコメントブロックを書きます。このコメントブロックは、WordPressがプラグインを認識し、管理画面に表示するためのものです。以下に、基本情報を含むコメントブロックの例を示します。
<?php
/*
Plugin Name: My Plugin
Plugin URI: http://www.example.com/my-plugin
Description: This is a brief description of my plugin
Version: 1.0
Author: Your Name
Author URI: http://www.example.com
*/
このコメントブロックには、プラグインの名前、バージョン、作者、ウェブサイトなどの情報を含めます。これらの情報は、WordPressのプラグイン管理画面で表示されます。
以上が、WordPressプラグインのためのPHPファイルを作成するステップです。次のセクションでは、このPHPファイルにどのようにプラグインの機能を追加するかを詳しく見ていきましょう。それぞれのステップで必要となるコードの例も提供しますので、自分のプラグインを作成する際の参考にしてください。
PHPファイルにプラグイン情報を書く
WordPressプラグインのPHPファイルを作成したら、次にそのファイルにプラグインの基本情報を書きます。この情報は、WordPressがプラグインを認識し、管理画面に表示するためのものです。
プラグインの基本情報は、PHPファイルの最初の部分にあるコメントブロックに書きます。このコメントブロックは、以下のような形式で記述します。
<?php
/*
Plugin Name: プラグインの名前
Plugin URI: プラグインのウェブサイトのURL
Description: プラグインの簡単な説明
Version: プラグインのバージョン
Author: 作者の名前
Author URI: 作者のウェブサイトのURL
*/
ここで、各項目の詳細を説明します。
Plugin Name
: プラグインの名前です。この名前は、WordPressのプラグイン管理画面で表示されます。Plugin URI
: プラグインのウェブサイトのURLです。プラグインに関する詳細情報を提供するウェブページのURLを指定します。Description
: プラグインの簡単な説明です。この説明は、WordPressのプラグイン管理画面で表示され、プラグインの機能をユーザーに伝えます。Version
: プラグインのバージョンです。新しいバージョンのプラグインをリリースするたびに、このバージョン番号を更新します。Author
: プラグインの作者の名前です。Author URI
: 作者のウェブサイトのURLです。
以上が、WordPressプラグインのPHPファイルにプラグイン情報を書くステップです。次のセクションでは、このPHPファイルにどのようにプラグインの機能を追加するかを詳しく見ていきましょう。それぞれのステップで必要となるコードの例も提供しますので、自分のプラグインを作成する際の参考にしてください。
/wp-content/pluginsにフォルダを移動させる
WordPressプラグインの作成において、次に行うべきステップは、作成したプラグインのフォルダを/wp-content/plugins
ディレクトリに移動させることです。このディレクトリは、WordPressがプラグインを認識し、管理画面から有効化できるようにするための場所です。
まず、あなたのコンピュータ上でプラグインのフォルダを探します。そして、そのフォルダを/wp-content/plugins
ディレクトリにコピーまたは移動します。この操作は、ファイルマネージャーやFTPクライアントなどを使用して行うことができます。
フォルダを移動したら、WordPressの管理画面にログインし、プラグインのページを開きます。そこで、新しく追加したプラグインがリストに表示されていることを確認します。表示されていない場合は、フォルダの移動が正しく行われていない可能性があります。
以上が、WordPressプラグインのフォルダを/wp-content/plugins
ディレクトリに移動させるステップです。次のセクションでは、このプラグインをどのように有効化するかを詳しく見ていきましょう。それぞれのステップで必要となるコードの例も提供しますので、自分のプラグインを作成する際の参考にしてください。
追加したい機能を書き込む
WordPressプラグインの作成において、次に行うべきステップは、プラグインに追加したい機能を書き込むことです。この機能は、プラグインの主要なPHPファイルに追加されるコードスニペットとして表現されます。
プラグインの機能を追加するためには、WordPressのフックシステムを利用します。フックは、WordPressのコア機能に介入し、それを変更または拡張するためのポイントです。フックには2つのタイプがあります:アクションフックとフィルターフックです。
- アクションフックは、特定のイベントが発生したときに実行される関数を登録するためのものです。例えば、投稿が公開されたときやユーザーがログインしたときなどです。
- フィルターフックは、WordPressが特定のデータを処理する前にそのデータを変更するためのものです。例えば、投稿の本文を表示する前に特定の文字列を置換するなどです。
これらのフックを利用して、プラグインに追加したい機能を実装します。以下に、アクションフックを使用して投稿が公開されたときにメールを送信する機能を追加する例を示します。
function my_plugin_send_email_on_publish( $ID, $post ) {
$email_to = '[email protected]';
$subject = 'New post published: ' . $post->post_title;
$message = 'A new post has been published on your website. Check it out: ' . get_permalink( $ID );
wp_mail( $email_to, $subject, $message );
}
add_action( 'publish_post', 'my_plugin_send_email_on_publish', 10, 2 );
以上が、WordPressプラグインに追加したい機能を書き込むステップです。次のセクションでは、このプラグインをどのように有効化するかを詳しく見ていきましょう。それぞれのステップで必要となるコードの例も提供しますので、自分のプラグインを作成する際の参考にしてください。
管理画面からプラグインを有効化する
WordPressプラグインの作成と設定が完了したら、次に行うべきステップは、WordPressの管理画面からプラグインを有効化することです。この操作により、プラグインの機能がWordPressサイトに適用されます。
まず、WordPressの管理画面にログインします。そして、左側のメニューから「プラグイン」を選択します。プラグインのページが開くと、インストールされているすべてのプラグインが一覧表示されます。
この一覧から、有効化したいプラグインを探します。プラグインの名前の下には、「有効化」、「編集」、「削除」といったリンクが表示されています。ここで「有効化」のリンクをクリックすると、プラグインが有効化されます。
プラグインが正しく有効化されると、そのプラグインの行には「プラグインが有効化されました」というメッセージが表示されます。また、プラグインの名前の下には、「無効化」のリンクが表示されるようになります。これにより、必要に応じてプラグインを無効化することも可能です。
以上が、WordPressプラグインを管理画面から有効化するステップです。これで、あなたのWordPressサイトにプラグインの機能が適用され、その機能を利用することができるようになります。次のセクションでは、プラグインの機能をさらに拡張する方法について詳しく見ていきましょう。それぞれのステップで必要となるコードの例も提供しますので、自分のプラグインを作成する際の参考にしてください。