「プラグイン」の記事 - Crieit

(WordPress) 非公開記事も含めた記事数カウントを管理画面に表示するプラグイン

2022-03-06T00:02:57+09:00

経緯

WordPress でブログを運用していると、カテゴリーやタグ、カスタムタクソノミーを整理したくなることがあります。

特にタグのように非階層型の入力形式のタクソノミーの場合は自由入力なので、スペースの有無や誤字等で似たようなタームを誤って生成しがちです。

Windows 11 と Windows11 (スペースの有無)
Google Chrome と Gooogle Chrome (誤字。 o が1つ多い)

しかも、異なるタグとして集計されるのでタグクラウドの中から絞り込むと思わぬところで必要な記事が漏れていて「あの記事絶対タグが付いているはずなのに……」と見付からずに右往左往したり。

基本的には管理画面の「投稿」→「タグ」に進んでタグの一覧からどちらか一方にタグを付け直して、もう片方のタグで「カウント」つまり記事数が0になったタグを削除すれば良いとは思います。

しかし、ここで一つ課題が。

技術記事等で自分用メモとして残すための非公開記事がいくつかあったりするのですが、先程のタグ編集画面の「カウント」は非公開記事は除外された数のようです。

そのため、例えタグ編集画面で「カウント」が0になっていても、実際は非公開記事で使用されていた……ということが考えられます。これでは迂闊にタグを削除することができません。

コード

そこで、タグ編集画面で非公開記事も含めたカウントを表示するプラグインを作りました。

class FrostColumns
{
    protected $taxName;
    protected $postTypeName;
    protected $countIncludePrivateID;
    protected $countIncludePrivateLabel;

    /**
     * mb_strlen() での空文字列判定のラッパー関数
     *
     * @param string $str        : 入力文字列
     *
     * @return boolean            : 出力文字列
     */
    public function boolStrLen( $str )
    {
        return mb_strlen(
            $str,
            'UTF-8'
        ) > 0;
    }
    /**
     * コンストラクタ
     *
     */
    public function __construct()
    {
        if(
            mb_strpos(
                parse_url(
                    $_SERVER['REQUEST_URI'],
                    PHP_URL_PATH
                ),
                'edit-tags.php',
                0,
                'UTF-8'
            ) !== false
        ) {
            // edit-tags.php のみで動作
            $tax = esc_html(
                filter_input(
                    INPUT_GET,
                    'taxonomy',
                    FILTER_SANITIZE_SPECIAL_CHARS
                )
            );
            // タクソノミーの名前を取得
            $this->taxName = $this->boolStrLen( $tax )
                ? $tax
                : '';
            $posttype = esc_html(
                filter_input(
                    INPUT_GET,
                    'post_type',
                    FILTER_SANITIZE_SPECIAL_CHARS
                )
            );
            // 投稿タイプの名前を取得
            $this->postTypeName = $this->boolStrLen( $posttype )
                ? $posttype
                : '';
            // ラベル
            $this->countIncludePrivateID = 'count_include_private';
            $this->countIncludePrivateLabel = 'カウント(非公開・予約含)';
        }
    }
    /**
     * SQLを直接発行して公開済み・非公開・予約投稿の記事の投稿IDのみの一覧を取得、その数をリンクと共に出力する
     *
     * @param int $termID : タームID
     *
     */
    public function countArticlesBySQL( $termID )
    {
        // $wpdb 読み込み (global で宣言した変数のスコープの兼ね合いでここで読み込み宣言する)
        require_once( ABSPATH . '/wp-load.php');
        global $wpdb;

        // 各タームのオブジェクトを取得
        $termObj = get_term( $termID, $this->taxName );
        // 投稿のカテゴリー、タグはキー名がタクソノミー編集ページと投稿一覧ページで異なるので変換する
        $taxNameParam = $this->taxName;
        switch ( $this->taxName ) {
            case 'category':
                $taxNameParam = 'category_name';
                break;
            case 'post_tag':
                $taxNameParam = 'tag';
                break;
            default:
                $taxNameParam = $this->taxName;
                break;
        }
        // カスタム投稿タイプならばリンクのGETパラメータに投稿タイプの名前を付与
        $postTypeParam = $this->boolStrLen( $this->postTypeName )
            ? '&post_type=' . $this->postTypeName
            : '';
        // SQLのクエリで指定する投稿タイプの名前の文字列をセット
        $postTypeDBParam = $this->boolStrLen( $this->postTypeName )
            ? $this->postTypeName
            : 'post';
        // WP_Query では結果の投稿オブジェクトが大き過ぎてメモリを食い潰すので直接SQLを発行してIDのみ結果として取得して省力化する
        $the_query = "SELECT " . $wpdb->prefix . "posts.ID FROM " . $wpdb->prefix . "posts LEFT JOIN " . $wpdb->prefix . "term_relationships ON (" . $wpdb->prefix . "posts.ID = " . $wpdb->prefix . "term_relationships.object_id) WHERE 1=1 AND ( " . $wpdb->prefix . "term_relationships.term_taxonomy_id IN ( %d ) ) AND " . $wpdb->prefix . "posts.post_type = %s AND ((" . $wpdb->prefix . "posts.post_status = 'publish' OR " . $wpdb->prefix . "posts.post_status = 'future' OR " . $wpdb->prefix . "posts.post_status = 'private')) GROUP BY " . $wpdb->prefix . "posts.ID ORDER BY " . $wpdb->prefix . "posts.post_date DESC";
        $results = $wpdb->get_results(
            $wpdb->prepare(
                $the_query,
                $termID,
                $postTypeDBParam
            )
        );
        $cnt = count($results);

        echo <<{$cnt}

CNT;

    }
    /**
     * 欄としての列の出力
     *
     * @param array $columns : 列
     *
     * @return array $columns : 列
     *
     */
    function addCountIncludePrivateColumns( $columns )
    {
        echo <<
    .taxonomy-{$this->taxName} .manage-column.num \{width: 90px;\}
    .taxonomy-{$this->taxName} .manage-column.column-id \{width: 60px;\}


STL;

        $columns[$this->countIncludePrivateID] = $this->countIncludePrivateLabel;
        return $columns;
    }
    /**
     * 追加した列に実際の値を表示させる
     *
     * @param string $content     : 出力するコンテンツ
     * @param string $column_name : 列名
     * @param int    $term_id     : タームID
     *
     */
    function customCountIncludePrivateColumns( $content, $column_name, $term_id )
    {
        if ( $column_name == $this->countIncludePrivateID ) {
            $this->countArticlesBySQL( $term_id );
        }
    }
    /**
     * 初期処理。アクションフック・フィルターフックを発動させる
     *
     */
    public function initialize()
    {
        // 列の追加
        add_filter(
            'manage_edit-' . $this->taxName . '_columns',
            [
                $this,
                'addCountIncludePrivateColumns'
            ]
        );
        // 追加した列に実際の値を表示させる
        add_action(
            'manage_' . $this->taxName . '_custom_column',
            [
                $this,
                'customCountIncludePrivateColumns'
            ],
            10,
            3
        );
    }
}

// 処理
$wp_ab_frostcolumns = new FrostColumns();

if( is_admin() ) {
    // 管理者画面を表示している場合のみ実行
    $wp_ab_frostcolumns->initialize();
}

コンストラクタ:
- URLをパースして edit-tags.php のみで動作するように判定
- GETパラメータからタクソノミーの名前と(必要ならば)投稿タイプの名前を取得
countArticlesBySQLメソッド:
- 本プラグインの肝
- 後で使用するため wp-load.php から $wpdb で WordPress のDBオブジェクトを読み込み
- edit-tags.php ではカテゴリーは category、タグは post_tag だが投稿一覧ページではそれぞれ category_name, tag とキーとなる文字列が変わるため遷移時の GETパラメータに付与するときのために変換をかけておく
- カスタム投稿タイプの場合、 SQLクエリや GETパラメータへの付与が必要になるため処理
- タクソノミーと投稿タイプ、投稿ステータス( publish, private, future のいずれか)で絞り込むSQLクエリを発行して投稿IDのみのオブジェクトを取得する
  - WP_Query で投稿データ全体のオブジェクトを取得すると重過ぎて PHP のメモリバッファを食い潰してしまうため、最小限になるように調整
- 記事数を count で取得して、 aタグとして出力
addCountIncludePrivateColumnsメソッド:
- テーブル出力にオリジナルの列を出力する。フィルターフック
customCountIncludePrivateColumnsメソッド:
- 追加した列に実際の値を表示させるアクションフック
- テーブル出力のキーが予めセットされていた文字列 (今回のオリジナル列) と同じ場合、 countArticlesBySQLメソッドを呼ぶ

やっていることとしてはこのような感じ。

検証

それでは、デモで検証してみます。

このように9つの記事を適当に作ってみました。今回はプラグインの効果をタグで試すことにします。

例えば、「ヘイルストーム」で記事を検索すると公開記事2件、非公開記事2件と2件ずつ、合計4件がヒットします。

ところが、通常のタグの編集画面では先の「ヘイルストーム」の記事数は2と表示されています。実際は非公開記事も含めて4件あるはずで、今回は「4」と表示されてほしいわけです。

それじゃスペルカード発動。先の「ヘイルストーム」の記事数は追加された列で4と表示されるようになりました。意図通りです。

別のサンプル。誤字した例として伸ばし棒のない「コールドディヴィニティ」は上述のタグ編集画面だと通常0件、追加列では1件と表示されています。ページ遷移すると、非公開記事1件のみが一覧に表示されています。

こういうケースでは伸ばし棒のある「コールドディヴィニティー」に直して、プラグインで追加された列も含めて「0」表示となったことを確認した後に伸ばし棒のない「コールドディヴィニティ」タグを削除する、というフローで活用できる、という寸法です。

参考

一覧ページのテーブルに列を追加・カスタマイズ

(未使用だが参考にはなった) 表示処理

WordPress\/edit-tags.php at master ・ WordPress\/WordPress ・ GitHub

$wp_list_table->display(); でテーブルを出力している。

WordPress\/class-wp-list-table.php at master ・ WordPress\/WordPress ・ GitHub

基底クラスのこの部分が該当処理。ただし汎用的な内容。

(未使用だが参考にはなった) WP_Terms_List_Table

WP_Terms_List_Table | Class | WordPress Developer Resources

使用しているクラス

column_posts()メソッドがそれっぽい。が、引数の $tag に既に情報が入っているようなのでこの中ではない。

WP_List_Table | Class | WordPress Developer Resources

display_rows()メソッドでもない。

ソート可能な列の出力

manage_{$this->screen->id}_sortable_columns | Hook | WordPress Developer Resources

$wpdb

found_postsプロパティ

(未使用) wp_count_posts()

WordPressで記事の数を取得する → wp_count_posts() か found_posts - シンプルシンプルデザイン WordPress

複雑な条件の件数となると WP_Query 一択。

タクソノミー→ターム

(未使用だが参考にはなった) WP_Term_Query

countプロパティはDBの値を読むだけ。逆に言えばDBに値が保存されていることが判明。

(未使用だが参考にはなった) タクソノミー操作系の目星

get_tax_sql()
- WordPress\/taxonomy.php at master · WordPress\/WordPress · GitHub
実際にテーブルを作っているクラス
- WordPress\/class-wp-terms-list-table.php at master · WordPress\/WordPress · GitHub
  - 基底クラス: WordPress\/class-wp-list-table.php at master · WordPress\/WordPress · GitHub

(未使用だが参考にはなった) タクソノミーやタームに関係ありそうなクラス

WordPress\/class-wp-tax-query.php at master · WordPress\/WordPress · GitHub
WordPress\/class-wp-taxonomy.php at master · WordPress\/WordPress · GitHub
WP_Term | Class | WordPress Developer Resources
- WordPress\/class-wp-term.php at master · WordPress\/WordPress · GitHub
  - Termのオブジェクト(ハコ)という感じ

get_term()

関数リファレンス\/get term - WordPress Codex 日本語版

PHP

ヒアドキュメント

PHP: 文字列 - Manual

スコープ

PHP: 変数のスコープ - Manual

GETパラメータ

PHP: filter_input - Manual

filter_input(INPUT_GET, 'taxonomy', FILTER_SANITIZE_SPECIAL_CHARS) で取得できる。

WordPress の管理画面内のみ投稿の特定のカテゴリを非表示にするプラグイン

2020-11-22T13:53:28+09:00

管理画面の投稿一覧・投稿編集画面でカテゴリの一覧の表示を少なくするプラグインを作りました。

経緯

カテゴリを大量に使用している WordPress サイトがあるのですが、投稿編集画面や投稿一覧画面でカテゴリを選択使用とした際にどこにあるのかスクロールバーを右往左往させることが多いのが悩みでした。

サイトの用途として

フロント側:
- カテゴリで記事を辿ることがままある (検索的な用途)
  - カテゴリの一覧としては残しておきたい
    - 「カテゴリを削除・整理する」のは今回の用途では不適
管理画面:
- カテゴリの新規追加はそこそこある
  - 過去記事もカテゴリを付け直すことがある (上述の検索用途のため)
- ただし、一度追加した既存のカテゴリはホットな時期が終われば以降はほぼ再利用しない

という状態です。端的に言えば「追加するだけ追加するけど、一定の期間を終えたらそのカテゴリを使用することはほぼない」「検索用途として使用するため、カテゴリの削除は基本しない」という運用です。

そうなると、冒頭のように「(編集の際に)大量のカテゴリのチェックボックスからスクロールしまくって目的のカテゴリを探す」羽目になるわけです。

これをどうにかしたい。

機能

この悩みを解決するために、以下のような機能を考えました。

設定画面:
- カテゴリの一覧から非表示にするカテゴリを選択する
  - カテゴリを選択した際に子孫カテゴリがいる場合は、これも一括で非表示にする
投稿一覧画面:
- 設定画面で選択したカテゴリを非表示
新規投稿画面・投稿編集画面:
- 設定画面で選択したカテゴリを非表示
フロント画面:
- 記事のカテゴリ一覧の出力やカテゴリアーカイブのウィジェット等、カテゴリの表示は上述の設定に依らず通常通り全てのカテゴリを表示する

プラグイン

arm-band/wp_plugin_furusoma

できたものがこちらになります。

動作デモ(キャプチャ画像)

1. カテゴリのサンプル

まずは準備。適当な WordPress サイトを Docker 等で建てて上述のようなサンプルのカテゴリを作成します。

test
- テスト子供1
  - テスト孫1
    - テストひ孫1
- テスト子供2
サンプル
- サンプル子供
未分類 (デフォルト)

これで試験します。

2. 設定画面

次に設定画面。

非表示にする投稿のカテゴリを選択するチェックボックスと、 JavaScript 側の制御のタイムアウト期限の2つの枠を作りました。

前者は親子関係にきちんと沿った表示をするために Walker_Category_Checklistクラスを extends して start_elメソッドをカスタマイズしています。

後者は JavaScript でポーリングする回数の最大値(後述)です。

これについては、投稿新規作成画面と投稿編集画面でのカテゴリ一覧の非表示で壁に当たったのがきっかけで作りました。

これらの画面は AJAX 経由でカテゴリ一覧を作成しているようなので、サーバサイド( PHP )での制御は難しいと判断しました(やるとしたら、 WP REST API の出力を絞る？)。

また、仮にサーバサイドでカテゴリ一覧を絞ってしまうと、過去記事のカテゴリを整理する際に

プラグインで非表示にする前にチェックを付けていた
記事編集時点ではプラグインで非表示設定にしている

の2つの条件を満たすカテゴリが存在した場合、チェックされずに記事の保存が行われてしまう、つまり「カテゴリに既に付けてあったチェックが外れてしまう」可能性が考えられるため、この点でもサーバサイドのみでの制御は難しいと考えました。

そこで苦肉の策ではありますが、 JavaScript で「一定時間おきにカテゴリの一覧が描画されたか(クラス editor-post-taxonomies__hierarchical-terms-list の要素があるか)をポーリング」し、「存在したことを確認したら該当カテゴリの項目を非表示にする」ことにしました。

このポーリングの回数が上述のタイムアウト期限の項目になります。

2.1. バリデーション

register_setting のコールバックにバリデーションも登録しました。

開発者ツールを使ってタイムアウト期限の input タグを type="number" から type="text" に変えて文字列を入力します。

結果、エラー表示されました。

正しい入力の場合は保存の通知が表示されます。

今度はチェックボックスで送信される値を操作します。

結果、エラー表示されました。

こちらも正しい入力の場合は保存の通知が表示されます。

2.2. 子孫要素だけチェックを外すことを阻害

「カテゴリを選択した際に子孫カテゴリがいる場合は、これも一括で非表示にする」という仕様ですが、これもやや頭を悩ませるものでした。

というのは、 Walker_Category_Checklistクラスで探索するカテゴリは「自身から見て親と子」の情報は持っていますが、親のさらに上の祖先や、逆に孫以下の情報は直接は持っていなさそうでした。

そのため、「あるカテゴリを非表示にした」場合、子供はともかく孫以降まで非表示にする判定をして行かなければなりません。

逆に、あるカテゴリに非表示のチェックが付いていなかったとしても、親より上の祖先のカテゴリが非表示チェックが付いていないか判定しなければなりません。

どちらも再帰的に探索して潰していく形になるので、そこそこ面倒かと。

今回は実装スピードを重視したかったので、上述のような再帰的な判定ではなく、「設定画面であるカテゴリにチェックを付けたら、子孫カテゴリも全て連動してチェックを付ける」機能を JavaScript 側で実装しました。

そこで、「親以上のカテゴリでチェックが付いていたら子孫カテゴリはチェックを外せない」という機能も追加しました。

3. 投稿編集画面

続いて、投稿編集画面(新規投稿、既存投稿の編集)。

テストのため、一度プラグインを無効化して、表示し続ける予定の「テスト子供2」の他に、非表示にする予定の「テスト孫1」「サンプル子供」もカテゴリとしてチェックを付けておきます。

投稿一覧画面で「テスト子供2」「テスト孫1」「サンプル子供」のカテゴリに所属していることを確認しておきます。

続いてプラグインを有効化し、以下のように非表示設定をします。

test
- [x] テスト子供1
  - [x] テスト孫1
    - [x] テストひ孫1
- テスト子供2
サンプル
- [x] サンプル子供
未分類 (デフォルト)

先ほどの投稿では、上述の通り「テスト子供2」は残りますが、「テスト孫1」「サンプル子供」の2つは非表示になります。

投稿編集画面で「テスト孫1」「サンプル子供」が非表示になっていることを確認。「テスト子供2」だけ表示上残っています。

この状態で「未分類」カテゴリにも所属するようにチェックを付けて「更新」します。

投稿一覧画面で元々チェックが付いていて表示されていた「テスト子供2」、新規で追加した「未分類」はもちろん、非表示になっている「テスト孫1」「サンプル子供」も依然として所属していることが確認できました(原案時点、 display: none; で全くの非表示にした場合は「テスト孫1」「サンプル子供」のチェックが外れてしまったので、若干の工夫が必要でした)。

なお、投稿編集画面のカテゴリは以下の操作を行う度にメニューの中が再描画されるため、最初の編集画面表示時以外のタイミングでも非表示にするように JavaScript の調整が必要でした。

⚙ボタンを押してメニューの表示・非表示を切り替える
タブで「ブロック」を表示させた後、「文書」タブに戻る

4. 投稿一覧画面

続いて投稿一覧画面。

いったん先ほどのテスト投稿のカテゴリを「テスト子供2」「テスト孫1」「サンプル子供」の3つに戻しておきます。

この状態で「クイック編集」をクリックし、カテゴリの一覧を表示させます。先ほどと同様、「テスト孫1」「サンプル子供」の2つは非表示になっています。

この状態で「更新」。

投稿一覧画面に戻り、依然「テスト子供2」「テスト孫1」「サンプル子供」の3つに所属し続けています。

躓いたポイント

カテゴリの一覧を親子関係を保持したまま表示させるために Walker_Category_Checklistクラスをカスタマイズした
- 設定画面だけでなく、投稿一覧画面で項目を非表示にする際も同様の手法を採用
投稿編集画面で JavaScript 側で非表示の制御をかけた点(結局 jQuery で頑張ることに)
- 上述したように、「⚙ボタンを押す」「ブロック→文書に戻る」などのタイミングで再描画が走ってしまうため、再度非表示にする処理が走るように調整
投稿編集画面、投稿一覧画面共に非表示の項目を display: none; で潰してしまうと、保存時にチェックが外れてしまうので 1x1px で position: absolute; して……など、「見た目上は非表示に見えるが要素としては存在している」状態にした
wp_terms_checklist_args は投稿編集画面、投稿一覧画面以外でもフックが発火するので、「管理画面内」全体でアクションフックを掛けると動作に不具合が出るため、アクションフック発火前に別個でページ判定を実施し、意図した部分だけアクションフックが掛かるように制限した点
- 独自 css や JavaScript を読み込むアクションフックについてはそこまでシビアではないので、メソッド内で $hook_suffix で判定して回避可能
上述したように、非表示の処理の際にカテゴリの階層が深くなってしまうと探索が難しいので、設定画面で親カテゴリにチェックを付けたら子孫カテゴリ全てに連動してチェックを付けるように処理を追加

他、WordPress の head タグの中を整理するプラグイン (設定画面付き) の自作に類する点。

連続でプラグインを作ったことで、ある程度知見を貯めることはできたのではないかと個人的には思います。

備考

今回は

カテゴリの兄弟や子孫(一本の木の中の枝、森の中の木)を非表示(切る)にする
非表示にする(見えない)
あくまで非表示にするだけで、削除などの実際のデータに影響を及ぼすわけではない(気配はあるが、証拠が掴めない)

というイメージから、「木の切り落とす音はするが、音のした方向を探しても倒れた木が見付からない」怪異である古杣(ふるそま)を採用しました。

なお、類似の怪異は「天狗倒し」「天狗ナメシ」「空木(からぎ)倒し」「空木(そらぎ)倒し」「天崩し」「木伐り坊」等のバリエーションがあります。

javascript - jQuery 動的に読み込んだDOM要素の表示完了時にjQueryプラグインを適用したい - スタック・オーバーフロー

jQueryでDOMの変化をキャッチして動作

JavaScriptで要素の存在判定

【Javascript】setInterval()で要素が現れるまで待つ - Qiita

親要素のチェックボックスをチェックしたら子孫要素のチェックボックスもチェックする

jQuery - 親にチェックするだけで子や孫のチェックボックスもまとめてチェックしたい｜teratail

PHP

in_array
- PHP: in_array - Manual
- in_arrayを使うときは黙って第三引数を付けること - Qiita
json_encode
- PHP: json_encode - Manual
- PHP: 定義済み定数 - Manual
htmlspecialchars
- PHP: htmlspecialchars - Manual
parse_url
- PHP: parse_url - Manual
mb_strpos
- PHP: mb_strpos - Manual
文字列展開(恒等関数)
- PHPで文字列リテラルに式展開 - Qiita

WordPress

投稿編集画面のカスタマイズ

WordPressのカスタムタクソノミーのチェックボックスをラジオボタンにする方法 - モンキーレンチ

コード参考: Adjust Admin Categories

adjust-admin-categories/adjust-admin-categories.php at master ・ kanakogi/adjust-admin-categories

`wp_terms_checklist_args`

`Walker_Category_Checklist`

Walker_Category_Checklist | Class | WordPress Developer Resources

`admin_print_styles`

[WordPress] 管理画面に独自の CSS・JavaScript を適用させる方法まとめ｜ memocarilog

`hook_suffix`

管理バーに $hook_suffix の値を表示する | WordPressカスタマイズ事典

設定画面でチェックボックスを使用

WordPress オリジナルの設定ページでチェックボックスを利用する方法 - HAM MEDIA MEMO

WordPress の head タグの中を整理するプラグイン (設定画面付き) の自作

2020-11-22T13:46:27+09:00

表題の通り、 WordPress の head タグの中を整理するプラグインを自作したので躓いた部分についてメモしておきます。

コード

まずはコードから。勢いで作ったので色々粗削りなのはご容赦を。

keyArray = [
            'wp_version' => [
                'label'       => 'WordPress バージョン',
                'description' => 'name="generator" で出力される WordPress のバージョン情報を非表示にします。',
                'value'       => 1,
            ],
            'shortlink' => [
                'label'       => 'ショートリンクURL',
                'description' => 'ショートリンクURL を非表示にします。',
                'value'       => 1,
            ],
            'wlwmanifest' => [
                'label'       => 'wlwmanifest',
                'description' => 'wlwmanifest を非表示にします。',
                'value'       => 1,
            ],
            'xmlrpc' => [
                'label'       => 'xmlrpc.php',
                'description' => 'xmlrpc.php を非表示にします。',
                'value'       => 1,
            ],
            'dns_prefetch'  => [
                'label'       => 'DNS プリフェッチ',
                'description' => 'DNS プリフェッチ を非表示にします。',
                'value'       => 1,
            ],
            'feed'  => [
                'label'       => 'フィード',
                'description' => 'フィード を非表示にします。(サイト全体フィード、サイト全体コメントフィードを除く)',
                'value'       => 0,
            ],
            'emoji'  => [
                'label'       => '絵文字',
                'description' => '絵文字 用の css や JavaScript を読み込まないようにします。',
                'value'       => 0,
            ],
            'rest_api'  => [
                'label'       => 'REST API',
                'description' => 'REST API を出力しないようにします(oEmbed, Jetpack, ブロックエディタ 除く)。',
                'value'       => 0,
            ],
            'prev_next_article'  => [
                'label'       => '前後の記事',
                'description' => '前後の記事 への rel 属性を出力しないようにします。',
                'value'       => 1,
            ],
        ];

    }

    /**
     * データ読み出し
     *
     * @return array $ANONYMOUS get_option で取得したデータを maybe_unserialize で配列に変換して戻り値にしている
     */
    public function dataRead()
    {
        return maybe_unserialize( get_option( self::SCREAMINGHEAD_SETTINGS_PARAMETERS ) );
    }
    /**
     * 管理者画面にメニューと設定画面を追加
     */
    public function admin_create_page()
    {
        // メニューを追加
        add_action( 'admin_menu', [ $this, 'screaminghead_create_menu' ] );
        // 独自関数をコールバック関数とする
        add_action( 'admin_init', [ $this, 'register_screaminghead_settings' ] );
    }
    /**
     * メニュー追加
     */
    public function screaminghead_create_menu()
    {
        // add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $position );
        //  $page_title : 設定ページの `title` 部分
        //  $menu_title : メニュー名
        //  $capability : 権限 ( 'manage_options' や 'administrator' など)
        //  $menu_slug  : メニューのslug
        //  $function   : 設定ページの出力を行う関数
        //  $icon_url   : メニューに表示するアイコン
        //  $position   : メニューの位置 ( 1 や 99 など )
        add_menu_page(
            self::SCREAMINGHEAD_SETTINGS,
            self::SCREAMINGHEAD_SETTINGS,
            'administrator',
            self::SCREAMINGHEAD,
            [ $this, self::SCREAMINGHEAD . '_settings_page' ],
            'dashicons-album'
        );
    }
    /**
     * コールバック
     */
    public function register_screaminghead_settings()
    {
        // register_setting( $option_group, $option_name, $sanitize_callback )
        //  $option_group      : 設定のグループ名
        //  $option_name       : 設定項目名(DBに保存する名前)
        //  $sanitize_callback : 入力値調整をする際に呼ばれる関数
        register_setting(
            self::SCREAMINGHEAD_SETTINGS_EN,
            self::SCREAMINGHEAD_SETTINGS_PARAMETERS,
            [ $this, self::SCREAMINGHEAD_SETTINGS_VALIDATION ]
        );
    }
    /**
     * バリデーション。コールバックから呼ばれる
     *
     * @param array $newInput 設定画面で入力されたパラメータ
     *
     * @return string $newInput / $ANONYMOUS バリデーションに成功した場合は $newInput そのものを返す。失敗した場合はDBに保存してあった元のデータを get_option で呼び戻す。
     */
    public function screaminghead_validation( $newInput )
    {
        // nonce check
        check_admin_referer( self::SCREAMINGHEAD . '_options', 'name_of_nonce_field' );

        // validation
        $errCnt = 0;
        foreach($newInput as $key => $value) {
            if(preg_match('/^[\d]{1}$/i', $value)) {
                $newInput[$key] = (int) $value;
                if ($newInput[$key] !== 0 && $newInput[$key] !== 1) {
                    $errCnt++;
                }
            }
            else {
                $errCnt++;
            }
        }
        if($errCnt > 0) {
            // add_settings_error( $setting, $code, $message, $type )
            //  $setting : 設定のslug
            //  $code    : エラーコードのslug (HTMLで'setting-error-{$code}'のような形でidが設定されます)
            //  $message : エラーメッセージの内容
            //  $type    : メッセージのタイプ。'updated' (成功) か 'error' (エラー) のどちらか
            add_settings_error(
                self::SCREAMINGHEAD,
                self::SCREAMINGHEAD . '-validation_error',
                __(
                    '設定しようとしたパラメータに不正なデータが含まれています。',
                    self::SCREAMINGHEAD
                ),
                'error'
            );

            return get_option( self::SCREAMINGHEAD_SETTINGS_PARAMETERS );
        }
        else {
            return $newInput;
        }
    }
    /**
     * 設定画面ページの生成
     */
    public function screaminghead_settings_page()
    {
        if ( get_settings_errors( self::SCREAMINGHEAD ) ) {
            // エラーがあった場合はエラーを表示
            settings_errors( self::SCREAMINGHEAD );
        }
        else if( true == $_GET['settings-updated'] ) {
            // 設定変更時にメッセージ表示
?>
            設定を保存しました。

        
            
            非表示にする項目の設定
            以下の一覧から、非表示にしたい項目を選択してください。
            


                keyArray as $key => $value ) {
            if (get_option( self::SCREAMINGHEAD_SETTINGS_PARAMETERS ) !== false) {
                // プラグインのパラメータの読み込みができた場合
                // $data にキー $key の値が存在するならばチェックボックスにチェックを入れる
                $checked = array_key_exists($key, $data) && $data[$key] === 1 ? ' checked="checked"' : '';
            }
            else {
                // プラグインのパラメータの読み込みができなかった場合
                // $this->keyArray で保持しているデフォルト値を参照する
                $checked = $value['value'] === 1 ? ' checked="checked"' : '';
            }

?>
        

            
                
            
            
                 value="1">

                
            
        

                

 '1' ] ); ?>
            
        

keyArray as $key => $value ) {
            if( get_option( SCREAMINGHEAD_SETTINGS_PARAMETERS ) !== false ) {
                // プラグインのパラメータの読み込みができた場合
                // $data にキー $key の値が存在するならば
                $flagArray[$key] = array_key_exists($key, $data) ? $data[$key] : 0;
            }
            else {
                // プラグインのパラメータの読み込みができなかった場合
                // $this->keyArray で保持しているデフォルト値を参照する
                $flagArray[$key] = $value['value'];
            }
        }

        // WordPressバージョン情報の削除
        if( $flagArray['wp_version'] ) {
            remove_action( 'wp_head', 'wp_generator' );
        }
        // ショートリンクURLの削除
        if($flagArray['shortlink'] ) {
            remove_action( 'wp_head', 'wp_shortlink_wp_head' );
        }
        // wlwmanifestの削除
        if ($flagArray['wlwmanifest']) {
            remove_action( 'wp_head', 'wlwmanifest_link' );
        }
        // application/rsd+xmlの削除
        if( $flagArray['xmlrpc'] ) {
            remove_action( 'wp_head', 'rsd_link' );
        }
        // dns-prefetchの削除
        if( $flagArray['dns_prefetch'] ) {
            function remove_dns_prefetch( $hints, $relation_type ) {
                if( 'dns-prefetch' === $relation_type ) {
                    return array_diff( wp_dependencies_unique_hosts(), $hints );
                }
                return $hints;
            }
            add_filter( 'wp_resource_hints', 'remove_dns_prefetch', 10, 2 );
        }
        // フィードの削除
        if( $flagArray['feed'] ) {
            remove_action( 'wp_head', 'feed_links_extra', 3 );
        }
        // 絵文字用css, JSの削除
        if( $flagArray['emoji'] ) {
            remove_action( 'wp_head', 'print_emoji_detection_script', 7 );
            remove_action('wp_print_styles', 'print_emoji_styles', 10);
            remove_action( 'admin_print_scripts', 'print_emoji_detection_script' );
            remove_action( 'wp_print_styles', 'print_emoji_styles' );
            remove_action( 'admin_print_styles', 'print_emoji_styles' );
            remove_filter( 'the_content_feed', 'wp_staticize_emoji' );
            remove_filter( 'comment_text_rss', 'wp_staticize_emoji' );
            remove_filter( 'wp_mail', 'wp_staticize_emoji_for_email' );
            add_filter( 'emoji_svg_url', '__return_false' );
        }
        // REST API
        if( $flagArray['rest_api'] ) {
            function deny_restapi_except_plugins( $result, $wp_rest_server, $request ) {
                $namespaces = $request->get_route();
                // oembed
                if( strpos( $namespaces, 'oembed/' ) === 1 ) {
                    return $result;
                }
                // Jetpack
                if( strpos( $namespaces, 'jetpack/' ) === 1 ) {
                    return $result;
                }
                // BlockEditor
                if( current_user_can( 'edit_posts' ) ) {
                    return $result;
                }
                return new WP_Error( 'rest_disabled', __( 'The REST API on this site has been disabled.' ), array( 'status' => rest_authorization_required_code() ) );
            }
            add_filter( 'rest_pre_dispatch', 'deny_restapi_except_plugins', 10, 3 );
        }
        // 前後記事
        if( $flagArray['prev_next_article'] ) {
            remove_action( 'wp_head', 'adjacent_posts_rel_link_wp_head' );
        }
    }
}

// 処理
$wp_ab_screaminghead = new ScreamingHead();

if( is_admin() ) {
    // 管理者画面を表示している場合のみ実行
    $wp_ab_screaminghead->admin_create_page();
}
else {
    // 管理者画面以外
    $wp_ab_screaminghead->time_crunch();
}

	value="1">

クラス: 関数名のバッティングを防ぐためにカプセル化しました
protected $keyArray;: 設定画面で表示するための以下の項目を持たせました
- ラベル
- 説明文
- 初期値
  - 特にプラグイン有効化直後はDBにデータがないので初期値を持たせる方向にしました
コンストラクタ: コンストラクタは上述 $keyArray を決めるだけにしました
- 今回は「フロント画面のみで走ってほしい」処理と「管理画面のみで走ってほしい」処理の双方があるため、インスタンス化までは共通ですが is_admin() の結果でキックする処理を分けました
admin_create_page(): 管理者画面のみ走る処理
- サイドメニューに設定画面へのリンクを追加
- 設定項目やバリデーション処理の初期化など
screaminghead_validation():
- nonce チェックもしています
- が、内部のエラーチェックは正直適当です(どこでエラーが発生したかを記録していない)
- 入力に誤りがあった場合は元の値をセットしなおしています
screaminghead_settings_page():
- get_settings_errors( self::SCREAMINGHEAD ) でエラー表示
- wp_nonce_field で nonce セット
time_crunch():
- フロント側の処理
- 基本的には設定されたフラグに応じてアクションフックを付け外ししています

動作デモ

管理者画面の設定画面。

更新通知の表示。

開発者ツールで送信パラメータを細工します。

バリデーションに引っかかってエラーの通知が表示されます。

躓いたポイント

最初は関数ベタで書いていたのですが、他の自作プラグインと同じ名前の関数を用意していたのでバッティングしてしまい、途中からクラスに置き換えました
テンプレートタグで関数名を引数として渡す処理(add_menu_page(), register_setting() など)は関数名の文字列から自身のクラスと関数名の文字列の2つの要素からなる配列に置き換える必要がある
- これでヌケがあって設定画面がブランク表示(コンテンツ部分に何も表示されない)になってしまいしばらく嵌まっていました。PHP でエラーにもならないのでヒントが少ない……
- 例(第三引数が該当): register_setting( SCREAMINGHEAD_SETTINGS_EN, SCREAMINGHEAD_SETTINGS_PARAMETERS, SCREAMINGHEAD_SETTINGS_VALIDATION ); → register_setting( self::SCREAMINGHEAD_SETTINGS_EN, self::SCREAMINGHEAD_SETTINGS_PARAMETERS, [ $this, self::SCREAMINGHEAD_SETTINGS_VALIDATION ] );
nonce のチェックの仕込み位置: check_admin_referer() をコールバックから呼ばれるバリデーションの中に入れましたが、ここで良いのかどうかは微妙……

参考

PHP Documentorを使う - Qiita

「プラグイン」の記事 - Crieit

(WordPress) 非公開記事も含めた記事数カウントを管理画面に表示するプラグイン

WordPress の管理画面内のみ投稿の特定のカテゴリを非表示にするプラグイン

wp_terms_checklist_args

Walker_Category_Checklist

admin_print_styles

hook_suffix

WordPress の head タグの中を整理するプラグイン (設定画面付き) の自作

非表示にする項目の設定

head タグの中身をきれいにする

`wp_terms_checklist_args`

`Walker_Category_Checklist`

`admin_print_styles`

`hook_suffix`

`head` タグの中身をきれいにする