【PHP8.x】textContentプロパティの使い方

textContentプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

textContentプロパティは、DOMElementノードのテキストコンテンツを取得または設定するために使用できるプロパティです。このプロパティを使用することで、要素に含まれるテキストノードの値にアクセスしたり、変更したりすることができます。取得時には、要素の子孫にあるすべてのテキストノードを連結した文字列が返されます。設定時には、要素のすべての子ノードが削除され、指定された文字列を値とする新しいテキストノードが子ノードとして追加されます。

textContentプロパティは、innerHTMLプロパティと似ていますが、いくつかの重要な違いがあります。innerHTMLプロパティは、要素のHTMLマークアップを取得または設定するために使用され、文字列としてHTMLを解析します。一方、textContentプロパティはテキストコンテンツのみを扱い、HTMLマークアップを解析しません。そのため、textContentプロパティはinnerHTMLプロパティよりも安全であり、XSS(クロスサイトスクリプティング)攻撃のリスクを軽減することができます。また、textContentプロパティはinnerHTMLプロパティよりも高速に動作する場合があります。

textContentプロパティは、テキストノードの値を取得または設定する際に非常に便利です。例えば、Webページの特定の要素のテキストコンテンツを更新したり、フォームに入力されたテキストを取得したりするために使用できます。textContentプロパティを使用することで、DOM操作をより効率的に、そして安全に行うことができます。DOMElementオブジェクトのtextContentプロパティにアクセスするには、$element->textContentのように記述します。ここで、$elementはDOMElementオブジェクトのインスタンスです。設定する場合は、$element->textContent = '新しいテキストコンテンツ';のように記述します。

構文(syntax)

1<?php
2$dom = new DOMDocument();
3$element = $dom->createElement('test', 'Hello');
4$dom->appendChild($element);
5
6$textContent = $element->textContent;
7echo $textContent; // 出力: Hello
8
9$element->textContent = 'World';
10echo $element->textContent; // 出力: World
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

string

DOMElementオブジェクトが表現する要素のテキストコンテンツを文字列として取得します。これには、子要素のテキストコンテンツも再帰的に含まれます。

サンプルコード

PHP DOMElement textContentでテキスト取得

1<?php
2
3// DOMDocumentを新規作成
4$dom = new DOMDocument();
5
6// ルート要素を作成
7$root = $dom->createElement('root');
8$dom->appendChild($root);
9
10// 子要素を作成
11$child = $dom->createElement('child');
12$root->appendChild($child);
13
14// テキストノードを作成し、子要素に追加
15$text = $dom->createTextNode('Hello, world!');
16$child->appendChild($text);
17
18// DOMElementを取得
19$element = $dom->getElementsByTagName('child')->item(0);
20
21// textContentプロパティを使用してテキストコンテンツを取得
22$textContent = $element->textContent;
23
24// 結果を出力
25echo $textContent . PHP_EOL; // Hello, world!

DOMElementクラスのtextContentプロパティは、要素ノードに含まれるテキストコンテンツを取得・設定するために使用されます。このプロパティはPHP 8で利用可能です。

上記のサンプルコードでは、まずDOMDocumentオブジェクトを生成し、root要素とchild要素をDOMツリーに追加しています。さらに、child要素の中にHello, world!というテキストノードを追加しています。

次に、getElementsByTagName()メソッドを使ってchild要素を取得し、item(0)で最初のchild要素を表すDOMElementオブジェクトを変数$elementに格納しています。

そして、$element->textContentと記述することで、child要素に含まれるテキストコンテンツ(この場合はHello, world!)を取得し、変数$textContentに格納しています。

最後に、echo文で$textContentの内容を出力しています。このコードを実行すると、コンソールにHello, world!と表示されます。

textContentプロパティは引数を持ちません。戻り値は文字列型で、要素ノードのテキストコンテンツを表します。テキストコンテンツがない場合は空文字列が返されます。要素のテキストコンテンツを書き換える場合は、$element->textContent = "新しいテキスト";のように代入演算子を使用します。

DOMElementtextContentプロパティは、要素内のテキストコンテンツを文字列として取得します。要素に子要素が含まれる場合、それらのテキストノードも連結されます。textContentは読み取り専用ではないため、値を設定することも可能です。値を設定すると、要素内の全ての子ノードが設定されたテキストノードで置き換えられます。XMLドキュメントの構造を誤って変更しないよう、設定時は注意が必要です。また、textContentはHTMLエンティティをデコードしません。innerHTMLとは異なり、マークアップは解釈されず、そのままテキストとして扱われます。要素が存在しない場合や、要素がテキストを持たない場合は空文字列が返されます。

PHP DOMElementでtextContentを取得する

1<?php
2
3// DOMElement の textContent プロパティのサンプル
4$dom = new DOMDocument();
5$dom->loadHTML('<!DOCTYPE html><html><body><div>Hello, World!</div></body></html>');
6
7// div 要素を取得
8$div = $dom->getElementsByTagName('div')->item(0);
9
10// textContent プロパティを使用してテキストコンテンツを取得
11if ($div) {
12    $textContent = $div->textContent;
13
14    // 結果を出力
15    echo $textContent . PHP_EOL; // "Hello, World!" が出力される
16}

PHPのDOMElementクラスにおけるtextContentプロパティについて解説します。このプロパティは、DOM(Document Object Model)における要素ノードのテキストコンテンツを取得または設定するために使用されます。

上記のサンプルコードでは、まずDOMDocumentオブジェクトを作成し、HTMLドキュメントをロードしています。次に、getElementsByTagName('div')メソッドを使って、HTMLドキュメント内の<div>要素を取得しています。item(0)は、取得した要素リストの最初の要素(この場合は最初の<div>要素)を取得するために使用されます。

textContentプロパティは、この<div>要素が持つテキストコンテンツ(ここでは "Hello, World!")を取得するために利用されます。$div->textContentによって、<div>要素のテキストコンテンツが文字列として $textContent 変数に格納されます。

textContentプロパティは、引数を必要としません。このプロパティにアクセスすることで、要素ノードに含まれるテキストノードの値が結合された文字列が返されます。例えば、<div>Hello <span>World</span>!</div>という要素に対してtextContentを使用すると、"Hello World!"という文字列が取得できます。

このサンプルコードでは、取得したテキストコンテンツをecho文で出力しています。PHP_EOLは改行コードを表し、出力結果が見やすくなるように追加されています。textContentプロパティを使用することで、HTML要素からテキストコンテンツを簡単に抽出することができます。

DOMElementtextContentプロパティは、要素内のテキストコンテンツを取得する際に便利ですが、HTMLエンティティはデコードされない点に注意が必要です。例えば、&amp;はそのまま&amp;として返されます。要素が存在しない場合にitem(0)nullを返す可能性があるため、サンプルコードのようにif ($div)で存在チェックを行うことが重要です。textContentは要素内の全ての子ノードのテキストを結合したものを返すため、意図しないテキストが含まれる可能性も考慮してください。textContentへの書き込みは、要素内の全ての子ノードを削除し、指定されたテキストノードに置き換えます。

関連コンテンツ

関連プログラミング言語

【PHP8.x】textContentプロパティの使い方 | いっしー@Webエンジニア