WordPressを静的なHTMLとして配信
マーケティングサイトやドキュメントサイトの多くのページは、匿名の訪問者には同じ内容を表示します。それでもWordPressはリクエストごとに起動し、すべてのプラグインを読み込み、テーマを実行してブロックをレンダリングします。ページキャッシュプラグインは役立ちますが、安全に保存できる内容を独自のルールで判断するため、管理要素が1つ増えます。
Blockstudioには、オプトイン方式の静的プリレンダリングが組み込まれています。匿名ユーザー向けのHTMLドキュメントを専用のキャッシュディレクトリに保存し、許可するとWordPressの起動前にadvanced-cache.phpドロップインから配信します。設定はすべてblockstudio.jsonで行います。
このガイドでは、機能を有効にする手順、キャッシュ対象と対象外の確認方法、ログイン中の訪問者を保護するルールを説明し、オリジンがキャッシュ可能と指定したコンテンツだけをキャッシュするCDNの設定で締めくくります。
リクエストの配信方法
プリレンダリングを有効にすると、対象となるリクエストは次の3つのいずれかになります。
- 早期ヒット。 ドロップインがルートマップ内の保存済みドキュメントを見つけると、WordPressの読み込み前にそのまま配信します。レスポンスには
X-Blockstudio-Static-Prerender: HIT-EARLYが付きます。 - ヒット。 WordPressが起動し、
template_redirectでBlockstudioが新しい保存済みドキュメントを見つけると、テンプレートをレンダリングせずにそれを送信します。レスポンスにはX-Blockstudio-Static-Prerender: HITが付きます。 - ミス。 WordPressが通常どおりページをレンダリングします。訪問者が匿名で、結果が完全なHTMLドキュメントかつステータスが200の場合、Blockstudioが次のリクエスト用に保存します。
対象外のリクエストは、キャッシュに一切アクセスしません。
ステップ1:プロファイルとキャッシュを有効化
まず、パフォーマンスプロファイルとプリレンダリングを有効にし、早期配信は無効にします。
{
"$schema": "https://blockstudio.dev/schema/blockstudio",
"performance": {
"profile": "speed",
"staticPrerender": {
"enabled": true,
"ttl": 86400,
"earlyServe": false,
"dynamicPaths": ["/account", "/checkout", "/login"],
"warm": {
"enabled": true,
"interval": 900,
"concurrency": 4
}
}
}
}
各設定の役割:
profile: "speed"は、本番フロントエンドの既定設定を有効にします。headのノイズ、oEmbedの検出、XML-RPC、汎用コアフロントエンドアセットを削除し、同一オリジンのリンクは操作の意図に応じてプリフェッチします。コアフロントエンドアセットの削除に依存するページは目に見えて壊れるため、最初にこの設定をテストしてください。個別の子設定はプロファイルより優先されます。staticPrerender.enabledはランタイムを登録します。falseの間、この機能はファイルを書き込まず、リクエストフックも登録しません。ttlは保存済みドキュメントの最大有効期間を秒単位で指定します(既定値は86400)。dynamicPathsには、常に動的にレンダリングするパスのプレフィックスを指定します。warmは、古くなった公開URLをinterval秒ごとに再レンダリングするバックグラウンドウォーマーをスケジュールします。
$schemaの行で全キーを指定しているため、JSONのスキーマサポートがあるエディターでは、最小値が1なのに"ttl": 0を指定するなどのミスを検出できます。
ステップ2:キャッシュ対象を確認
Blockstudioは、保存対象を慎重に限定します。次のリクエストは常にキャッシュを迂回します。
GET以外のもの- クエリ文字列を含むURL
wp-admin、wp-json、wp-login.php、xmlrpc.php、Ajax、cron- フィード、検索、プレビューパス
X-WP-Nonceヘッダーを送信するリクエストdynamicPaths以下のパスserveLoggedInが有効でない限り、wordpress_logged_in_*、wp-postpass_*、comment_author_email_*のいずれかのCookieを持つ訪問者
動的パスは、パスの境界で照合されます。上記の設定では、次のようになります。
| リクエスト | 迂回 |
|---|---|
/pricing/ |
いいえ |
/account/orders/ |
はい |
/accounting/ |
いいえ |
/checkout |
はい |
/pricing/?utm_source=x |
はい |
/blog/feed/ |
はい |
保存されるのは完全なドキュメントだけです。レスポンスは<!doctype htmlまたは<htmlで始まり、ステータスが200で、オプトアウトマーカーを含まない必要があります。保存対象にしたくないテンプレートでは、ページ内のどこかにマーカーを出力できます。
<!-- blockstudio:no-cache -->
エラーページは保存されないため、テーマ適用済みの404が成功レスポンスとして再利用されることはありません。
ステップ3:ヒットを確認
プライベートウィンドウでいくつかのページを開き、Blockstudioに保存内容を確認します。
wp bs prerender status
{
"enabled": true,
"invalidate": "signature",
"identity": "e6cdd3fcda14ad6ded85a763bd01a33b",
"cacheRoot": ".../wp-content/blockstudio/cache/sites/.../static-prerender",
"files": 0,
"bytes": 0,
"records": 0,
"queue": {
"pending": 0,
"processing": 0,
"done": 0,
"unique": 0,
"bytes": 0
},
...
"diagnostics": []
}
ドキュメントの保存に伴いfilesとbytesが増加し、queueにはウォーマーの未処理件数が表示されます。diagnosticsでは、スコープごとのヒット、ミス、ビルド、失敗のカウンターを確認できます。特定のページを確認するには、匿名の訪問者として2回リクエストし、次のヘッダーを探します。
curl -s -o /dev/null -D - https://example.com/pricing/ | grep -i x-blockstudio-static-prerender
2回目のレスポンスにはX-Blockstudio-Static-Prerender: HITが付きます。上記のとおりGETを使ってください。curl -IはHEADリクエストを送信し、これは常にキャッシュを迂回します。
ステップ4:WordPressの起動前に配信
ヒットが正常に確認できたら、"earlyServe": trueを設定します。するとBlockstudioが、wp-content/advanced-cache.phpドロップイン、共有のwp-content/blockstudio-static-prerender-map.phpルートマップ、wp-config.php内のWP_CACHE宣言という3つの小さな状態を管理します。これらは次回の管理者リクエスト時にインストールされます。
共有ホスティングやマルチサイトでも安全に使えるよう、いくつかのルールがあります。
- Blockstudioは、自身が所有していないドロップイン、マップ、
WP_CACHEの行を上書きしません。別のキャッシュプラグインがすでにadvanced-cache.phpを所有している場合、早期配信は無効のままです。 WP_CACHEがすでにtrueとして定義されている場合、wp-config.phpには手を加えません。wp-config.phpを書き込み可能でないホストでは、自分で定義してください。- 配信前に、ドロップインとPHPパスの両方で、ドキュメントがリンクするコンテンツハッシュ付きのTailwindスタイルシートが存在するかを確認します。存在しない場合、スタイルが適用されない状態で配信する代わりに、リクエストはWordPressへ送られます。
- マルチサイトのエントリーは1つのマップを共有しますが、ホスト、ホームパス、サイトIDごとに分離されます。
Linkがデフォルトで指定するreplayHeaders内のレスポンスヘッダーは、各ドキュメントとともに保存され、キャッシュヒットごとに再送信されます。そのため、ページがheader()とともに送信するLinkヘッダーは早期配信でも維持されます。Cookieとキャッシュのヘッダーは再送信されません。
早期ヒットにはX-Blockstudio-Static-Prerender: HIT-EARLYが付きます。earlyServeまたはenabledを無効にすると、Blockstudioが管理する状態が一度削除されます。無効化フックのないComposerインストールでは、wp bs teardownを使って明示的に削除できます。
ログイン中の訪問者と同一のマークアップ
既定では、ログイン中の訪問者には常に動的にレンダリングしたページを配信します。"serveLoggedIn": trueを設定すると、保存済みドキュメントも利用できるため、編集者や顧客にも匿名の訪問者と同じ速度でサイトを表示できます。
パーソナライズされたレスポンスがキャッシュ項目を作ることはありません。ログイン中の訪問者のキャッシュミスは動的にレンダリングされ、保存されません。見落としやすい点があります。serveLoggedInが有効な場合、ログイン中の訪問者には匿名用ドキュメントがあればそれが配信され、なければパーソナライズされたページが動的にレンダリングされます。そのため、現在のユーザーに応じたテンプレート分岐はキャッシュミス時にしか表示されず、訪問ごとにページの内容が変わります。キャッシュ対象のルートでは、パーソナライズされた分岐は事実上機能しません。
これに伴うルールは次のとおりです。dynamicPaths以外のすべてのルートで、ログイン中の訪問者と匿名の訪問者に表示するマークアップはバイト単位で同一でなければなりません。静的ルートでレンダリングされるテンプレートに、is_user_logged_in()やwp_get_current_user()を使った分岐を入れないでください。
<?php // Do not do this on a static route. ?>
<?php if ( is_user_logged_in() ) : ?>
<a href="/account/">Hi, <?php echo esc_html( wp_get_current_user()->display_name ); ?></a>
<?php else : ?>
<a href="/login/">Sign in</a>
<?php endif; ?>
解決方法は2つあります。ページ全体が個人向けの内容であるアカウントダッシュボードなどは、そのルートをdynamicPathsに移します。または、ページを静的なままにして、パーソナルな部分を動的ブロックアイランドとしてレンダリングします。保存済みのHTMLにはキャッシュに安全なプレースホルダーを格納し、訪問者自身のリクエストで実際のフラグメントを取得します。
<?php echo bs_block( array( 'name' => 'acme/greeting' ) ); ?>
キャッシュされたページのパーソナライズドフラグメントガイドでは、このブロックの作り方を説明しています。
シグネチャまたはグラフによる無効化
invalidateで、保存済みドキュメントの有効期限の決め方を選びます。
| 項目 | signature(既定) |
graph |
|---|---|---|
| キャッシュを埋めるもの | 匿名ユーザーのミスとウォーマー | ビルド工程と匿名ユーザーのミス |
| 項目の期限切れ | TTL、投稿の保存、サイトレベルの変更 | 新しいビルド(TTLは上限) |
| バックグラウンドウォーマー | 利用可能 | 無効 |
| 適したサイト | 一般的なサイト | デプロイパイプラインのあるサイト |
signatureモードでは、ツールは不要です。投稿を保存すると、ホームページとその投稿のパーマリンクがパージまたは再ウォームされます。また、テーマの切り替えなどサイトレベルの変更時には、キャッシュIDが更新されます。
graphモードは決定論的なデプロイ用です。ビルドでStatic_Prerender_Runtime::build_plan()を使ってプランを計算し、影響を受けるURLだけをレンダリングして各結果を記録した後、Static_Prerender_Early_Serve::install_artifact_entry()で完成した一式をアトミックに有効化します。参照先のドキュメントの検証に失敗した場合は、以前の一式が引き続き有効です。マッピングされたルートは、次のビルドで置き換えられるまで有効化済みの成果物から配信されるため、wp-adminで編集したコンテンツは次回のデプロイ時にそれらのルートへ反映されます。このモードでは成果物を一つの単位としてビルドして有効化するため、URLごとのウォーマーはオフになります。本番環境での典型的な構成は次のとおりです。
{
"performance": {
"profile": "speed",
"staticPrerender": {
"enabled": true,
"invalidate": "graph",
"ttl": 2592000,
"earlyServe": true,
"serveLoggedIn": true,
"dynamicPaths": [
"/account",
"/cart",
"/checkout",
"/login",
"/reset-password"
]
}
}
}
30日間のttlは、配信されるドキュメントの経過日数の上限を定めるだけです。鮮度はグラフを再構築するデプロイによって保たれます。ビルドのAPI、シャーディング、内部レンダリング用トランスポートについては、Static Prerendering リファレンスを参照してください。
手前にCDNを配置する
プリレンダリングによって、安全に共有できるレスポンスがわかります。HITヘッダーが付いているものだけです。オリジン側でそれをキャッシュヘッダーに変換し、CDNをオリジンに追従させます。PHP-FPMの前段にnginxを置く場合は、次のようにします。
map $upstream_http_x_blockstudio_static_prerender $edge_cache_control {
"~^HIT" "public, s-maxage=604800";
default "";
}
server {
listen 80;
server_name example.com;
root /var/www/html;
index index.php;
location / {
try_files $uri $uri/ /index.php?$args;
}
location ~ \.php$ {
include fastcgi_params;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
fastcgi_pass unix:/run/php/php-fpm.sock;
add_header Cache-Control $edge_cache_control;
}
}
正規表現はHITとHIT-EARLYの両方に一致します。それ以外のレスポンスでは変数が空になり、nginxは値が空のヘッダーを追加しないため、キャッシュミス、動的パス、ログイン済みユーザー向けのレンダリングでは、オリジンに共有キャッシュの有効期間が設定されません。
CDN側では、次のようにします。
- オリジンがキャッシュ有効期間を送信する場合に限り、HTMLをキャッシュします。有効期間が設定されていないレスポンスには、デフォルトのエッジTTLを無効にします。
- Blockstudioが個人向けとみなすのと同じCookie(
wordpress_logged_in_、wp-postpass_、comment_author_email_)、およびdynamicPaths、wp-admin、wp-jsonでは、エッジをバイパスします。 - ページ、テンプレート、アセットに変更を加えるデプロイのたびに、CDNをパージします。オリジンキャッシュは自動的にローテーションしますが、エッジ側ではその必要性を認識できません。
Tailwindを"output": "link"で使う場合、スタイルシートURLのパスにはコンテンツハッシュが含まれるため、長期間のimmutableキャッシュヘッダーを設定して配信できます。
メンテナンス用コマンド
wp bs prerender warm
wp bs prerender status
wp bs prerender purge
wp bs teardown
warmは古くなった公開URLをキューに追加し、1回の実行で最大warm.concurrency件をレンダリングして、JSONの概要を出力します。purgeは現在のサイトの保存済みドキュメントとキューを削除します。teardownは、このインストールが所有するcronイベントと早期配信状態を削除し、設定ファイルはそのまま残します。
次の順序で段階的に導入します。まずプロファイル、次にearlyServeをオフにしたプリレンダリング、最後にstatusとヘッダーが正しく動作することを確認してから早期配信を有効にします。各レイヤーは設定値を元に戻すことで個別にロールバックできます。
次のステップ
- Static Prerendering リファレンス:グラフのビルド、成果物の有効化、保持、可観測性フック。
- パフォーマンス:
speedプロファイルで変わる点と測定方法。 - キャッシュ:保存済みドキュメントがすべて格納されるキャッシュディレクトリ。
- キャッシュ済みページ上の個人向けフラグメント:静的ルート上で訪問者ごとに異なるコンテンツを表示する方法。
- Blockstudioサイトのデプロイ:リリース時にページの同期、パージ、ウォームアップを行う箇所。