PHPで共通パーツを効率的に管理する絶対パスを使ったインクルードの活用法

  • PHP

Webサイトを構築する際、共通パーツ（ヘッダー、フッター、サイドバーなど）を効率的に管理することは非常に重要です。特に、ディレクトリ階層が複雑な場合、各ページで共通パーツをインクルードする記述が煩雑になりがちです。この記事では、$_SERVER[‘DOCUMENT_ROOT’]を利用して、どのディレクトリからでも一貫して共通パーツを読み込める方法をご紹介します。

共通パーツの構成と課題

今回の例では、以下のような構成のコーポレートサイトを想定します。

/
├── index.php
├── about/
│└── index.php
├── services/
│└── details.php
└── includes/
├── head.php
├── header.php
├── footer.php
└── sidebar.php

「includes」フォルダには共通パーツが格納されています。この構成では、どのページからでもこれらの共通パーツをインクルードできる仕組みが必要です。

一般的には以下の2つの方法が考えられます：

  1. 相対パスを使う方法
  2. 絶対パスを使う方法

2019.11.03

2023.07.06

PHP「include（インクルード）」関数で共通部分を一元管理：Web制作の基礎知識

PHPとは動的にWebページを生成することができるサーバーサイドのスクリプト言語です。動的なWebページとは、頻繁に更新する新着情報やユーザ...

相対パスの課題

相対パスを使う場合、ファイルのディレクトリ構成に応じてパスを記述する必要があります。

▼相対パス記述例

<?php include("../includes/header.php"); ?>
<?php include("../../includes/footer.php"); ?>

このように、階層が増えるたびに ../ や ../../ を使い分ける必要があり、ファイル構成が変わるたびに修正が必要になるため、保守性に欠けます。

絶対パスで効率化する方法

上記の課題を解決するために、$_SERVER[‘DOCUMENT_ROOT’]を利用して絶対パスを指定する方法がおすすめです。$_SERVER[‘DOCUMENT_ROOT’]は、現在のサーバー環境でWebルートディレクトリを示す変数です。これを利用することで、どのディレクトリからでも統一的に共通パーツを読み込むことができます。

▼絶対パス記述例

<?php include($_SERVER['DOCUMENT_ROOT'] . '/includes/header.php'); ?>
<?php include($_SERVER['DOCUMENT_ROOT'] . '/includes/footer.php'); ?>
  1. 階層を意識しなくて良い
    各ページの階層に関係なく、すべて同じ記述で済みます。
  2. 保守性が高い
    ファイル構成を変更しても、一括置換が簡単に行えるため、修正の手間を大幅に削減できます。
  3. 可読性の向上
    パスの長さが統一されることで、コードが見やすくなります。

まとめ

$_SERVER[‘DOCUMENT_ROOT’]を使ったインクルードは、階層構造が複雑なサイトでも共通パーツを効率的に管理できる非常に便利な方法です。保守性や可読性の向上にも寄与するため、特に大規模なサイトや多階層のプロジェクトでは積極的に活用することをおすすめします。

これを機に、PHPでのコーディング効率をさらに高めてみてはいかがでしょうか。

関連記事

TOP
TOP