【WordPress】プラグインの作り方（基本編）

2022-11-16

はじめに

WordPressには便利なプラグインが様々ありますが、
そういった高度な機能のプラグインを見ていると自作するの難しそうと感じると思います。

しかし、基本的な機能のプラグインを自作するのは意外と簡単です。
functions.php について理解できていれば、自作できます。

このページはこんな人向けです

WordPressでの基本的なテーマ制作できる
WordPress の functions.php をコード記述できる
WordPress の themes（テーマ）がどこのディレクトリ（フォルダ）にあるかわかる

例えば、functions.php にカスタム投稿タイプを追加する functionとフックがあるとします。

※カスタム投稿タイプ追加に必要な register_post_type について詳しくは　関数リファレンス（外部サイト）

<?php
//カスタム投稿
function add_custom_post_type() {
 register_post_type(
  'news', //WordPressデータベース内でのカスタム投稿名
  array(
   'label'                 => 'お知らせ', //管理画面での表示名
   'public'                => true, //管理画面から編集を許可(true)・許可しない(false)切り替え
   'exclude_from_search'   => false, //サイト内検索からの除外(true)・除外しない(false)
   'has_archive'           => true, //アーカイブあり(true)・なし(false)
   'show_in_rest'          => true, //ブロックエディタ(true)・旧エディタ(false)
   'menu_position'         => 5, //管理画面でのメニュー位置
   'taxonomies'            => array('category', 'post_tag'), //カテゴリー・タグ等の有効にするタクソノミー
   'supports'              => array(
     'title', //タイトルあり
     'editor', //本文あり
     'author', //ページ制作者入力あり
     'excerpt', //抜粋あり
     'revisions', //編集履歴あり
     'thumbnail', //アイキャッチ画像あり(テーマで有効である場合)
   )
  )
 );
}
add_action('init', 'add_custom_post_type');

プラグイン化の準備

directory-plugins>plugin_name_folder>plugin_name.php

任意のディレクトリ（フォルダ）にpluginsフォルダを作成
pluginsフォルダの中にプラグイン名（例：add-custom-post-type）のフォルダを作成
プラグインフォルダの中にプラグイン名.php （例：add-custom-post-type.php）を作成

※readme.txtは必須ではないですが、プラグインの内容・使い方・バージョン更新情報などを記述して同梱しておくとベター

プラグイン名は半角英子文字・-（ハイフン）を使用してください

ラベル（コメントアウト）でプラグイン化する

functions.php からプラグイン化する箇所をコピー
作成したプラグイン名.php に貼り付け（ペースト）
プラグイン名.php の最初の方にコメントアウトで必要な情報を記述
コードの重複を避けるためにfunctions.php からコピーした箇所を削除

WordPressにテーマを認識させるためにstyle.cssの必須なテーマ情報をコメントアウトで記述すると同じように、WordPressにプラグインを認識させるにプラグイン情報をコメントアウトで記述する

function と関連のフック（どの場面でfunctionを作動させるかの指定）はセットで同一のプラグインに記述します

ただし、ショートコードなど関連のフックがないfunctionの場合はプラグインにフックの記述は不要です

functionの中で別のfunctionを呼び出している場合は呼び出されている別のfunctionもセットで同一のプラグインに記述します

<?php
/*
Plugin Name: add_custom_post_type
Version: 1.0.0
Author: kamiyakoh
Description: Add custom-post-type
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
*/

//カスタム投稿
function add_custom_post_type() {
 register_post_type(
  'news', //WordPressデータベース内でのカスタム投稿名
  array(
   'label'                 => 'お知らせ', //管理画面での表示名
   'public'                => true, //管理画面から編集を許可(true)・許可しない(false)切り替え
   'exclude_from_search'   => false, //サイト内検索からの除外(true)・除外しない(false)
   'has_archive'           => true, //アーカイブあり(true)・なし(false)
   'show_in_rest'          => true, //ブロックエディタ(true)・旧エディタ(false)
   'menu_position'         => 5, //管理画面でのメニュー位置
   'taxonomies'            => array('category', 'post_tag'), //カテゴリー・タグ等の有効にするタクソノミー
   'supports'              => array(
     'title', //タイトルあり
     'editor', //本文あり
     'author', //ページ制作者入力あり
     'excerpt', //抜粋あり
     'revisions', //編集履歴あり
     'thumbnail', //アイキャッチ画像あり(テーマで有効である場合)
   )
  )
 );
}
add_action('init', 'add_custom_post_type');