PHPのimagefontwidth()関数で指定フォントの文字幅（ピクセル）を取得する方法

imagefontwidth() は、PHPに標準で組み込まれている関数の一つで、指定したフォントにおける1文字のピクセル幅を取得するために使用されます。GDライブラリを使った画像へのテキスト描画時に、文字列の配置やレイアウト計算を行う際に役立ちます。

構文

int imagefontwidth(int $font)

パラメータ

imagefontwidth() が受け取るパラメータは $font のみです。この引数にはフォントの値を指定します。PHPの組み込みフォントを使用する場合は、$font に 1〜5 のいずれかの値を指定します。また、imageloadfont() 関数で読み込んだカスタムフォントの識別子を指定することも可能です。

なお、組み込みフォントはすべて等幅（モノスペース）フォントであるため、どの文字に対しても同じ幅の値が返されます。

戻り値

imagefontwidth() は、指定されたフォントの1文字あたりのピクセル幅を整数値（int）として返します。無効なフォント値を指定した場合はエラーとなります。

使用例1：単一フォントの幅を取得する

<?php
    // フォントの値は 1〜5 の範囲で変更できます。
    echo 'Font width: '.imagefontwidth(3);
?>

出力結果

Font width: 7

使用例2：すべての組み込みフォントの幅を比較する

<?php
    // フォントの値を 1〜5 で設定して幅を確認
    echo 'フォント値 1 の幅は '.imagefontwidth(1).' ピクセルです'.'<br>';

    echo 'フォント値 2 の幅は '.imagefontwidth(2).' ピクセルです'.'<br>';

    echo 'フォント値 3 の幅は '.imagefontwidth(3).' ピクセルです'.'<br>';

    echo 'フォント値 4 の幅は '.imagefontwidth(4).' ピクセルです'.'<br>';

    echo 'フォント値 5 の幅は '.imagefontwidth(5).' ピクセルです'.'<br>';
?>

出力結果

フォント値 1 の幅は 5 ピクセルです
フォント値 2 の幅は 6 ピクセルです
フォント値 3 の幅は 7 ピクセルです
フォント値 4 の幅は 8 ピクセルです
フォント値 5 の幅は 9 ピクセルです

まとめ

このように、組み込みフォントの番号が大きくなるほど文字幅も広くなることがわかります。画像内にテキストを正確に配置したい場合は、imagefontwidth() で文字幅を、imagefontheight() で文字の高さをそれぞれ取得し、それらを掛け合わせることで文字列全体の占有サイズを事前に計算できます。