【PHP8.x】insertAdjacentTextメソッドの使い方
insertAdjacentTextメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
insertAdjacentTextメソッドは、Dom\HTMLElementオブジェクトの特定の隣接位置に、プレーンテキスト形式の文字列を挿入するメソッドです。このメソッドは、PHPのDOM拡張機能の一部として提供されており、Webページの構造をプログラム的に操作する際に利用されます。
このメソッドは二つの引数を受け取ります。最初の引数である$whereは、テキストを挿入する相対的な位置を指定するための文字列です。指定できる値は以下の四種類です。'beforebegin'は対象要素の直前に挿入し、'afterbegin'は対象要素の開始タグ直後（最初の子として）に挿入します。また、'beforeend'は対象要素の終了タグ直前（最後の子として）に挿入し、'afterend'は対象要素の直後に挿入します。二番目の引数である$dataには、実際に挿入したいプレーンテキストの文字列を指定します。
insertAdjacentTextメソッドの重要な特徴は、挿入されるデータが常にプレーンテキストとして扱われる点です。これにより、挿入される文字列にHTMLタグが含まれていても、それらはテキストとして表示され、HTML要素として解析されることはありません。この特性は、ユーザーからの入力を表示する際などに、意図しないスクリプトの実行やレイアウトの崩れを防ぐ上で非常に有効であり、クロスサイトスクリプティング（XSS）のようなセキュリティリスクを軽減するのに役立ちます。HTMLとして解析されるコンテンツを挿入したい場合は、類似のinsertAdjacentHTMLメソッドを使用してください。このメソッドを利用することで、DOMツリーを直接操作するよりも、簡潔かつ安全にテキストコンテンツを追加できます。
構文(syntax)
1<?php 2$element->insertAdjacentText('beforebegin'|'afterbegin'|'beforeend'|'afterend', '挿入するテキストデータ');
引数(parameters)
Dom\AdjacentPosition $where, string $data
Dom\AdjacentPosition $where: テキストを挿入する位置を指定します。string $data: 挿入するテキストデータを指定する文字列です。
戻り値(return)
void
このメソッドは、指定された要素の指定された位置にテキストノードを挿入しますが、処理の完了を示す値は返しません。