【PHP8.x】strip_tags()関数の使い方

Copy
1<?php
2
3/**
4 * strip_tags() 関数の deprecated (非推奨) な使用方法と推奨される代替方法を示します。
5 *
6 * PHP 8.1 以降、strip_tags() の第2引数 ($allowed_tags) に null を渡すことは非推奨となりました。
7 * PHP 8.3 では、この使用方法で E_DEPRECATED 警告が発生します。
8 * PHP 9.0 でこの引数に null を渡すと TypeError が発生する予定です。
9 */
10function demonstrateStripTagsDeprecatedUsage(): void
11{
12    $htmlString = "<p>これは<b>テスト</b>の<i>HTML</i>文字列です。</p><a href='#'>リンク</a>";
13
14    echo "元のHTML文字列:\n";
15    echo $htmlString . "\n\n";
16
17    // --- 非推奨 (Deprecated) な使用方法 ---
18    // 第2引数に明示的に null を渡すケース。
19    // PHP 8.3 環境で実行すると E_DEPRECATED 警告が発生します。
20    $strippedDeprecated = strip_tags($htmlString, null);
21    echo "strip_tags() で第2引数に null を指定した場合 (PHP 8.1+ 非推奨):\n";
22    echo $strippedDeprecated . "\n\n";
23
24    // --- 推奨される代替方法 ---
25    // 全てのタグを削除したい場合は、第2引数を省略するのが推奨されます。
26    // これにより、内部で暗黙的に null が渡されることもなくなります。
27    $strippedRecommended = strip_tags($htmlString);
28    echo "strip_tags() で第2引数を省略した場合 (推奨):\n";
29    echo $strippedRecommended . "\n\n";
30
31    // 特定のタグを許可したい場合は、許可するタグを配列または文字列で指定します。
32    // 例: strip_tags($htmlString, ['p', 'b']);
33    // $strippedAllowed = strip_tags($htmlString, '<b><i>'); // 文字列で指定する例
34    // echo "特定のタグを許可した場合:\n" . $strippedAllowed . "\n\n";
35}
36
37// 関数を実行
38demonstrateStripTagsDeprecatedUsage();
39

strip_tags関数は、指定された文字列からHTMLやPHPのタグを取り除くために使用されます。最初の引数には、タグを取り除きたい元の文字列を指定します。2番目の引数は任意で、取り除かずに残したい特定のタグを配列や文字列で指定できます。この引数を省略すると、デフォルトですべてのタグが削除されます。関数は、タグが取り除かれた新しい文字列を返します。

PHP 8.1以降、strip_tags関数の第2引数にnullを明示的に渡すことは非推奨となりました。これは、全てのタグを削除する場合に第2引数を省略する動作と結果は同じですが、将来的な互換性の問題や意図の明確化のためです。PHP 8.3ではこの使用方法でE_DEPRECATED警告が発生し、PHP 9.0ではTypeErrorとなる予定であるため注意が必要です。

したがって、全てのタグを削除したい場合は第2引数を省略することが推奨されます。特定のタグのみを残したい場合は、許可したいタグを配列または文字列で明確に指定してください。このサンプルコードは、非推奨なnullの明示的な指定と、推奨される引数省略による使用方法を示し、どちらも同じ結果が得られることを確認できますが、推奨される方法を選択することが重要です。

Copy
1<?php
2
3/**
4 * HTML文字列から特定のタグを除いて、全てのHTMLタグを取り除きます。
5 *
6 * @param string $htmlString 処理対象のHTML文字列。
7 * @return string 特定のタグを除いた、HTMLタグが取り除かれた文字列。
8 */
9function cleanHtmlExceptSpecificTags(string $htmlString): string
10{
11    // 残したいタグを配列で指定します。
12    // 例: 'b' (太字), 'i' (斜体), 'a' (リンク) など
13    // この例では、<b>タグと<a>タグのみを残します。
14    $allowedTags = ['b', 'a'];
15
16    // strip_tags関数は、第一引数に処理する文字列、
17    // 第二引数に許可するタグ（削除しないタグ）を指定します。
18    // 許可するタグは、文字列（例: '<b><a>'）または配列（例: ['b', 'a']）で指定できます。
19    // PHP 8では配列での指定がより推奨されます。
20    $cleanedString = strip_tags($htmlString, $allowedTags);
21
22    return $cleanedString;
23}
24
25// サンプルHTML文字列を定義します。
26$inputHtml = "<p>これは<b>重要な</b>情報です。</p>" .
27             "<p>詳細はこちらの<a href=\"https://example.com\">リンク</a>を参照してください。</p>" .
28             "<script>alert('このスクリプトは削除されます');</script>" .
29             "<i>斜体は削除されます</i>";
30
31echo "--- 元のHTML文字列 ---\n";
32echo $inputHtml . "\n\n";
33
34// 関数を呼び出し、特定のタグを除いてHTMLタグを取り除きます。
35$outputCleaned = cleanHtmlExceptSpecificTags($inputHtml);
36
37echo "--- 特定のタグ（<b>と<a>）を除いてクリーンアップされた文字列 ---\n";
38echo $outputCleaned . "\n";
39
40?>

PHPのstrip_tags関数は、HTML文字列からHTMLタグを取り除くために使用される重要な関数です。ウェブサイトからのユーザー入力を安全に処理したり、HTMLコンテンツをテキスト形式で表示したりする際に役立ちます。

この関数の第一引数には、処理対象となるHTML文字列を指定します。第二引数はオプションで、削除せずに残したい特定のHTMLタグを指定するために使われます。この第二引数には、残したいタグを文字列（例: '<b><a>'）または配列（例: ['b', 'a']）で指定できますが、PHP 8では配列での指定が推奨されています。関数は、指定されたタグ以外を全て取り除いた結果の文字列を返します。

サンプルコードでは、cleanHtmlExceptSpecificTagsという関数を定義し、strip_tags関数を使って特定のタグを残す処理を実演しています。この例では、残したいタグとして<b>（太字）と<a>（リンク）が配列で指定されています。これにより、入力されたHTML文字列から<p>や<script>, <i>といったタグは削除されますが、<b>タグと<a>タグで囲まれた内容はそのまま維持されます。結果として、元のHTMLから不要なタグや潜在的に危険なスクリプトなどが取り除かれ、必要最低限の書式が保たれたクリーンな文字列が得られます。

Copy
1<?php
2
3/**
4 * strip_tags 関数で HTML タグが除去されない場合のデバッグと解決策を示すサンプルコード。
5 * 特に、許可するタグを指定する場合の注意点と、文字コードの問題に対処する方法を解説する。
6 */
7
8// 文字列の定義 (UTF-8 エンコード)
9$string = '<p>This is <b>bold</b> text.</p><script>alert("XSS");</script><img src="test.png">';
10
11// strip_tags 関数で HTML タグを除去 (デフォルト設定)
12$stripped_string = strip_tags($string);
13echo "デフォルト設定での結果:\n";
14echo $stripped_string . "\n\n"; // <p>This is bold text.</p>alert("XSS")<img> が出力される (script, img は除去される)
15
16// 許可するタグを指定して HTML タグを除去
17$allowed_tags = '<p><b>'; // 許可するタグ (p と b)
18$stripped_string_with_allowed_tags = strip_tags($string, $allowed_tags);
19echo "許可するタグを指定した場合の結果:\n";
20echo $stripped_string_with_allowed_tags . "\n\n"; // <p>This is <b>bold</b> text.</p>alert("XSS")<img> が出力される (script, img は除去される)
21
22// エラーハンドリング
23$malformed_string = "<p>This is an unclosed tag.";
24$stripped_malformed_string = strip_tags($malformed_string);
25echo "不正なHTMLでの結果:\n";
26echo $stripped_malformed_string . "\n\n"; // This is an unclosed tag. が出力される
27
28// 文字コードに関する注意点
29// strip_tags は HTML エンティティを変換しないため、必要に応じて htmlentities などを使用する
30$string_with_entities = '<p>This is &eacute; text.</p>';
31$stripped_string_with_entities = strip_tags($string_with_entities);
32echo "HTMLエンティティを含む文字列の結果:\n";
33echo $stripped_string_with_entities . "\n\n"; // This is é text. が出力される
34
35// マルチバイト文字列の場合、mb_string 拡張関数を利用する
36$multibyte_string = '<p>こんにちは、世界！</p>';
37$stripped_multibyte_string = strip_tags($multibyte_string);
38echo "マルチバイト文字列の結果:\n";
39echo $stripped_multibyte_string . "\n"; // こんにちは、世界！ が出力される (特に問題なし)
40
41?>

strip_tags関数は、文字列からHTMLおよびPHPタグを取り除く関数です。第一引数$stringにタグを取り除く対象の文字列を指定します。第二引数$allowed_tagsは省略可能で、許可するタグを文字列または配列で指定します。この引数を指定することで、特定のHTMLタグのみを残すことが可能です。関数は、タグが取り除かれた文字列を返します。

サンプルコードでは、strip_tags関数の基本的な使用方法と、いくつかの注意点を示しています。デフォルト設定では、多くのHTMLタグが除去されます。許可するタグを指定した場合も、指定されたタグ以外は除去されます。

不正なHTML（閉じられていないタグなど）が含まれる場合、strip_tagsは可能な範囲でタグを取り除きます。

また、strip_tagsはHTMLエンティティ（éなど）を変換しないため、必要に応じてhtmlentities関数などを利用してエンティティを変換する必要があります。マルチバイト文字列（日本語など）を扱う場合、特に設定を変更する必要はありません。正しく処理されます。

strip_tagsが期待通りに動作しない場合、許可するタグの指定が正しいか、HTMLエンティティが適切に処理されているかなどを確認してください。