Web aym.pekori.to

id3_remove_tag

(PECL)

id3_remove_tag -- 既存の ID3 タグを削除する

説明

bool id3_remove_tag ( string filename [, int version] )

id3_remove_tag() は、ID3 タグに格納されている 情報を削除するために使用されます。タグが存在したい場合は、 この関数は FALSE を返し、ファイルには何も変更を加えません。

注意: ファイル名のかわりに、ストリームリソースを渡すことも可能です。

MP3 ファイルがバージョン 1.x およびバージョン 2.x の両方のタグを 含んでいる場合は、オプションのパラメータ version を用いてタグのバージョンを指定することが可能となります。

例 1. id3_remove_tag() の例

<?php
$result
= id3_remove_tag( "path/to/example.mp3", ID3_V1_0 );
if (
$result === true) {
    echo
"タグが正常に削除されました\n";
}
?>

ファイルが書き込み可能であり、かつ 1.0 タグを含んでいる場合は この例の出力は次のようになります。

タグが正常に削除されました

注意: 現時点では id3_remove_tag() がサポートしているのは バージョン 1.0 および 1.1 のみです。ファイルが 1.1 のタグを 含んでいるときに 1.0 のタグを削除しようとすると、この (1.1 の) タグが削除されます。というのも、v1.1 は単に 1.0 を拡張したものだからです。

id3_get_tag()id3_set_tag() および id3_get_version() も参照ください。