Yoast SEOプラグインのスニペット変数ドキュメント

スニペット変数とは、決められたルールで自動で置換される予約語のことです。
聞き慣れない言葉かもしれませんが、メールやメルマガで「●●様」の●●の部分に自動でお客様の名前が入るテンプレートを使ったことがあったり、Microsoft Wordで年賀状を差し込み印刷をしたことがあれば、想像しやすいかと思います。

    目次

  1. ディスクリプションに使えるスニペット変数まとめ表
  2. ドキュメント
  3. %%sitename%%(%サイトタイトル%)
  4. %%sitedesc%%(%タグライン%)
  5. %%sep%%(%区切り%)
  6. %%date%%(%日付%)
  7. %%modified%%
  8. %%title%%(%タイトル%)
  9. %%excerpt%%(%抜粋%)
  10. %%excerpt_only%%(%抜粋のみ%)
  11. %%tag%%
  12. %%tag_description%%
  13. %%category%%(%カテゴリー%)
  14. %%category_description%%
  15. %%primary_category%%(%メインカテゴリー%)
  16. %%pt_single%%
  17. %%pt_plural%%
  18. %%id%%
  19. %%name%%
  20. %%user_description%%
  21. %%parent_title%%(%親タイトル%)
  22. %%archive_title%%
  23. %%term_title%%
  24. %%term_description%%
  25. %%pagetotal%%
  26. %%pagenumber%%
  27. %%page%%(%固定ページ%)
  28. %%searchphrase%%
  29. %%caption%%
  30. %%focuskw%%(%フォーカスキーフレーズ%)
  31. %%term404%%
  32. %%cf_●●%%
  33. %%ct_●●%%
  34. %%ct_desc_●●%%
  35. まとめ

スニペット変数を使ったメタディスクリプションの詳しい設定方法はこちらの記事をご参照ください。

ディスクリプションに使えるスニペット変数まとめ表 snippet variables

Yoast SEOプラグインが予め下記のようなスニペット変数を用意してくれています。

変数名  (英・日) かんたんな説明
%%sitename%%
%サイトタイトル%
サイト名
%%sitedesc%%
%タグライン%
サイトのキャッチフレーズ
%%sep%%
%区切り%
区切り線
%%date%%
%日付%
投稿日時
%%modified%% 更新日時
%%title%%
%タイトル%
記事タイトル
%%excerpt%%
%抜粋%
抜粋(自動生成あり)
%%excerpt_only%%
%抜粋のみ%
抜粋(自動生成なし)
%%tag%% タグ名(複数)
%%category%%
%カテゴリー%
カテゴリー名(複数)
%%primary_category%%
%メインカテゴリー%
メインカテゴリー名
%%pt_single%% 投稿タイプ(単数形)
%%pt_plural%% 投稿タイプ(複数形)
%%id%% 投稿ID
%%name%% 著者名
%%user_description%% 著者プロフィール
%%parent_title%%
%親タイトル%
親ページのタイトル
%%archive_title%% アーカイブタイトル
%%term_description%% ターム説明文
%%term_title%% ターム名
%%category_description%% カテゴリー説明文
%%tag_description%% タグ説明文
%%searchphrase%% 現在の検索語
%%pagetotal%% ページネーションのマックス値
%%pagenumber%% 現在のページナンバー
%%page%%
%固定ページ%
現在のページ数に置き換えられます (例: ページ 2/4)
%%caption%% 添付ファイルのキャプション
%%focuskw%%
%フォーカスキーフレーズ%
フォーカスキーワード
%%term404%% 見つからなかったターム
%%cf_<custom-field-name>%% カスタムフィールド値
%%ct_<custom-tax-name>%% カスタムタクソノミー名
%%ct_desc_<custom-tax-name>%% カスタムタクソノミー説明文

ドキュメント yoast seo snippet variables docs

1つずつの詳細です。カッコ()内は日本語表記がある場合のみ記載しています。

なお、確認用ソースコードはだいたい以下の2つに含まれていると思います。

%%sitename%%(%サイトタイトル%)

サイト名です。

サイドバーの「設定>一般>サイトのタイトル」で変更できる値が代入されます。

場所使用
トップページ
ok
投稿ok
固定ページok
カテゴリーok
タグok
タクソノミーok
アーカイブok
その他ok

%%sitedesc%%(%タグライン%)

サイトのキャッチフレーズです。タグとは関係ありません。

サイドバーの「設定>一般>キャッチフレーズ」で変更できる値が代入されます。「このサイトの簡単な説明」というメモがある項目です。

場所使用
トップページ
ok
投稿ok
固定ページok
カテゴリーok
タグok
タクソノミーok
アーカイブok
その他ok

%%sep%%(%区切り%)

区切り線です。

サイドバーの「SEO > Search Appearance > タイトル区切り文字」で変更できる値が代入されます。

場所使用
トップページ
ok
投稿ok
固定ページok
カテゴリーok
タグok
タクソノミーok
アーカイブok
その他ok

%%date%%(%日付%)

投稿した日付です。

フォーマットは、サイドバーの「設定 > 一般 > 日付のフォーマット」で指定した形式になります。

場所使用
トップページ
投稿ok
固定ページok
カテゴリー
タグ
タクソノミー
アーカイブ
その他

%%modified%%

更新日時です。

フォーマットは日付と同様です。

場所使用
トップページ
投稿ok
固定ページok
カテゴリー
タグ
タクソノミー
アーカイブ
その他

%%title%%(%タイトル%)

記事タイトルです。

場所使用
トップページ
投稿ok
固定ページok
カテゴリー
タグ
タクソノミー
アーカイブ
その他

%%excerpt%%(%抜粋%)

抜粋です。抜粋がない場合は自動生成されます(※注意点あり)

自動生成のルールは、本文の156文字が抽出されます。

この156文字はwp_html_excerpt関数で指定されているので、内部ではmb_strlen関数でカウントされているため、日本語でも安心です。

(※注意点)
抜粋が自動生成されるかを検証していたところ予期せぬ挙動が起きました。
headタグ内に


Admin only notice: this page does not show a meta description because it does not have one, either write it for this page specifically or go into the [SEO – Search Appearance] menu and set up a template.


というコメントが表示され、descriptionタグは生成されていませんでした。
わずかですがデバッグしたところ、冒頭のパラグラフが日本語154文字までであれば自動生成が成功しましたが、155文字以上のパラグラフになると上述したメッセージがコメント挿入されていました。
このスニペット変数を使う際は、最初のパラグラフを154文字以下におさえるか、抜粋を入力しておけば回避できると思います。
2019.2.22(Yoast SEOバージョン9.2)
場所使用
トップページ
投稿ok
固定ページok
カテゴリー
タグ
タクソノミー
アーカイブ
その他

%%excerpt_only%%(%抜粋のみ%)

抜粋です。

抜粋が空欄になっていても自動生成されません。

使用箇所は%%excerpt%%と同じです。

%%tag%%

タグ名です。slugではなく、nameの値が挿入されます。

タグが複数存在している場合は、カンマ区切りで複数表示されます。

なぜかカテゴリーの一覧ページでも使えます。使えますが、ふさわしくはないので、下記表ではokになっていません。

場所使用
トップページ
投稿ok
固定ページ
カテゴリー
タグok
タクソノミー
アーカイブok
その他

%%tag_description%%

タグの説明文です。

%%category%%(%カテゴリー%)

カテゴリー名です。slugではなく、nameの値が挿入されます。

カテゴリーが複数存在している場合は、カンマ区切りで複数表示されます。

場所使用
トップページ
投稿ok
固定ページ
カテゴリーok
タグ
タクソノミー
アーカイブok
その他

%%category_description%%

カテゴリの説明文です。

%%primary_category%%(%メインカテゴリー%)

メインカテゴリー名です。

%%pt_single%%

投稿タイプの単数形に指定された値が代入されます。

カスタム投稿タイプなどで特殊な使い方をしていない限り、日本語では単数形も複数形も同じになります。

%%pt_plural%%

投稿タイプの複数形に指定された値が代入されます。

カスタム投稿タイプなどで特殊な使い方をしていない限り、日本語では単数形も複数形も同じになります。

%%id%%

投稿やページのIDです。

%%name%%

著者の名前です。

表示用の名前(display_name)が代入されます。

%%user_description%%

著者のプロフィール情報です。

%%parent_title%%(%親タイトル%)

親ページのタイトルです。

親ページが存在しない場合は空になります。

%%archive_title%%

アーカイブタイトルです。

get_the_archive_title関数の値が代入されます。

%%term_title%%

タームのタイトルです。

カスタムタクソノミーのターム名を利用したい場合は、こちらを利用します。

%%term_description%%

タームの説明文です。

カスタムタクソノミーのターム説明文を代入したい場合は、こちらを利用します。

%%pagetotal%%

ページネーションのトータル数です。

5ページにまたがる場合は5です。

%%pagenumber%%

ページネーションにおける現在のページ数です。

5ページ中3ページ目にいるなら3です。

%%page%%(%固定ページ%)

たぶん誤訳だと思われます。

「固定ページ」ではなく「ページ数」のことです。現在のページ数に置き換えられます。

つまり「%%pagenumber%% / %%pagetotal%%」と同義です。
(例: ページ 2/4)

%%searchphrase%%

現在ユーザーが検索に使っている検索キーワードです。Googleで使った検索語ではなく、サイト内検索で使っているキーワードになります。

%%caption%%

添付ファイル(メディア、アタッチメント)のキャプションです。

%%focuskw%%(%フォーカスキーフレーズ%)

Yoast SEOで記事ごとに設定できるフォーカスキーフレーズです。

記事の内容に関連したキーワードを設定しておきば、それらのキーワードに置き換えられます。「フォーカスキーワード」ではなく「フォーカスキーフレーズ」であることにご注意ください。

%%term404%%

分かりにくいですが、ユーザーが投稿名やカテゴリー名を指定してアクセスしたのに見つからなかった場合に、その投稿名やカテゴリー名が代入されます。

https://example.com/category/eventsにアクセスしたが、404ページが表示された場合、term404の値はeventsです。

%%cf_●●%%

カスタムフィールドの値が代入されます。

%%ct_●●%%

カスタムタクソノミー名です。

投稿に複数設定されている場合は、カンマ区切りで複数表示されます。

%%ct_desc_●●%%

カスタムタクソノミーの説明です

まとめ

スニペット変数は動的にいろいろと設定できるので、大量の記事が存在するECショップなどでは抜群に役立ちます。

一方で、運用ルールが遵守されないと予期せぬ値が代入されてしまい、機会損失につながることも考えられるので、チーム で運用しているときは事前に確認しておきましょう。

質問やご指摘など募集中です

(マークダウン記法使えます)