説明

imageftbbox(
    float $size,
    float $angle,
    string $font_filename,
    string $string,
    array $options = []
): array|false

この関数は FreeType テキスト用のバウンディングボックスをピクセル単位で算出し、それを返します。

注意:
PHP 8.0.0 より前のバージョンでは、 imageftbbox() は、 imagettfbbox() を拡張したものでした。追加で options をサポートしていました。 PHP 8.0.0 以降では、 imagettfbbox() は imageftbbox() のエイリアスになっています。

パラメータ

size

ポイント数単位のフォントサイズ。

angle

string を取得する角度。

font_filename

TrueType フォントのファイル名 (URL も可)。 PHP が使用している GD ライブラリのバージョンにも依存しますが、先頭に '/' がついていないファイル名を渡した場合はファイル名の末尾に '.ttf' を追加して GD のフォントパスからファイルを探そうとすることもあります。

string

取得したい文字列。

options

options の配列のインデックス

キー型意味

linespacing float 描画時の行間を定義します

**`options` の配列のインデックス**
キー	型	意味
`linespacing`	float	描画時の行間を定義します

戻り値

imageftbbox() は 8 つの要素からなる配列を返します。これが、テキストを囲む箱の 4 つの角の座標を表します。

0 左下角の X 座標

1 左下角の Y 座標

2 右下角の X 座標

3 右下角の Y 座標

4 右上角の X 座標

5 右上角の Y 座標

6 左上角の X 座標

7 左上角の Y 座標

これらの点は、angle の値にかかわらず text からの相対位置になります。つまり「左上」とは、そのテキストが水平になるように見たときの左上ということです。

失敗した場合には、false を返します。

例

例1 imageftbbox() の例

<?php
// 300x150 の画像を作成します
$im = imagecreatetruecolor(300, 150);
$black = imagecolorallocate($im, 0, 0, 0);
$white = imagecolorallocate($im, 255, 255, 255);

// 背景色を白に設定します
imagefilledrectangle($im, 0, 0, 299, 299, $white);

// フォントファイルへのパス
$font = './arial.ttf';

// まずバウンディングボックスを作成します
$bbox = imageftbbox(10, 0, $font, 'The PHP Documentation Group');

// X 座標および Y 座標
$x = $bbox[0] + (imagesx($im) / 2) - ($bbox[4] / 2) - 5;
$y = $bbox[1] + (imagesy($im) / 2) - ($bbox[5] / 2) - 5;

imagefttext($im, 10, 0, $x, $y, $black, $font, 'The PHP Documentation Group');

// ブラウザに出力します
header('Content-Type: image/png');

imagepng($im);
?>

注意

注意: この関数は、PHP が FreeType サポート (--with-freetype-dir=DIR) を有効にしてコンパイルされている場合のみ使用可能です。

参考

imagefttext() - FreeType 2 によるフォントを用いてイメージにテキストを描画する
imagettfbbox() - TypeType フォントを使用したテキストの bounding box を生成する

0	左下角の X 座標
1	左下角の Y 座標
2	右下角の X 座標
3	右下角の Y 座標
4	右上角の X 座標
5	右上角の Y 座標
6	左上角の X 座標
7	左上角の Y 座標