カテゴリーのない記事でパンくずが止まる:get_the_terms() の false と WP_Error を確認する

トラブル・エラー対応
広告WordPress・PHP を学べる本

Amazonのアソシエイトとして、WordPress functions.phpは適格販売により収入を得ています。

エラーログを見ていたら、あるページで画面が真っ白になっていたことが分かりました。ログに残っていたのは「Object of class WP_Error could not be converted to string」というエラーで、場所はテーマのパンくずを出すファイルでした。ほかのページは問題なく出ているので、特定の記事だけで起きていたことになります。

原因:カテゴリーのない記事で、パンくずが WP_Error を文字にしていた

パンくずのコードは、記事のカテゴリーを get_the_terms() で取り、1 つずつ get_term_link() でリンクにしていました。ところが、カテゴリーが 1 つも付いていない記事では、get_the_terms() は配列ではなく false を返します。そのまま (array) で配列にして回すと、内容が false の 1 件として回ってしまいます。

false を get_term_link() に渡すと、URL の代わりに WP_Error が返ります。それを文字列につなごうとしたところで PHP 8 の致命的エラーになり、画面が止まっていました。

// 直す前:カテゴリーがないと $terms は false になる
$terms = get_the_terms( get_the_ID(), 'category' );
foreach ( (array) $terms as $term ) {
	// $term が false のまま get_term_link() に渡り、WP_Error が返る
	echo '<a href="' . get_term_link( $term ) . '">' . esc_html( $term->name ) . '</a>';
}

get_the_terms() が返すもの

  • カテゴリーやタグが付いている:WP_Term の配列
  • 1 つも付いていない:false
  • 分類(タクソノミー)の名前が間違っている:WP_Error

直し方:配列のときだけ回し、リンクも WP_Error なら出さない

直し方は 2 つです。get_the_terms() の結果が空か WP_Error なら回さないことと、get_term_link() の結果が WP_Error ならその 1 件を出さないことです。親のカテゴリーのリンクを出している所や、カスタムの分類を出している所も、同じ形にそろえておくと安心です。

$terms = get_the_terms( get_the_ID(), 'category' );
// カテゴリーがない(false)・分類の名前が違う(WP_Error)ときは回さない
if ( $terms && ! is_wp_error( $terms ) ) {
	foreach ( $terms as $term ) {
		$link = get_term_link( $term );
		// リンクが作れないものは、その 1 件だけ出さない
		if ( is_wp_error( $link ) ) {
			continue;
		}
		echo '<a href="' . esc_url( $link ) . '">' . esc_html( $term->name ) . '</a>';
	}
}

本番から複製した作業環境で、カテゴリーのない記事を開いて確認しました。直す前は 500 のエラーでしたが、直したあとは「ホーム › 記事のタイトル」のパンくずで表示されました。カテゴリーのあるふつうの記事は、パンくずの HTML が直す前とまったく同じであることも確認しています。

もう 1 つ:URL で分けていると、404 のページで $post が null になる

別のサイトのパンくずでは、同じころ「Attempt to read property “ID” on null」という Warning が何度も出ていました。こちらは画面は止まりませんが、エラーログが毎日増えていきます。

このテーマは、URL に特定の文字(カスタム投稿の一覧のパス)が入っているかでパンくずを分けていました。そのため、消した記事の URL やクエリ付きの URL で 404 になったページでも同じ枝に入り、$post が null のまま $post->ID を読んでいたのが原因です。最後の項目(記事のタイトル)を、$post が WP_Post のときだけ出すように直しました。

<?php
// URL だけで分けているので、ないページ(404)などでは $post が null になる
// そのときは一覧までで止め、記事のタイトルは出さない
if ( $post instanceof WP_Post ) :
?>
	<li><span><?php echo esc_html( get_the_title( $post->ID ) ); ?></span></li>
<?php endif; ?>

気をつけること

  • get_the_terms()・get_term_link()・get_permalink() などは、失敗すると false や WP_Error を返す。文字列につなぐ前に必ず確認する
  • カテゴリーのない記事は、DB に直接追加した記事や、カテゴリーを使わない投稿タイプで同じパンくずを使ったときに起きやすい
  • URL の文字だけでページの種類を分けると、404 のページも同じ枝に入る。is_singular() などの条件か、$post の内容で分けるほうが確実
  • Warning は画面が止まらないので気づきにくい。エラーログを定期的に見て、新しい種類が出ていないかを確認する

SiteBeacon(サイトビーコン)

サイトが止まったら、すぐに気づける。

ホームページを 5 分ごとにチェックして、止まったとき・エラーが出たとき・SSL やドメインの期限が近いときに、メールでお知らせします。2 サイトまでは、ずっと無料で使えます。

SiteBeacon を見る サイトを直す相談をする

監視で気づいたあとの直す作業も、同じ担当がお受けします。