メインコンテンツへスキップ
見出し画像

年齢確認モーダル表示プラグインをWordPress公式プラグインとして登録・公開しました

    「なんか、すげぇプラグイン出すらしいじゃん」
    「いや、そうなんすよ。メイド叡智の『オープンソースTech』ってプロジェクトからですね、『MHT Entry Confirm』を発表します」

    …という時事ネタはここまでにして、「MHT Entry Confirm」というプラグインを作成し、それをWordPress公式プラグインとして掲載してもらいました。

    この記事はその過程とプラグインの紹介を兼ねたものです。

    プラグインの紹介

    「MHT Entry Confirm」は、サイト閲覧時に確認モーダルを表示し、閲覧者へ事前にコンテンツについてのアクセスを制限できるシンプルなゲート機能を提供するものです。

    動作例

    いわゆるこういうのですね。こういうのが出せるプラグインです。

    画像
    表示例

    設定画面は一枚のページに押し込みました。

    画像
    設定画面(日本語表示は開発中です)

    今後のバージョンアップや仕様変更で設定画面や見え方が変わる可能性はありますが、基本的にはこれくらいのボリュームから膨らまないようにする想定です。

    メッセージ内容は任意ですので、年齢確認だけでなく、暴力的だったりや人を選ぶようなコンテンツの表示前に、条例でインターネットの閲覧が制限されていないことの確認など、ワンクッション置いてからアクセスさせたい場合でもご利用いただけます。

    コンセプト

    シンプルなYes/No形式とし、クッキーによる再表示制御、特定投稿やカテゴリーの除外設定などの、盛り込みすぎず、でも欲しい機能に絞って、実装しました。

    デザイン面も必要十分な程度カスタマイズできるようにし、ロゴ画像、文字色・背景色、テキスト内容の変更にも対応しました。

    成人向けコンテンツや年齢配慮が必要なサイトの基本対策として、手軽に導入できる無料プラグインです。

    (まぁ設置してないサイトも結構あるような気もしますが…マナーとして。なかなか直接的な罰則も無いし、UXとしても邪魔なので本当は設置したくないですけどね…)

    競合調査

    実際に作る前に、すでにあるプラグインについて、調査してみました。
    この手のもの自体は既に結構あります。

    これで全てではないのですが、「age-verification」タグでそれなりの数がインストールされているものに注目してみました。

    なお、Age Gate と Age Gate Lite を使ったことがあるくらいで、他のプラグインは数分眺める程度にしか動作を見ていません。
    見解が浅い可能性がありますが、ご了承ください。

    Age Gate

    最もインストールされていると思われるプラグインです。
    私も以前使用していました。

    とりあえずこれで良いくらいに完成度が高く、非常に高機能なのですが、設定項目が多く、ちょっと面食らいがちです。
    (私には挙動がよくわからないオプションが多く、使いこなしていたとは言い難いレベルでした)

    きめ細かい設定を行いたい場合はいいプラグインだと思います。

    しかし、私のサイトの幾つかは、静的サイト化しており、公開されているサイトではバックエンドのPHPが動作しません。

    「Age Gate」は認証時(はい・YESを押下した際)にバックエンドとの通信が動くようで、この静的サイト化によって確認モーダルの動作が不良となってしまい、コンテンツを閲覧できなくなってしまいました。
    (Method: JavaScript に設定しているんですけどね…原因を突き止めるまで調査はしませんでした)

    もちろんこれはプラグインの問題ではなく、私の静的サイト環境によるものですが、この環境との相性が悪く、他のプラグインを求めるキッカケとなりました。

    Age Gate Lite

    「Age Gate」での問題がなんとかならないかと思って見つけたのが「Age Gate Lite」でした。

    Lite というだけシンプルで、わかりやすい設定になっています。
    必要十分な設定項目で、まさに自分が求めていたものです。

    このプラグインであれば、先述した、静的サイト化時の問題も発生しませんでした。

    コードを確認したところ、フロントエンドではJavaScriptとクッキーによる判定だけを行っており、納得の挙動と実装方法です。

    あまり厳密や細かい設定はできませんが、必要最低限でサイトに年齢確認を導入したいという人にはおすすめです。

    ただし、そのシンプルさ故に、サイト全体に確認画面がかかってしまいます。
    もちろんほとんどの場合、それでいいと思いますが、例えば特定の記事やカテゴリだけは確認が不要なので、出したくないというようなケースには対応できません。

    また、最終更新が現時点で4年前となっており、コードが古いままとなっています。

    追記: その後、アップデートがリリースされたようです。

    機能が少なくそれほど更新する理由もないのでしょうが、設定画面の実装については今の基準や推奨される実装方法からすると、追いついていないコードがありましたので、その点に少し不安がありました。

    私の最終的な静的サイトにおいては、PHPが動作しないため、セキュリティの問題を気にしなくてもいいのですが、他人におすすめしたり、納品物に追加するにはちょっと悩む可能性があります。

    この辺の不安・不満が、自分でプラグインを作ってしまおうと思った動機です。

    Fastest Age Verification

    こちらは「Age Gate Lite」同様、シンプル系です。
    その名の通り、即導入できるレベルでシンプルです。

    でもシンプルすぎて、メッセージの設定すらできません。
    設定項目はロゴとボタンの色と年齢だけ。
    でも、これで十分だ!という人もいるかもしれませんね。

    Age Gator

    こちらは高機能系。
    アルコールやタバコ、大麻、アダルト用の幅広い内蔵テンプレートがあり、目的に合わせて使い始められるようになってます。

    とはいえ、サイトのトンマナとマッチするとも限らないので、結局カスタマイズすることになるとは思いますが。

    設定はインタラクティブなデザインツール画面でできます。
    見た目はもちろん、細かな挙動も設定できるため、こだわりを詰め込めます。

    所感としては、ちょっとモッサリするし、こんなに細かく設定できなくていいので、無機質な設定画面のほうが好みですけどね。

    なお、URLを見てみると、「plugins/age-gate-plus/」となっており、おそらくは「Age Gate」をより高機能にしたものとして作っていた雰囲気がありますね。

    Easy Age Verify

    こちらも設定項目としてはシンプルですが、メッセージのカスタマイズはできます。

    なお、アップグレードして有料登録すると、細かい機能が開放されるようです。

    無料期間があるようなので、他のプラグインで不満があるようなら、選択肢の一つとして試してみてはどうでしょう。
    (機能の割に費用が高いと感じるので、Age GateかAge Gator、もしくは他のもの、見た目で不満があるならCSSを追記したりして独自カスタマイズでいいような気はしますが)

    余談ですが、どうもデカいバナーや主張するUIでプレミアム登録を促すプラグインはそれだけであんまり使いたくないんですよね…。

    もちろん、利益を出したいのは分かりますし、それに見合うほどの製品なんだとも思うのですが…。
    この辺は文化圏やセンスの違いなんでしょうかね。

    WP Terms Popup

    年齢確認にとどまらず、規約への同意画面なんかも出せそうなプラグインです。

    ポップアップは記事のように管理できるので、色々なパターンを用意して、使い分けることができそうです。

    さっきからなんとなく感想がフワっとしているのは、動かし方が初見ではよくわからなくて途中で諦めたからなんです…(ごめんちゃい

    それだけ、サクッと導入するにはちょっと向いていないかもしれませんが、できることは多そうなので、年齢確認以外で使えそうな場面があれば、しっかり勉強してみて、組み込む選択肢として覚えておこうと思いました。

    コンセプト

    競合調査と自分の要求を重ね合わせてみて、以下のような機能コンセプトとしました。

    • 通常の管理設定画面で設定できること

      • 複数パターンや使い分けを想定しない

      • 一枚のページで全てを設定できるように

      • 難しくしすぎない

    • 項目は見た目に関するものだけに

      • 必要最低限にサイトのトンマナに合わせられるカスタマイズ性

    • 静的サイト化しても動作するように

      • 認証時にPHPアクセスの必要がないように

      • モーダルはJavaScriptベースで動くように

    • 除外記事、カテゴリ、タグ設定は盛り込みたい

      • これは自分の要望

    これらを軸としました。
    おおまか「Age Gate Lite」や「Fastest Age Verification」に機能を盛り込んだものに近いかも知れません。

    実装

    「Age Gate Lite」を参考にしつつ、実装をしていきました。
    目指したものがAge Gate Liteに自分の要望を足したものだったので、管理画面や見た目はそっくりになってしまいました。

    でも、今の基準に合わせたり、追加機能を盛り込んだり、いろんなことをやっているので、中身の実装は全然違います。

    PHPは8.2以上を想定。
    古いサイトでは使えませんが、逆に言えば使いたいならちゃんとバージョンアップされたサイトで使うことを強要しています。
    今更PHP7系を提供しているホスティングは無いと思いますが、古いPHPをいつまでも使うのは、インターネットに公開されるサイトとしては、セキュリティに問題があると言わざるおえません。

    おかげで新しい記法や機能が使えて嬉しいですね。
    実装も簡単になるし、可読性も上がります。

    JSやCSSにも、躊躇無くモダンな実装を組み込んで行きました。
    昔は色々とごちゃごちゃしたハックをしないと出来なかったことが、たった数行で実装できるようになりました。助かります。

    そういった実装は、以前はブラウザのバージョンで使えたり使えなかったりしたのですが、2020年にはほとんどのブラウザで実装済みとなった機能ばかりです。
    すっかり市民権を得たといっていいでしょう。いい時代になったものだ…。

    審査

    動作確認も終わり、いざ申請!となるわけですが、申請するには結構いろんなことを整えないといけませんでした。

    例えば、readme.txt に、これはどんなプラグインなのか、どのバージョンに対応しているのか、etc… 申請時に確認されるので、ちゃんと書かないといけません。

    まぁ確かに、その辺の情報が欠如していて、なんだかよくわからないプラグインというのも、他の人からしたら不安だし、自分のニーズに合うかも判断できなくてインストールなんてしたくありませんよね。

    それ以外のも実装方法もチェックが必要です。
    これについては、プラグインをチェックするプラグイン(Plugin Check)があるので、これで指摘された内容について解消していきました。

    他にも、プラグインを説明するReadmeの内容もフォーマットがあるようですので、こちらもチェックしておきましょう。

    その他、申請前にできることをClaude CodeやChatGPTなんかも駆使して、潰していきました。
    申請と差し戻しの言ったり来たりはしたくありません。不毛ですからね。

    では、いざ申請!

    んん…?

    Currently there are 432 plugins awaiting review.
    The review queue is currently longer than normal, we apologize for the delays and ask for patience.
    The current wait for an initial review is at least 18 days.

    https://wordpress.org/plugins/developers/add/

    どうやら、432件のレビュー待ちがあり、初回のレビューまで18日はかかるそうです…。

    なるほど…ある程度自動化されているであろうとはいえ、人力なんですね…。
    しかし、出さないわけにも行かないので、必要事項を入れて提出しました。ひとまず、返信待ちですね。

    審査が通るまでは、後の追加機能のアイディアなんかも練りながら、自分の製品を自分で使い、自分でフィードバックをする「ドッグフーディング」をしていました。

    差し戻し

    まぁ一発ではうまく行かないよねーってことで差し戻しのメールが来ました。
    初回レビューまで18日とのことでしたが、一週間ちょっと、二週間未満で通知が来ました。
    思ったより早く着手してくれるかもしれませんね。

    さて、差し戻しの内容ですが、簡単に言えば、プラグイン名がダメーってことでした。

    実は最初の命名が「Age Boundary」というプラグイン名でした。
    これは正直いって「Age Gate」を意識した命名でした。
    なので、それが紛らわしい、商標侵害の可能性がある、とのことでした。

    ご指摘は最もだなと、そしてそういうのはダメなのか、ということで、いろいろと命名を検討し「Entry Sentry」「Entry Safeguard」などを考えてみて、再申請してみたのですが…Sentry、Safeguardという単語が、商標登録されている単語である可能性を指摘されてしまいました!

    ぐぬぬ、そういうのもあるのか…。
    せっかくカッコイイ名前を考えて付けたのに…!
    しかし、審査が通らないことにはしょうがないし、肝心なのはプラグインの機能のほう、名前は…二の次だ!!チクショウ!!!
    という紆余曲折を得て「MHT Entry Confirm」となりました。

    ちなみに、「MHT」は「Maid-H Tech」の頭文字です。
    命名には自己のブランドを含めること、一般的な単語を使うこと、この辺が審査をスムーズに通すためのコツのようです。
    (これは去年ごろにいろいろ厳しくなったらしくて、それ以前に登録されたプラグインはすごく一般的で短い単語を使ってたりします。ズルいー!)

    ようやく名前が通ったところで、若干のコードレビューに指摘があったので、それらを修正して再申請。

    …

    また差し戻し!!!

    今度はネームスペースに対する指摘でした。
    WordPressはプラグインごとに衝突しない変数名を使わなければなりません。
    さもなければ、他のプラグインと衝突してしまい、予期しない挙動になってしまいます。
    その認識はあったのですが、どうやらコード中の不備を指摘されたようです。
    とにかく打ち返さないことには始まらないので、ササッと直して再申請…。

    ようやく審査を通過することが出来ました!

    うーん、結局、命名で時間を喰ってただけですね…。
    今回のプラグインは機能もコードも小さいので、それほど労力はかかりませんでしたが、もっと複雑だと大変だったかも知れないですね…。
    それが最初からパスしていたらもっと早く承認されていたかもしれません。

    アップロード

    審査が通過すると、専用のアップロードリポジトリが与えられます。
    ここへ手順通りにアップロードすれば良いそうです。

    WordPressプラグインはSubVersion(SVN)というシステムで管理されているようです。
    これはGitが流行る前に主流だったシステムです。

    慣れないながらもSVNを操作しながらファイルを公開しました。
    うーん、Gitでやらせて欲しいですねぇ…。

    GitとSVNの同期を取って、うまくやる方法があるようなんですが、まぁ一度に色々やろうとすると大変なので、まずは公開できることを目指してなんとか完遂しました。

    公開!

    そうしてようやく公式プラグインサイトに掲載されました!
    WordPressのプラグイン画面からも追加できるようになりました。

    長い道のり…というほどではありませんでしたが、細かいところは結構修正したりと大変でした。
    まぁ、オフィシャルに認められ、配信してもらうということで言えば当然に必要な労力だと思います。

    公式プラグインサイトからどうぞ!

    WordPressのプラグイン画面で「mht-entry-confirm」と検索してくれれば表示されるので、いつもの他のプラグインのようにポチッとインストールできます。
    もしくは直接ダウンロードして、プラグインを追加でもいいでしょう。

    ウザいProプランへのバナーとか、有料サブスクしないと使えない機能とかはありませんし、アンインストール時のしつこいアンケートとかもありません!
    設定パラメタもキチンと「wp_optionsテーブル」から削除しますので、お気軽にお試しいただければ幸いです。

    設定項目は現状では英語ですが、それほど迷うことも無いと思います。
    でもわからないことがあったら直接聞いてくれてもいいです。
    (日本語翻訳対応予定)

    また、自分が必要十分だと思った程度の機能は盛り込みましたが、実現するかどうかはともかく、要望やアイディアがあればいただけると嬉しいです。

    後記

    自前プラグインでも、審査がないにしても、セキュリティには気をつけないといけません。
    その意味では、公式プラグイン水準で気をつけなければいけないことが学べたのは良かったです。

    Plugin Checkプラグインで確認すれば、修正すべき部分はピックアップされるので、公式プラグインへ登録する予定がなくとも、自作プラグインのチェックに利用してみると危険な実装をあぶり出せそうです。

    プラグインやテーマの実装は気をつけないと、閲覧者に迷惑がかかったり、最悪の場合サイトごと乗っ取られたり、吹き飛ばすセキュリティバグを作ってしまう可能性があります。

    また、WordPress本体のアップグレードも対応しましょう。

    更新されていない、WPサイトやプラグインはセキュリティリスクです。
    自分のコンテンツやお客さんを守るためにも、サボらずによく確認しましょう。

     
     
    書きたい時に、書きたいように書いているだけです。 記事の一つでもあなたの役にたてばいいですね。 フォロバは投稿内容を確認して行わせていただきます。 界隈っぽければフォロー、そうでなければ一応見送りますが、ご希望ならコメントください。 https://lit.link/maid_h

    あなたへのおすすめ