PHPWebP オンラインガイド

# 設定オプション

phpwebp/phpwebp.config.phpで連想配列$configの編集することで動作をカスタマイズできます。

<?php
// 記述例
$config['webp_cache_dir_path'] = '/tmp/phpwebp';
$config['long_cache_age'] = 7200;
?>

以下の項目を利用できます。

# WebP変換の挙動について

オプション 役割
webp_cache_dir_path

WebPキャッシュのディレクトリパス

変換済みのWebPファイルをキャッシュとして保存するディレクトリのフルパスを指定します。

デフォルト値: phpwebp/data/webp

cwebp_bin_path

cwebpコマンドのパス

JPEGおよびPNGからWebPへの変換を行うcwebpコマンドのパスです。

通常は自動で検知するため指定の必要はありません。

はじめにPHPWebPインストールディレクトリ/lib/bin/custom/cwebpを確認し、ファイルが存在しなければPHPWebPインストールディレクトリ/lib/bin/linux-64/cwebpを参照します。

デフォルト値: 自動検知

gif2webp_bin_path

gif2webpコマンドのパス

GIFからWebPへの変換を行うgif2webpコマンドのパスです。

通常は自動で検知するため指定の必要はありません。

はじめにPHPWebPインストールディレクトリ/lib/bin/custom/cwebpを確認し、ファイルが存在しなければPHPWebPインストールディレクトリ/lib/bin/linux-64/cwebpを参照します。

デフォルト値: 自動検知

cwebp_jpeg_args

JPEG用のcwebpコマンド引数

cwebpコマンドによりJPEGからWebPに変換する際に使用するコマンドライン引数を指定します。

入出力ファイルの引数は自動で割り当てられます。

配列で指定してください。

デフォルト値: ['-q', '75', '-sharp_yuv', '-metadata', 'icc', '-short']

cwebp_png_args

PNG用のcwebpコマンド引数

cwebpコマンドによりPNGからWebPに変換する際に使用するコマンドライン引数を指定します。

入出力ファイルの引数は自動で割り当てられます。

配列で指定してください。

デフォルト値: ['-lossless', '-metadata', 'icc', '-short']

gif2webp_args

GIF用のgif2webpコマンド引数

gif2webpコマンドによりGIFからWebPに変換する際に使用するコマンドライン引数を指定します。

入出力ファイルの引数は自動で割り当てられます。

配列で指定してください。

デフォルト値: []

# キャッシュやレポートのディレクトリについて

オプション 役割
webp_cache_dir_path

WebPキャッシュのディレクトリパス

変換済みのWebPファイルをキャッシュとして保存するディレクトリのフルパスを指定します。

デフォルト値: phpwebp/data/webp

report_dir_path

レポートファイルのディレクトリパス

利用統計レポートを保存するディレクトリのフルパスを指定します。

デフォルト値: phpwebp/data/report

document_dir_path

ドキュメントルート

Webサーバーのドキュメントルートを指定します。

通常はPHPのサーバー環境変数DOCUMENT_ROOTから取得するので指定する必要がありません。

デフォルト値: サーバー環境変数DOCUMENT_ROOTから取得

# ディスク容量について

オプション 役割
cache_limit_mb

キャッシュの最大サイズ(MB)

変換済みのWebP画像を保存するキャッシュの最大サイズをメガバイト(MB)単位で指定します。

デフォルトは5GB(5120)です。

デフォルト値: 5120 (5120MB=5GB)

cache_cleanup_target_mb

キャッシュ整理の目標サイズ(MB)

変換済みのWebP画像を自動で整理する際に、残すキャッシュの合計サイズをメガバイト(MB)単位で指定します。

例えばcache_limit_mbが5120(5GB)、cache_cleanup_target_mbが4096(4GB)の場合、キャッシュの合計サイズが5GB以上になったとき、4GB以下になるまで最終アクセス日の古い順にキャッシュファイルを削除します。

デフォルト値: cache_limit_mbと同じ

report_expire_hours

利用統計レポートの最大保存期間

利用統計レポートをお使いのサーバー上に保存する期間を時間単位で指定します。

商用利用において利用統計レポートが集計サーバーに送信される場合、利用統計レポートファイルは送信が成功したら削除されます。

デフォルト値: 168 (168時間=7日間)

# 利用統計レポートについて

オプション 役割
serial_code

シリアルコード

商用ライセンスに対して発行されるシリアルコードを指定します。

シリアルコードは商用ライセンスを証明するとともに、利用統計の集計に利用します。関係者以外には秘匿情報として扱ってください。

report_dir_path

レポートファイルのディレクトリパス

利用統計レポートを保存するディレクトリのフルパスを指定します。

デフォルト値: phpwebp/data/report

report_rotation_minutes

利用統計レポートの集計単位時間(分)

利用統計レポートは通常、10分ごとに新しいファイルに追記されます。この単位時間を分単位で指定します。

利用統計レポートを送信・整理する定期ジョブの間隔と同じ時間を指定することをおすすめします。

最もリアルタイムに近い集計を行う場合は1(分)を指定し、定期ジョブを1分ごとに実行してください。

デフォルト値: 10 (600秒=10分)

report_dir_perms

利用統計レポートディレクトリのパーミッション

利用統計レポートの保存時にディレクトリを作成する際に使用されるパーミッション値です。

デフォルト値: 0775

report_file_perms

利用統計レポートディレクトリのパーミッション

利用統計レポートの保存時にディレクトリを作成する際に使用されるパーミッション値です。

デフォルト値: 0775

report_expire_hours

利用統計レポートの最大保存期間

利用統計レポートをお使いのサーバー上に保存する期間を時間単位で指定します。

商用利用において利用統計レポートが集計サーバーに送信される場合、利用統計レポートファイルは送信が成功したら削除されます。

デフォルト値: 168 (168時間=7日間)

# セキュリティについて

オプション 役割
serial_code

シリアルコード

商用ライセンスに対して発行されるシリアルコードを指定します。

シリアルコードは商用ライセンスを証明するとともに、利用統計の集計に利用します。関係者以外には秘匿情報として扱ってください。

api_key

APIキー

HTTPリクエスト経由で定期ジョブを起動する場合に使用するAPIキーを指定します。

APIキーを指定しない限り、HTTPリクエスト経由で定期ジョブを起動することはできません。

http_proxy_url

HTTPクライアント用のプロキシURL

商用利用時に利用統計を収集する際に、Web APIを利用します。お使いのサーバーからHTTPリクエストをプロキシ経由で送信する場合にプロキシURL(例 http://x.x.x.x:8080)を指定します。

report_dir_perms

利用統計レポートディレクトリのパーミッション

利用統計レポートの保存時にディレクトリを作成する際に使用されるパーミッション値です。

デフォルト値: 0775

report_file_perms

利用統計レポートディレクトリのパーミッション

利用統計レポートの保存時にディレクトリを作成する際に使用されるパーミッション値です。

デフォルト値: 0775

cache_file_perms

キャッシュファイルのパーミッション

変換済みのWebP画像などをキャッシュファイルとして保存する場合のパーミッション値です。

デフォルト値: 0664

cache_dir_perms

キャッシュディレクトリのパーミッション

変換済みのWebP画像などをキャッシュファイルとして保存する場合のディレクトリパーミッション値です。

デフォルト値: 0775

← WebP変換と配信の流れ →