imageftbbox

(PHP 4 >= 4.0.7, PHP 5, PHP 7, PHP 8)

imageftbbox — freetype2 によるフォントを用いたテキストを囲む箱を取得する

説明

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	描画時の行間を定義します

戻り値

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);
imagedestroy($im);
?>

注意

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

参考

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

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 8 notes

down

fernando ¶

19 years ago

imagettfbbox() returns an array with 8 elements representing four points making the bounding box of the text: 

0 lower left corner, X position 
1 lower left corner, Y position 
2 lower right corner, X position 
3 lower right corner, Y position 
4 upper right corner, X position 
5 upper right corner, Y position 
6 upper left corner, X position 
7 upper left corner, Y position 

The points are relative to the text regardless of the angle, so "upper left" means in the top left-hand corner seeing the text horizontally.

down

phpimageftbbox at juggernaut dot com dot au ¶

22 years ago

This function can be used to generate right-aligned text. Just work out how wide the text image is and position it accordingly. Example:

$i_width  = 200;
$i_height = 40;

$string = "Hello World!";
$pointsize = 10;
$fontfile = "/usr/local/lib/ttf/Helve.ttf";

$im = imagecreate($i_width, $i_height);
$black = imagecolorallocate ($im, 0, 0, 0);
$white = imagecolorallocate ($im, 255, 255, 255);

$string_size = ImageFtBbox($pointsize, 0, $fontfile, $string, array("linespacing" => 1));
$s_width  = $string_size[4];
$s_height = $string_size[5];

ImageFtText($im, $pointsize, 0, $i_width - $s_width - 1,  0 - $s_height, $white, $fontfile, $string, array("linespacing" => 1));

Header ("Content-type: image/png");
ImagePNG ($im);
ImageDestroy ($im);

down

sectionthirty1 at yahoo dot com ¶

20 years ago

Here is a handy example I used to center "dynamic text" onto an image.  

Ex. Say you want to center a clients IP Address onto a picture.  

$ip=$_SERVER['REMOTE_ADDR'];    

$details = imageftbbox($fontsize, 0, $font, $ip, array("linespacing" => 1));

$xcoord = ($imgwidth - $details[4]) / 2;  // this will return the x coordinate centered to your specific image.  Make sure  you set $imgwidth to the width of the image you are using.      

imagettftext($image, $fontsize, 0, $xcoord, $ycoord, $fontcolor, $font, $ip);

down

theo v e -2 ¶

18 years ago

ah... the problem between imageftbbox() and imagefttext() lies in the mirroring of the y-axes.
Below you see, for a font-size 16 the boudingboxes of "b", "p" and "bp":
< b: w=9 h=15
b(0,-1)
b(9,-1)
b(9,-16)
b(0,-16)
< p: w=9 h=16
p(0,4)
p(9,4)
p(9,-12)
p(0,-12)
< bp: w=20 h=20
bp(0,4)
bp(20,4)
bp(20,-16)
bp(0,-16)
If drawing "bp" using imagefttext() at y=0, the the top of "bp" indeed is at y=-16, and the bottom of "bp" at y=4. (Plus or minus a pixel here and there, because at y=0 there actually is a vissible pixel.)

down

-1

pablocorezzola at gmail dot com ¶

7 years ago

//EXAMPLE - Center text

function newText($im, $size, $angle= 0, $x, $y, $color, $font, $text,$align = "left",$border=false,$width=0,$height=0){
    
    if($align == "center")
    {
        if ($border == true ){
           imagerectangle($im, $x, $y, $x +$width, $y + $height, $color);
        }
        $bbox = imageftbbox($size, 0, $font, $text);

        // Marcamos el ancho y alto
        $s_width  = $bbox[4];
        $s_height = $bbox[5];  
        
        $y = $y + ($height-$s_height)/2;
        $x = $x + ($width-$s_width)/2;

    }
     
    imagettftext($im, $size, $angle, $x, $y, $color, $font, $text);
}

down

-1

Johan ¶

17 years ago

For alignment i used this method:

if($align == "center" || $align == "right")
    {
        $verticaltxtspace = $backwidth - (2 * $posx);        
        $spacepositions = imagettfbbox($size, $angle, "fonts/verdanaz.ttf", " ");         
        $spacepx = $spacepositions[4] - $spacepositions[0];        
        
        // Split text in lines
        $lines = split("[\r][\n]", $text);        
        for($count = 0; $count < count($lines); $count++)
        {
            $textpositions = imagettfbbox($size, $angle, "fonts/verdanaz.ttf", $lines[$count]);            
            $textpx = $textpositions[2] - $textpositions[0];
            
            if($align == "right")
            {
                $spaces = ($verticaltxtspace - $textpx) / $spacepx;
            }
            else if($align == "center")
            {
                $spaces = (($verticaltxtspace - $textpx)/2) / $spacepx;
            }
            
            // Add spaces
            $line = $lines[$count];
            for($i = 0; $i < $spaces; $i++)
            {
                $line = " " . $line;
            }
            $lines[$count] = $line;
        }
        
        // Create new text of lines
        $text = "";
        for($count = 0; $count < count($lines); $count++)
        {
            $text .= $lines[$count] . "\r\n";
        }        
    }
    
        
    //    Draw the shadow text on de shadow
    imagettftext($background, $size, $angle, $posx, $posy, $textcolor, "fonts/verdanaz.ttf",  $text);

down

-2

ta at NOSPAM dot magicsquare dot info ¶

22 years ago

i've found a work around for this situation

it seems that height is directly proportional to line spacing so you just have to apply the same factor to image height

for example :

$spacing = 0.7;
$params = array("linespacing" => $spacing);

$box = imageftbbox ($size, 0, $font, $text, $params);
$tw=$box[4]-$box[0]; //image width
$th=($box[1]-$box[5])*$spacing; //image height

down

-3

groomed at users dot sf dot net ¶

20 years ago

ImageFTBBox returns a bounding box, not metrics, as some (most?) of the notes above seem to assume. The 8 values it returns specify the 4 corners of this bounding box. So to properly determine the width and height of a string you need to do:

$bbox = ImageFTBBox(...);
$width = abs($bbox[0]) + abs($bbox[2]); // distance from left to right
$height = abs($bbox[1]) + abs($bbox[5]); // distance from top to bottom

＋add a note