정의 및 사용 방법

PHP 버전
4.3+

html_entity_decode() 함수는 주어진 문자열에서 HTML에 정의된 모든 특수 문자의 엔티티(entities)를 해당 문자로 디코딩합니다.

이 함수는 HTML에 정의된 모든 특수 문자를 엔티티로 변환하는 htmlentities() 함수의 반대 개념입니다.

HTML에 정의된 모든 특수 문자는 'HTML Named Character References'를 의미하며, 자세한 목록은 HTML 표준 문서에서 확인할 수 있습니다.

기본 예제

PHP 
$str = '<, >, &, ", ', ©, ™ 등을 해당 문자로 디코딩합니다.';
$decode = html_entity_decode($str);

var_dump($decode);
출력

htmlspecialchars_decode() 함수는 엔티티(entities)로 인코딩된 다섯 개의 HTML 예약 문자(<, >, &, ", ')만을 디코딩하지만, html_entity_decode() 함수는 이 다섯 개의 HTML 예약 문자 이외에도 이름 엔티티가 정의된 목록(HTML Named Character References)에 있는 나머지 문자들(예: ©, €, ™ 등)을 추가로 디코딩한다는 차이점이 있습니다.

구문

PHP 
html_entity_decode(
    string $string,
    int $flags = ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401,
    ?string $encoding = null
): string

매개변수

html_entity_decode() 함수의 매개변수
$string 필수. 디코딩하려는 원본 문자열입니다.
$flags 옵션. 디코딩 시 동작 방식을 지정하는 상수 옵션입니다. 여러 옵션은 | (비트 OR) 연산자로 결합 가능합니다. 기본값: ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401
  • ENT_COMPAT: 쌍따옴표(")만 디코딩, 홑따옴표(')는 그대로
  • ENT_QUOTES: 쌍따옴표(")와 홑따옴표(') 모두 디코딩
  • ENT_NOQUOTES: 따옴표는 디코딩하지 않음
  • ENT_SUBSTITUTE: 잘못된 코드 유닛 시퀀스를 유니코드 대체 문자(U+FFFD)로 처리
  • ENT_HTML401: HTML 4.01 문서 표준 기준
  • ENT_XML1, ENT_XHTML, ENT_HTML5: 각각 XML 1, XHTML, HTML5 문서 표준 기준
$encoding 옵션. 입력 문자열 인코딩을 지정합니다. 이 값에 따라 디코딩 가능한 엔티티의 범위가 결정됩니다. 기본값은 null이며, 이 경우 php.ini 파일의 default_charset 설정을 따릅니다. 대부분의 경우 'UTF-8'을 명시적으로 지정하는 것이 좋습니다. 지원하는 값은 다음과 같습니다.
  • 'ISO-8859-1': Western European, Latin-1
  • 'ISO-8859-5': 거의 사용되지 않는 키릴 문자셋 (Latin/Cyrillic)
  • 'ISO-8859-15': Western European, Latin-9. Euro 기호와 Latin-1에 없는 일부 프랑스어, 핀란드어 문자 포함
  • 'UTF-8': ASCII 호환 다중 바이트 8비트 유니코드
  • 'cp866': DOS용 키릴 문자셋
  • 'cp1251': Windows용 키릴 문자셋
  • 'cp1252': Western European용 Windows 문자셋
  • 'KOI8-R': 러시아 문자셋
  • 'BIG5': 번체 중국어, 주로 대만 사용
  • 'GB2312': 간체 중국어, 중국 국가 표준
  • 'BIG5-HKSCS': Big5 + 홍콩 확장, 번체 중국어
  • 'Shift_JIS': 일본어 문자셋
  • 'EUC-JP': 일본어 문자셋
  • 'MacRoman': Mac OS에서 사용되던 문자셋
  • ''(빈 문자열): 스크립트 인코딩, default_charset, 현재 로케일 순으로 자동 감지 (권장하지 않음)
참고: 다른 문자 집합은 인식되지 않습니다. 기본 인코딩이 대신 사용되고 경고가 표시됩니다.

반환 값

디코딩된 문자열을 반환합니다.

변경 이력

html_entity_decode() 함수의 변경 이력
PHP 8.1.0부터 $flags가 ENT_COMPAT에서 ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML401로 변경되었습니다.
PHP 8.0.0부터 $encodng은 이제 null 값을 가길 수 있습니다.

활용 예제

PHP 
$str = '<p>는 "문단" 요소입니다. &copy;, &trade; 엔티티도 포함하고 있습니다.';

echo html_entity_decode($str);
// 출력: <p>는 "문단" 요소입니다. ©, ™ 엔티티도 포함하고 있습니다.

echo html_entity_decode($str, ENT_NOQUOTES);
// 출력: <p>는 &quot;문단&quot; 요소입니다. ©, ™ 엔티티도 포함하고 있습니다.

참고문헌

같이 보기