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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * getimagesize() 関数の使い方を示すサンプル関数です。
7 *
8 * この関数は、画像の情報を取得する成功例と、
9 * 存在しないファイルで失敗する例の両方を実行します。
10 * 単体で動作するように、画像データはコード内に埋め込んでいます。
11 */
12function demonstrateGetImageSize(): void
13{
14    // --- 成功例 ---
15    // Data URI スキームを使用した1x1ピクセルのPNG画像データ。
16    // これにより、実際の画像ファイルがなくてもコードを試すことができます。
17    $validImageUri = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=';
18
19    echo "--- 成功例の実行 ('Data URI') ---" . PHP_EOL;
20    // @演算子は、ファイルが見つからない等の警告を抑制し、戻り値でエラーをハンドリングするためのお作法です。
21    $imageInfo = @getimagesize($validImageUri);
22
23    // getimagesize() は成功すると画像の情報を配列で、失敗すると false を返します。
24    if ($imageInfo !== false) {
25        // 取得した配列から情報を抽出します。
26        // PHP 7.1以降は連想キー ($imageInfo['width']) も利用できます。
27        $width  = $imageInfo[0];
28        $height = $imageInfo[1];
29        $mime   = $imageInfo['mime'];
30
31        echo "幅: {$width}px" . PHP_EOL;
32        echo "高さ: {$height}px" . PHP_EOL;
33        echo "MIMEタイプ: {$mime}" . PHP_EOL;
34    } else {
35        echo "画像情報の取得に失敗しました。" . PHP_EOL;
36    }
37    echo PHP_EOL; // 見やすくするための改行
38
39
40    // --- 失敗例 ---
41    // 存在しないファイルパスを指定します。
42    $invalidFilePath = 'path/to/non_existent_image.jpg';
43
44    echo "--- 失敗例の実行 ('{$invalidFilePath}') ---" . PHP_EOL;
45    $errorInfo = @getimagesize($invalidFilePath);
46
47    if ($errorInfo === false) {
48        // 意図通り false が返ってくることを確認します。
49        echo "画像情報の取得に失敗しました。" . PHP_EOL;
50        echo "(ファイルが存在しないか、サポートされていない形式のため)" . PHP_EOL;
51    } else {
52        echo "予期せず画像情報が取得されました。" . PHP_EOL;
53    }
54}
55
56// サンプル関数を実行します。
57demonstrateGetImageSize();

PHPのgetimagesize関数は、画像ファイルのサイズ（幅と高さ）や形式（MIMEタイプ）などの情報を取得するための関数です。第一引数に、情報を取得したい画像ファイルのパスやURLを文字列として指定します。

この関数の戻り値は、処理が成功したか失敗したかによって異なります。画像の情報を正しく取得できた場合は、幅、高さ、MIMEタイプといった情報を含む配列を返します。一方で、指定されたファイルが存在しない、またはPHPがサポートしていない画像形式だった場合にはfalseを返します。

サンプルコードでは、この関数の成功例と失敗例を具体的に示しています。成功例では、Data URIスキームという形式でコード内に直接埋め込まれたPNG画像の情報を取得し、その幅、高さ、MIMEタイプを表示しています。失敗例では、意図的に存在しないファイルパスを指定することで、関数がfalseを返し、画像情報の取得に失敗する様子を確認できます。なお、関数呼び出しの先頭にある@記号は、ファイルが見つからない等の警告メッセージの出力を抑制し、戻り値がfalseであるかどうかでエラーを判断するための一般的な手法です。

Copy
1<?php
2
3/**
4 * 指定されたファイルの画像サイズ情報を安全に取得します。
5 * getimagesize() が失敗する一般的なケースを処理し、原因を特定します。
6 *
7 * @param string $filePath 画像ファイルへのパスまたはURL。
8 * @return void
9 */
10function displayImageSizeInfo(string $filePath): void
11{
12    echo "--- チェック対象: '{$filePath}' ---" . PHP_EOL;
13
14    // file_exists() はローカルファイルにのみ有効。URLの場合は常にfalseを返す。
15    // そのため、まずはURLかどうかを判定する。
16    $isUrl = filter_var($filePath, FILTER_VALIDATE_URL);
17
18    // ローカルファイルの場合、存在と読み取り権限を確認する
19    if (!$isUrl) {
20        if (!file_exists($filePath)) {
21            echo "結果: 失敗 (原因: ローカルファイルが存在しませんでした)" . PHP_EOL;
22            return;
23        }
24        if (!is_readable($filePath)) {
25            echo "結果: 失敗 (原因: ローカルファイルの読み取り権限がありませんでした)" . PHP_EOL;
26            return;
27        }
28    }
29
30    // getimagesize() が失敗した場合に E_WARNING が発生するのを抑制するため、
31    // エラー制御演算子(@)を使用します。エラーハンドリングは戻り値で行います。
32    // タイムアウトを設定するためにストリームコンテキストを使用することもできます。
33    $context = stream_context_create([
34        'http' => [
35            'timeout' => 5, // タイムアウトを5秒に設定
36        ],
37    ]);
38    $imageInfo = @getimagesize($filePath, [], $context);
39
40    // getimagesize() は、情報の取得に失敗した場合に false を返します。
41    // === を使って厳密に比較することが重要です。
42    if ($imageInfo === false) {
43        echo "結果: 失敗 (原因: 画像として認識できない、またはリモートサーバーから取得できませんでした)" . PHP_EOL;
44        if ($isUrl) {
45            echo "補足: URLの場合、allow_url_fopenディレクティブがphp.iniで有効になっている必要があります。" . PHP_EOL;
46        }
47        return;
48    }
49
50    // 成功した場合、取得した情報を表示
51    echo "結果: 成功" . PHP_EOL;
52    echo "  幅: " . $imageInfo[0] . "px" . PHP_EOL;
53    echo "  高さ: " . $imageInfo[1] . "px" . PHP_EOL;
54    echo "  MIMEタイプ: " . $imageInfo['mime'] . PHP_EOL;
55}
56
57// --- 実行例 ---
58
59// 1. 存在しないファイルのパスを指定した場合
60$nonExistentFile = 'path/to/non_existent_image.jpg';
61displayImageSizeInfo($nonExistentFile);
62echo PHP_EOL;
63
64// 2. 画像ではないファイルのパスを指定した場合
65$notAnImageFile = 'not_an_image.txt';
66// テスト用に空のテキストファイルを作成
67file_put_contents($notAnImageFile, 'This is not an image.');
68displayImageSizeInfo($notAnImageFile);
69unlink($notAnImageFile); // テスト用ファイルを削除
70echo PHP_EOL;
71
72// 3. 存在しないURLを指定した場合 (ネットワーク状況により時間がかかることがあります)
73//    php.iniで allow_url_fopen=On が設定されている必要があります。
74$invalidUrl = 'https://example.com/invalid-image.png';
75displayImageSizeInfo($invalidUrl);
76echo PHP_EOL;
77
78// 4. 正常に取得できるケース (1x1の透過GIF画像をデータURIで指定)
79$validImageUri = 'data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7';
80displayImageSizeInfo($validImageUri);
81
82?>

PHPのgetimagesize関数は、引数で指定した画像ファイルの幅、高さ、MIMEタイプといった情報を取得します。第一引数には、ローカルファイルのパスまたはインターネット上の画像のURLを文字列で指定します。関数が成功すると画像の情報を格納した配列を返し、失敗した場合はfalseを返します。このため、戻り値を=== falseのように厳密に比較して、処理の成否を判定することが重要です。

このサンプルコードは、getimagesizeが失敗する、つまり画像情報を取得できない一般的な原因とその対処法を示しています。例えばローカルファイルの場合、file_exists関数でファイルの存在を、is_readable関数で読み取り権限を事前に確認しています。指定したファイルがPHPで認識できない画像形式だった場合も失敗の原因となります。

対象がURLの場合は、サーバーにアクセスできなかったり、PHPの設定ファイル（php.ini）にあるallow_url_fopenという設定項目が有効でなかったりすると情報を取得できません。サンプルコードでは、getimagesizeが失敗した際に警告メッセージが表示されるのを防ぐため、関数の前にエラー制御演算子@を付けています。これにより、プログラムの実行を妨げることなく、戻り値によるエラーハンドリングに集中できます。このように、事前に原因となりうる箇所を確認することで、なぜ画像情報を取得できないのかを正確に把握できます。