imagewebp

(PHP 5 >= 5.4.0, PHP 7, PHP 8)

imagewebp — WebP 画像をブラウザあるいはファイルに出力する

説明

imagewebp(GdImage $image, resource|string|null $file = null, int $quality = -1): bool

指定した image を、WebP 形式で出力あるいは保存します。

パラメータ

image: imagecreatetruecolor()のような画像作成関数が返す GdImage オブジェクト。
file: ファイル保存先のパスあるいはオープン中のリソース (この関数が値を戻した後で自動的にクローズされます)。省略したり null を設定したりした場合は、画像ストリームを直接出力します。
quality: quality には、0 (品質は最低で、ファイルサイズが小さくなる) から 100 (品質が最高で、ファイルサイズは大きくなる) までの値を指定します。 -1 を指定すると、デフォルト値 80 を使います。

戻り値

成功した場合に true を、失敗した場合に false を返します。

警告

しかしながら、libgd がイメージの出力に失敗した場合、この関数は true を返します。

エラー / 例外

quality が不正の場合、 ValueError をスローします。

変更履歴

バージョン	説明
8.4.0	`quality` が不正の場合、 ValueError をスローするようになりました。
8.0.0	`image` は、 GdImage クラスのインスタンスを期待するようになりました。これより前のバージョンでは、有効な `gd` resource が期待されていました。

例

例1 WebP ファイルの保存

<?php
// 空の画像を作成し、テキストを追加します
$im = imagecreatetruecolor(120, 20);
$text_color = imagecolorallocate($im, 233, 14, 91);

imagestring($im, 1, 5, 5,  'WebP with PHP', $text_color);

// 画像を保存します
imagewebp($im, 'php.webp');
?>