投稿ページに著者情報の構造化データを出力する機能を追加

osmdik commented 2 years ago

チケットへのリンク / 変更の理由（元のissueがあればリンクを貼り付ければOK）

https://github.com/vektor-inc/vk-all-in-one-expansion-unit/issues/836

どういう変更をしたか？

ユーザー編集ページに@typeとsameAsの設定項目を追加
投稿ページに、著者情報の構造化データを出力をJSON-LDで出力

レビューに回す前に確認する事

[x] 複数の意図の変更（機能の不具合修正 + 別の機能追加など）を含んでいないか？
[x] Files changed (変更ファイル)の内容は目視で確認したか？
[x] readme.txt に変更内容は書いたか？
[x] 本当にちゃんと確認をしたか？

プログラムの変更の場合

[ ] 書けそうなテストは書いたか？

変更内容について何を確認したか、どういう方法で確認をしたかなど

以下、レビュー確認方法同様です。

確認URL

（　どこかのデモサイトかテストサーバーにデプロイ済みなどで確認できる場合はそのURL　）

レビュワーの確認方法・確認する内容など

ユーザー編集ページに@typeとsameAsが追加されており、編集・更新ができるか
投稿ページのコードを確認し、headに著者情報の構造化データが設定したとおりに出力されているか
リッチリザルトテストで記事内の構造化データの判定が正常か
他、気になる箇所があったらご指摘お願いします。

リッチリザルトテスト https://search.google.com/test/rich-results

レビュワーに回す前の確認事項

[x] このテンプレートのチェック項目をちゃんと確認してチェックしたか？

レビュワー向け

確認して変更が反映されていない場合の確認事項

プルしたか？
ビルドしたか？
ビルドしたディレクトリは正しいか（別の開発環境のディレクトリを見ていないか）？
npm install したか？
composer install したか？

kurudrive commented 2 years ago

@drill-lancer これのレビューがあるよ！

drill-lancer commented 2 years ago

@kurudrive 僕のアドバイス通りに仕上がっていることを確認しましたが、石川さんの思惑通りかどうかは不明なので石川さんもレビューお願いします。

kurudrive commented 2 years ago

@doshimaf @drill-lancer PHPUnit テストを相談の上書いてみてくださいー。

kurudrive commented 2 years ago

[x] プロフィールページでの構造化データの設定UIがわかりにくいので改善（２項目以外もまとめて入力できるように）
[x] ↑ 未入力の場合はデフォルトから取得できる情報は自動取得して利用する

osmdik commented 2 years ago

@kurudrive 著者構造化データの4項目の設定欄を、ユーザー編集画面末尾に構造化データ見出し以下に追加しました。

osmdik commented 2 years ago

@kurudrive 構造化データの出力のコードを、の内容をそのまま出力する方法から、出力したい情報を配列にもたせて、json形式に変換して出力する方法に変更しています。

現状、改行やインデントが入らないよう flags を指定しています。

まだUnitテストの書き方がわかっていませんが、この方法のほうがテストコードを書きやすいのかなと思いましたがいかがでしょうか。

osmdik commented 2 years ago

@kurudrive Unitiテストについて、組織投稿の場合のテストまで記述してコミットしています。「個別の投稿ページじゃないページで空で返ってきてるか？」のテストについては、get_author_array() でページの著者情報を配列にして、print_jsonLD_in_head() で個別の投稿ページにのみjson形式で出力しているという仕様上、現在のテスト方法ではできないのではと思い、保留にして一旦コミットしています。

また確認をお願いたします。

osmdik commented 2 years ago

@kurudrive

構造化データのauthorの部分をget_author_data()という関数を作成し、分けて取得
publisher項目は必須項目ではないため、とりあえずコメントアウト

上記変更を加えています。

kurudrive commented 2 years ago

@doshimaf 一旦 pull してから作業よろしくお願いいたします。

osmdik commented 2 years ago

@kurudrive 確認いただき、ありがとうございます！コメントをもとに調整してみましたが、https://github.com/vektor-inc/vk-all-in-one-expansion-unit/pull/846/commits/f267caf70fbc8af51a12cff9ce5b76339bddea96 で変更したような認識であっていますでしょうか？

osmdik commented 2 years ago

[x] コメントアウト理由の記載 ( https://github.com/vektor-inc/vk-all-in-one-expansion-unit/pull/846/commits/6fe1b55419a078ab070bedd90597313e8830474e, https://github.com/vektor-inc/vk-all-in-one-expansion-unit/pull/846/commits/1637ae298d5bf5e936afbf21eb7b6ad38dd3fcbd )
[x] ファイル名やなどAuthorからArticleへ変更 ( https://github.com/vektor-inc/vk-all-in-one-expansion-unit/pull/846/commits/278dc25287cf515f377fa96ff7193c61788ee424 )

kurudrive commented 2 years ago

@doshimaf マージしました！ありがとうございました！

vektor-inc / vk-all-in-one-expansion-unit