【PHP8.x】insertAdjacentTextメソッドの使い方

insertAdjacentTextメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

insertAdjacentTextメソッドは、DOMElementクラスに属するメソッドで、HTMLやXMLドキュメント内の特定のDOM要素に対して、指定された位置にテキストコンテンツを挿入するメソッドです。このメソッドは、既存の要素の構造を直接変更することなく、その要素の周辺や内部に新しいテキストノードを効率的に追加したい場合に利用されます。

テキストを挿入する位置は、メソッドの第一引数で指定します。利用可能なキーワードは以下の四つです。'beforebegin' は、対象要素の開始タグの直前、つまりその要素の外側にテキストを挿入します。'afterbegin' は、対象要素の開始タグの直後、その要素の最初の子としてテキストを挿入します。'beforeend' は、対象要素の終了タグの直前、その要素の最後の子としてテキストを挿入します。'afterend' は、対象要素の終了タグの直後、その要素の外側にテキストを挿入します。

第二引数には挿入するテキスト文字列を渡します。このメソッドの重要な特徴は、挿入される内容が常に純粋なテキストとして扱われる点です。これにより、挿入文字列にHTMLタグなどが含まれていても、それらは自動的にエスケープされて追加されます。結果として、意図しないHTML構造の変更や、クロスサイトスクリプティング(XSS)のようなセキュリティリスクを効果的に防ぎ、安全かつ簡潔なDOM操作を可能にします。

構文(syntax)

1<?php
2
3$domElement->insertAdjacentText('beforeend', '挿入するテキスト');

引数(parameters)

string $where, string $data

  • string $where: テキストを挿入する位置を指定する文字列。以下のいずれかの値を取ります。
    • "beforebegin": 要素の直前に挿入します。
    • "afterbegin": 要素の直後に挿入します。
    • "beforeend": 要素の末尾に挿入します。
    • "afterend": 要素の直後に挿入します。
  • string $data: 挿入するテキストを指定する文字列。

戻り値(return)

void

指定された位置にテキストノードを挿入します。戻り値はありません。

関連コンテンツ

【PHP8.x】insertAdjacentTextメソッドの使い方 | いっしー@Webエンジニア