0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

初めて作るWordPressの自作プラグイン

0
Posted at

初めて自作プラグインを作る過程

WP固定記事作成、連動お知らせ投稿プラグイン

固定記事を書いたあと、予約投稿で記事公開と同時にお知らせも投稿されるような仕組みをしたい。
function.phpに書いてしまうと、WPバージョンアップで上書きされ消えてしまう可能性がある。別の方法として、自作プラグインを作ることにした。

ステップ1

自作プラグインの土台を作ってみる。
まずは管理画面に「自作プラグイン」として認識させる

  1. フォルダの作成
    自作プラグインの場合、Webサーバーがファイルを読み込める状態(r権限)になっていれば、管理画面からの有効化や実行は問題なく行えます。
    /wp-content/plugins/ の下に、新しいフォルダ site-auto-news を作成します。

  2. メインファイルの作成
    作成したフォルダの中に、site-auto-news.php というファイルを作成します。
    (パス:/wp-content/plugins/site-auto-news/site-auto-news.php)

  3. プラグインヘッダー(初期コード)の記述
    作成した site-auto-news.php に、以下のコードだけを書いて保存します。

site-auto-news.php
<?php
/*
Plugin Name: 固定記事 お知らせ自動生成プラグイン
Description: 予約投稿・公開に連動して、お知らせ記事とリンクを自動生成します。
Version: 1.0
Author: Tashinoki
*/

ファイルの先頭に書かれたこの特殊なコメントブロック(プラグインヘッダーと呼びます)を自動的に読み込んで、管理画面の一覧画面に出力しています。
image.png

WordPress開発における定番(定型)の書き方

1. セキュリティ対策の記述

ほぼ「必須」で書く決まり文句です。

site-auto-news.php
if (!defined('ABSPATH')) exit; // 直アクセス防止のセキュリティコード
  • 役割と仕組み
    ABSPATH とは、WordPressが起動したときに自動で定義される「WordPressの根本のインストールパス」のことです。
    もし悪意のあるユーザーが、ブラウザからこの site-auto-news.php ファイルのURLを直接叩いて開こうとした場合、WordPressを通していないため ABSPATH が定義されていません。
    そこで「ABSPATH が定義されていなければ(=WordPress経由でなければ)即座に処理を終了(exit)する」というチェックを入れ、外部からの直接実行による不具合や攻撃をガードしています。

2.アクションフックの登録記述

WordPressのイベントに自作関数を引っかけるための「必須の書き方」です。

site-auto-news.php
// 投稿ステータス変更時に実行するフック
add_action('transition_post_status', 'auto_create_news_on_schedule', 10, 3);

add_action( '①イベント名', '②実行したい関数名', ③優先度, ④関数に渡す引数の数 );
という決まった構文

① 'transition_post_status'(イベント名)
WordPressで記事のステータス(下書き、予約、公開など)が変わった瞬間に発火する、WordPress組み込みのイベントです。

② 'auto_create_news_on_schedule'(関数名)
このイベントが起きたときに呼び出す、これから作成する自作関数の名前です。

③ 10(実行優先度)
数字が小さいほど早く実行されます。デフォルト値の 10 を指定するのが標準的です。

④ 3(引き渡す引数の数)
自作関数側で「新しいステータス」「古いステータス」「投稿データ($post)」の 3つの情報 を受け取って判定に使いたいので、明確に 3 と指定しています。

3.処理関数:auto_create_news_on_schedule()

add_action の第4引数で 3 と指定したため、WordPressから以下の3つの情報が自動的に渡されてくる。

  • $new_status: 変更後のステータス(例:'future' = 予約投稿)
  • $old_status: 変更前のステータス(例:'draft' = 下書き)
  • $post: 保存しようとしている対象の記事データ全体(オブジェクト)
site-auto-news.php - auto_create_news_on_schedule関数
function auto_create_news_on_schedule($new_status, $old_status, $post) {

    /*
        1. 対象の投稿タイプ判定
        固定ページや他の関係ない投稿を編集した時に、
        誤ってお知らせが作られないように防ぐため
    */
    $target_post_type = 'post'; 
    if ($post->post_type !== $target_post_type) return;

    /* 
        自動保存の除外
        執筆中の自動保存のたびにお知らせが作られてしまうのを防ぐ、
        お決まりの安全装置
    */
    if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) return;

    /* 
        2. 予約投稿(future)にステータス変更された時だけ実行
          すでに予約投稿になっている記事を微修正して保存し直した際、
          二重でお知らせが生成されるのを防ぎ、「最初に予約投稿をセットした瞬間」
          だけ発火させるため
    */
    if ($new_status === 'future' && $old_status !== 'future') {

        /* 二重生成防止(すでにお知らせが作成されているかチェック)
          ミニ通信の記事データ($post->ID)に
          「作成済みのお知らせID(_linked_news_id)」が
          記録されていれば、重複作成しないよう処理を中断 */
        if (get_post_meta($post->ID, '_linked_news_id', true)) return;
        
        /* 無限ループ防止のため一時的にフックを解除
           この後でお知らせ記事を新規保存(wp_insert_post)した際、
           再度このフック関数が呼ばれて無限ループに落ちるのを防ぐ安全装置 
           一時的にイベントの監視を解除 */
        remove_action('transition_post_status', 'auto_create_news_on_schedule', 10);

        /* ミニ通信の情報(タイトル・パーミリンク)を取得
           予約作成中のミニ通信の「URL」と「タイトル」を取得し、
           お知らせの本文(HTML)を自動生成。
           これで該当号への直リンクが自動挿入される */
        $mini_news_url   = get_permalink($post->ID);
        $mini_news_title = get_the_title($post->ID);

        /* お知らせ記事のパラメータ設定と登録
           wp_insert_post というWordPress標準の関数を使い、
           ミニ通信と同じ公開日時(post_date)で「お知らせ」を
           予約投稿として新規追加 */
        $news_data = array(
            'post_title'    => '【ミニ通信】' . $mini_news_title,
            'post_content'  => $content,
            'post_status'   => 'future', // ミニ通信と同じ「予約投稿」にする
            'post_date'     => $post->post_date, // ミニ通信と同じ公開日時をセット
            'post_date_gmt' => $post->post_date_gmt,
            'post_type'     => 'post',  // お知らせを出力する投稿タイプ
        );

        $news_id = wp_insert_post($news_data);

        /* 紐付けIDの記録と監視の再開
           無事にお知らせが作成されたら、
           ミニ通信側にそのお知らせのIDをメモ(update_post_meta)しておく*/
        if ($news_id && !is_wp_error($news_id)) {
            update_post_meta($post->ID, '_linked_news_id', $news_id);
        }

        // 最後に、一時解除していたフック監視(add_action)を元に戻して終了
        add_action('transition_post_status', 'auto_create_news_on_schedule', 10, 3);
        

※1 WordPressでは、記事やコンテンツの種類(グループ)を識別するためにシステム上の名前がついている。
代表的なもの

  • post : 通常の「投稿」(ブログやお知らせなど、時系列で並ぶ標準機能)
  • page : 「固定ページ」(会社概要やお問い合わせなど、独立したページ)
  • カスタム投稿 : news や mini_news など、開発者が独自に追加した専用の投稿タイプ

記事作成のとき、ブラウザのURL(上のアドレスバー)を見て
パターンA:URLが wp-admin/edit.php で終わっている
➔ これは標準の「投稿」機能を使っている証拠なので、設定値は 'post' で正解です!

パターンB:URLが wp-admin/edit.php?post_type=XXXXX となっている
➔ 独自に作られた機能(カスタム投稿タイプ)です。設定値は、この XXXXX の部分

※2 文字列の仕組みと違い

  • 'transition_post_status'(WordPress固定の予約語)
    WordPress本体にあらかじめ用意されているイベント名(フック)。
    システム側がこの名前でイベントを発生させるため、1文字でも変えると動作しなくなる。
  • 'auto_create_news_on_schedule'(自由なカスタム名)
    自分が作る関数の名前。下で定義する
  • '_linked_news_id'(自由なカスタム名)
    データベース(wp_postmeta)に保存するデータの「キー名(ラベル)」。
    名前は自由だが、先頭に _(アンダースコア)を付けると「管理画面の標準カスタムフィールド枠に表示させない」というWordPressの隠し慣習ルールがある。

※3 WordPress専用関数
WordPressの開発チームがPHPを使って自作した「WP内部処理用の便利関数」。
WordPressのシステムが読み込まれている環境でのみ動作する。
例: remove_action(), add_action(), wp_insert_post(), get_permalink(), get_post_meta()

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?