【PHP8.x】link関数の使い方

link関数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

link関数は、指定された既存のファイルに対し、新たなハードリンクを作成する関数です。ハードリンクとは、ファイルシステム上で一つのファイルの実体を、複数の異なる名前(パス)で参照できるようにする仕組みです。これにより、同じデータ内容を持つファイルを、複数の異なる場所から利用できるようになります。

この関数は、リンク元となる既存のファイルパスをtarget引数で、新しく作成するハードリンクのパスをlink引数で指定します。処理が成功した場合はtrueを、失敗した場合はfalseを返します。例えば、特定のファイルを複数のアプリケーションやユーザーが異なるパスから参照したい場合などに活用できます。

ハードリンクの重要な特徴として、元のファイルと作成されたハードリンクは、どちらもファイルシステム上の同じデータブロックを指します。そのため、どちらか一方の内容を変更すると、もう一方からも同じ変更が反映されます。また、どちらか一方のリンクを削除しても、もう一方のリンクが残っていればファイルの実データは削除されません。ファイルの実データが完全に削除されるのは、そのファイルを指すすべてのハードリンクが削除され、参照カウントがゼロになった時です。

ただし、ハードリンクは同じファイルシステム内でのみ作成可能であり、異なるファイルシステムをまたいで作成することはできません。また、セキュリティとファイルシステムの整合性を保つため、ディレクトリに対してハードリンクを作成することはできませんのでご注意ください。この機能は、データの重複を避けつつ、ファイルに複数のアクセスポイントを提供したい場合に有用です。

構文(syntax)

1<?php
2link(string $target, string $link): bool
3?>

引数(parameters)

string $target, string $link

  • string $target: リンク先のURLまたはパスを指定する文字列
  • string $link: 表示するリンクテキストを指定する文字列

戻り値(return)

bool

指定された条件に従い、PHPのlink関数の戻り値の説明を生成します。

link関数は、指定されたURLへのリンクの作成に成功したかどうかを示す真偽値(bool)を返します。成功した場合はtrue、失敗した場合はfalseを返します。

サンプルコード

PHPのlink()関数でページへのハードリンクを作成する

1<?php
2
3/**
4 * ファイルシステムのハードリンクを作成します。
5 * 既存のファイルへの新しいパスを作成し、その新しいパス(リンク名)で元のファイルと同じコンテンツにアクセスできるようにします。
6 * これはWebページのハイパーリンクとは異なり、ファイルシステムレベルで機能します。
7 *
8 * @param string $target 元となるファイルパス (例: 'source.php')
9 * @param string $link 作成する新しいリンクのファイルパス (例: 'another_page.php')
10 * @return bool 成功した場合は true、失敗した場合は false
11 */
12function createPageLink(string $target, string $link): bool
13{
14    // ターゲットファイルが存在するか確認します
15    if (!file_exists($target)) {
16        echo "エラー: ターゲットファイル '{$target}' が見つかりません。\n";
17        return false;
18    }
19
20    // 作成しようとしているリンク名が既に存在するか確認します
21    if (file_exists($link)) {
22        echo "エラー: リンク名 '{$link}' は既に存在します。上書きは行いません。\n";
23        return false;
24    }
25
26    // link() 関数を使用してハードリンクを作成します
27    if (link($target, $link)) {
28        echo "ハードリンク '{$link}' を '{$target}' に作成しました。\n";
29        // これにより、Webサーバー経由で '{$link}' にアクセスすると '{$target}' と同じ内容が表示されます。
30        return true;
31    } else {
32        echo "エラー: ハードリンク '{$link}' の作成に失敗しました。\n";
33        return false;
34    }
35}
36
37// --- サンプルコードの実行例 ---
38
39// ハードリンクの元となるターゲットファイルを作成します
40$targetFileName = 'original_content.php';
41// ファイルにPHPコードを書き込みます
42file_put_contents($targetFileName, '<?php echo "これは元のページの内容です。"; ?>');
43echo "ターゲットファイル '{$targetFileName}' を作成しました。\n";
44
45// このターゲットファイルへのハードリンクを作成します
46// これにより、'another_page.php' という名前で 'original_content.php' と同じ内容にアクセスできるようになります
47$linkedPageName = 'another_page_link.php';
48$success = createPageLink($targetFileName, $linkedPageName);
49
50// リンク作成が成功した場合、Webサーバーでの動作についてヒントを表示します
51if ($success) {
52    echo "Webサーバーを起動し、ブラウザで 'http://localhost/{$linkedPageName}' (またはあなたのWebサーバー設定に応じたパス) にアクセスしてみてください。\n";
53    echo "表示される内容は '{$targetFileName}' に直接アクセスした場合と同じです。\n";
54}
55
56// --- クリーンアップ (オプション) ---
57// サンプルコード実行後に作成したファイルを削除する場合は、以下の行のコメントを解除してください。
58// 実際のシステムでは、作成したファイルを自動で削除することは通常ありません。
59// if (file_exists($targetFileName)) {
60//     unlink($targetFileName);
61//     echo "ターゲットファイル '{$targetFileName}' を削除しました。\n";
62// }
63// if (file_exists($linkedPageName)) {
64//     unlink($linkedPageName);
65//     echo "リンクファイル '{$linkedPageName}' を削除しました。\n";
66// }
67
68?>

PHPのlink関数は、ファイルシステム上でハードリンクを作成するための関数です。ハードリンクとは、既存のファイルに新しい名前(パス)を割り当てることで、両方のパスからディスク上の同じコンテンツにアクセスできるようにする仕組みです。これはWebページ間のハイパーリンクとは異なり、ファイルシステムレベルで動作します。

引数$targetにはハードリンクの元となる既存のファイルパスを、$linkには新しく作成するハードリンクのファイルパスを指定します。関数が成功した場合はtrueが、失敗した場合はfalseが戻り値として返されます。

サンプルコードでは、createPageLink関数を使ってlink関数の利用方法を示しています。まずoriginal_content.phpというPHPファイルを生成し、そのファイル内容を記述します。次に、another_page_link.phpという名前でoriginal_content.phpへのハードリンクを作成します。このリンクが成功すると、Webサーバー経由でanother_page_link.phpにアクセスした場合、original_content.phpと全く同じ内容が表示されます。これは、ファイルシステムの観点から両方のファイルパスが同じ物理的なデータブロックを指しているためで、これにより、複数の異なる名前で同じコンテンツを効率的に提供することが可能です。

このlink関数はWebページのハイパーリンクではなく、ファイルシステム上で既存ファイルへの「ハードリンク」を作成します。これにより、複数のパスから同じファイルの内容にアクセスできますが、異なるファイルシステム(パーティション)間での作成はできません。PHPの実行ユーザーには、リンク先のディレクトリへの書き込み権限と、元ファイルへの読み取り権限が必要です。サンプルコードのように、リンク名が既に存在しないか、ターゲットファイルが存在するかを確認することで、意図しない上書きやエラーを防ぐことができます。本番環境では、相対パスではなく絶対パスでファイルパスを指定すると、より安全で予測可能な動作が期待できます。

関連コンテンツ