WordPressで自作する!レイアウトにこだわって作る当ブログの目次の紹介
WordPressで記事の目次を作成する場合、プラグインを利用する方法が一般的ですが、自分でPHPとCSSを書いて実装する方法もあります。目次は記事の上部に表示されるため、ページの読み込みや描画速度にも影響します。単に見た目を整えるだけでなく、HTMLの構造やDOM数、CSSの処理負荷も考慮したいところです。
今回は、WordPressのPHPでH2・H3を取得して目次を自動生成し、CSSでレイアウトを整える方法を紹介します。実装するにあたって重視したのは、HTMLの適切な構造を維持しながら、CSSをできるだけ簡素にすることです。
目次
目次のHTML構造を考える
目次のHTMLを作るとき、まず考えたいのがリストの構造です。DOM数を減らしてページの描画を軽快にすることと、SEOを考慮した適切なHTML構造を両立させる必要があります。
例えば、目次をdivやspanで構成すれば、HTMLの階層を浅くしてDOM数を減らせます。一方、目次は見出しの一覧なので、olやul、liを使ったリスト構造にするのが自然です。今回はDOM数を減らすことだけを優先せず、リストとして意味のあるHTML構造を採用しました。
H2とH3の階層構造
記事のH2とH3を目次に表示する場合、H2を親項目、H3をその子項目として扱います。ここで注意したいのが、ulやolの直下にはliを配置する必要があることです。例えば、H2の項目の下にH3の一覧を表示する場合、次のような構造になります。
<ol>
<li>
<a href="#heading1">H2の見出し</a>
<ul>
<li><a href="#heading1_1">H3の見出し</a></li>
<li><a href="#heading1_2">H3の見出し</a></li>
</ul>
</li>
</ol>
H3をまとめるulも、H2のliの中に配置します。単純にH3のリンクをH2と同じ階層に並べるのではなく、HTMLのリスト構造に合わせて組み立てることが重要です。
detailsとsummaryで開閉式にする
目次は記事の冒頭に表示されるため、記事によっては大きなスペースを占有します。そこで、detailsとsummaryを使って開閉できるようにしました。
<details open>
<summary>目次</summary>
<!-- 目次のリスト -->
</details>
detailsにopen属性を付けると、最初から展開された状態になります。属性を付けなければ閉じた状態で表示できます。今回の実装では、投稿記事では最初から展開し、固定ページでは閉じた状態にしています。
なお、CSSのGridを利用して、grid-template-rowsを1frから0frに変化させることで開閉アニメーションを実装する方法もあります。ただし、実際に試したところ、スマートフォンでは動きが滑らかにならず、カクつくことがありました。GPUによる軽快な処理を期待できる方法でもないため、今回はアニメーションを採用しませんでした。
目次と記事内の見出しにリンクを設定する
目次から記事内の該当箇所に移動できるようにするには、見出しに固有のIDを付与する必要があります。例えば、目次に次のリンクを設置した場合、
<a href="#heading1">見出し</a>
記事内の見出しには、対応するIDを設定します。
<h2 id="heading1">見出し</h2>
この仕組みを利用して、目次を生成するPHPとは別に、記事内のH2・H3にIDを付与する処理を作成しました。今回のtoc.phpでは、H2にはheading1、heading2という連番を付与し、H3にはheading1_1、heading1_2という形式でIDを付与しています。
このようにH2とH3で規則を分けることで、見出しの階層を識別しやすくしています。
CSSで目次のレイアウトを整える
目次のレイアウトで悩んだのが、見出しが複数行に折り返された場合の文字位置です。通常のリストでは、list-style-positionの設定によって表示が変わります。
outside:番号と本文が別の位置になり、折り返した文章の左端が揃うinside:番号が本文と同じ領域に入り、折り返した文章も番号の位置に揃う
outsideでは番号が区切り線の外側に出てしまい、insideでは折り返した文章の左端が番号と揃ってしまいます。区切り線を使った目次では、どちらも理想的とはいえませんでした
counterとpositionで番号を表示する
この問題を解決するために、標準のリスト番号を非表示にして、CSSのcounter-incrementで連番を表示する方法を採用しました。
.o3 {
counter-reset: s;
}
.o5 {
counter-increment: s;
position: relative;
padding: 6px 0 6px 15px;
}
.o5::before {
content: counter(s)".";
position: absolute;
left: 0;
}
list-style-type: noneで標準の番号を消し、counter-incrementで番号を管理します。番号は疑似要素の::beforeで表示し、position: absoluteを使って左側に配置します。これなら文章が折り返されても、番号の位置に影響されず、本文の左端を揃えられます。
ただし、番号が一桁の場合と二桁の場合では必要な余白が異なります。そのため、今回のCSSでは10番目以降の項目に別のクラスを付けて、左側の余白を調整しています。
区切り線と最後の項目
目次の各項目には、下側にボーダーを設定しています。
.o6 {
border-bottom: 1px solid #888;
}
ただし、最後の項目には区切り線が必要ありません。H2だけで構成される目次もあれば、H3を含む目次もあるため、単純に最後のH2だけを指定することはできません。そこで、PHPで目次を生成する際に最後の項目を判定し、o9というクラスを付与するようにしました。
.o9 {
border: none;
}
これにより、CSSで複雑な条件分岐を記述する必要がなくなります。
H3の区切り線と余白
H3を含む目次では、H2とH3のリンクが階層構造になります。このとき、H2の下にH3が存在する場合、H2のリンクには下線を引かず、H3の最後の項目まで区切り線を表示する必要があります。
また、H3のリストには左側の余白を設けるため、通常のリスト番号を使うと区切り線の位置が揃わなくなります。ここでもlist-style-type: noneとpositionを利用し、H3の項目に個別の余白を設定しました。
このように、番号や区切り線をCSSの疑似要素と位置指定で制御することで、見出しの折り返しや階層構造に対応しています。
CSSを簡素にするためにPHPでクラスを付与する
今回の目次を作成するうえで、特に重視したのがCSSの簡素化です。H3を含む場合や最後の項目など、目次にはさまざまなパターンがあります。これらをCSSだけで判定しようとすると、:has()や:nth-child()などのセレクタを使うことになります。
しかし、条件が複雑になるほどCSSの記述も増えてしまいます。Chromeのデベロッパーツールで確認すると、:has()や:nth-child()を使ったセレクタは、処理に時間がかかる場合があることも分かりました。
目次はページ上部に表示されるため、できるだけ描画処理を複雑にしたくありません。そこで、CSS側で条件を判定するのではなく、目次を生成するPHP側で必要なクラスを付与する方法に変更しました。
例えば、最後の項目にはo9、10番目以降のH2にはoaというクラスを付与しています。こうすればCSS側ではクラスを指定するだけで済みます。PHPの処理は多少複雑になりますが、生成されたHTMLをキャッシュしてしまえば、毎回同じ処理を繰り返す必要もありません。
当ブログは自作のプラグインで静的HTMLを書き出して公開しているため、PHP側の処理が多少複雑になっても、公開後のページ表示には影響しません。
PHPで目次を自動生成する
ここまでの仕組みをPHPで実装したのが、今回作成したtoc.phpです。処理は大きく分けて2つあります。
- 記事内のH2・H3を取得して、それぞれに固有のIDとクラスを付与する
- 見出しを取得して階層構造を作り、目次のHTMLを生成する
目次を表示する条件は、投稿記事と特定の固定ページに限定しています。また、H2が3つ以上ある場合に目次を生成する仕様です。PHPでは、まずH2とH3を正規表現で取得します。その後、H2を親要素、H3を子要素として配列に格納し、階層構造を作ります。
H3が存在しないH2は単独の項目として出力し、H3が存在する場合は子リストを生成します。また、H3がH2より先に登場するような構造にも対応し、親となるH2が存在しないH3は単独の項目として扱っています。こうして作成した配列をもとにHTMLを出力するため、記事ごとに見出しの数や階層が異なっていても、自動的に目次を生成できます。
最後に
WordPressの目次は、プラグインを使わなくてもPHPとCSSで自動生成できます。今回の実装では、単にDOM数を減らすことだけを考えるのではなく、リストとして適切なHTML構造を維持しながら、描画時のCSS処理をできるだけ簡素にすることを重視しました。
特に、CSSの:has()や:nth-child()などで複雑な条件判定を行うのではなく、PHP側でクラスを付与する方法は、今回のような目次の生成に適していると感じています。PHPの記述は多少複雑になりますが、静的HTMLとして公開するのであれば、生成時の処理を増やすことによるデメリットも小さくなります。
目次のように表示パターンがある程度決まっているものは、PHPでHTMLを組み立て、CSSでは装飾に専念させることで、シンプルな構成にできると考えています。
最後までお読みいただき、誠にありがとうございます。