技術資料

見出しタグ(<h1>～<h6>)が適切に使用されたブログ記事などのHTML文書の本文から、各見出しを抽出し、目次を自動生成するためのコードをPHPで書いてみました。

なぜ目次が必要なのか

目次は、長い記事や複雑な内容を持つ文書において、読者が必要な情報を素早く見つけるために非常に役立ちます。特に、技術的なドキュメントやチュートリアルでは、目次があることで読者は興味のあるセクションに直接アクセスできるため、時間の節約になります。

また、目次はSEO（検索エンジン最適化）にも寄与します。検索エンジンは、目次を通じて文書の構造を理解しやすくなり、結果として検索結果での表示が向上する可能性があります。

PHPでの目次生成コード

以下は、PHPを使用してHTML文書から目次を生成するコードの例です。このコードは、文書内の見出しタグを検出し、それらをリスト形式で返します。

また、本文内の見出しに自動的にIDを付与し、目次から直接リンクできるようにします。

function extractHeadingsFromBody($body)
{
	$headings = [];
	$modified_body = $body;
	preg_match_all('/<h([1-6])>(.*?)<\/h[1-6]>/i', $body, $matches);
	if(isset($matches[0])) {
		$id_cnt = 1;
		foreach($matches[0] as $key => $heading) {
			$level = (int)$matches[1][$key];
			$text = strip_tags($matches[2][$key]);
			$id = 'heading-' . $id_cnt;
			$headings[] = [
				'level' => $level,
				'text' => $text,
				'id' => $id
			];
			// IDを付与した新しい見出しに置換
			$new_heading = "<h{$level} id=\"{$id}\">{$matches[2][$key]}</h{$level}>";
			$modified_body = str_replace($heading, $new_heading, $modified_body);
			$id_cnt++;
		}
	}
	return [$headings, $modified_body];
}
// 使用例
$body = '<h1>はじめに</h1><p>これは目次生成のテストです。</p><h2>目次の重要性</h2><p>目次は読者にとって非常に役立ちます。</p><h3>詳細な情報</h3><p>目次があることで、必要な情報をすぐに見つけることができます。</p>';
[$headings, $modified_body] = extractHeadingsFromBody($body);

このコードの extractHeadingsFromBody 関数に、HTML文書の本文を渡すと、見出しのリストとIDを付与した新しい本文が返されます。見出しはレベル（1～6）とテキスト、IDを含む連想配列として格納されます。

見出しの出力には、 foreach ループを使用して $headings を順に処理すればOK。