2024年06月13日

WP関数:esc_html()


この関数の説明

WP関数の esc_html() は、一般的に使うエスケープ処理(無害化)関数です。

文字列の中にある下記[記号]を[文字コード]に変換します。

記号 文字コード 読み方
< &lt; 小なり
> &gt; 大なり
' &#39; シングルクォーテーション
" &quot; ダブルクォーテーション
& &amp; アンパサンド

 


関数

esc_html($text )

 


パラメータ

$text文字列必須

エスケープ処理をする文字列

 


戻り値

コードに変換された文字列

 


事例

①エスケープあり、なしの比較

<?php
	echo 'abc<script>xxx</script>123';						// エスケープなし
	echo '<br>';
	echo esc_html('abc<script>xxx</script>123');	// エスケープあり
?>

■2行目:単純にechoすると<script>タグが実行されてしまします。(大変危険です

■4行目:エスケープ処理をすると<>は文字コードに変換されるのでHTMLタグとは認識されません。

■結果は下記になります。

abc123
abc<script>xxx</script>123

 

②esc_html_e()を利用したケース

esc_html()の代わりにesc_html_e()を使う事もできます。

<?php
	echo esc_html('abc<script>xxx</script>123');	// エスケープあり
	echo '<br>';
	esc_html_e('abc<script>xxx</script>123');		// エスケープあり
?>

esc_html_e()は、翻訳したデータをecho esc_html()する関数ですが、翻訳無しでも利用できます。

■上記の実行結果は下記になります。

abc<script>xxx</script>123
abc<script>xxx</script>123

 


関連情報

関連関数は エスケープ処理関数 を参照してください。

 


関数一覧
  • 1.WPのエスケープ処理
  • 2.WPプログラムの基本
  • 3.ヘッダ/フッタ/サイドバで使われる関数
  • 4.DBからの読込関数
  • 5.一般テンプレートの中で使われる関数
  • 6.その他のWP関数
  • add_shortcode()
  • bloginfo()
  • body_class()
  • date_i18n()
  • dynamic_sidebar()
  • edit_post_link()
  • esc_attr()
  • esc_html_e()
  • esc_html()
  • esc_url()
  • get_ancestors()
  • get_cat_ID()
  • get_cat_name()
  • get_category_link()
  • get_category_parents()
  • get_category()
  • get_footer()
  • get_header()
  • get_home_url()
  • get_post_format()
  • get_post_meta()
  • get_post_thumbnail_id()
  • get_query_var()
  • get_search_query()
  • get_sidebar()
  • get_site_url()
  • get_stylesheet_directory_uri()
  • get_stylesheet_uri()
  • get_template_directory_uri()
  • get_template_part()
  • get_the_category()
  • get_the_content()
  • get_the_date()
  • get_the_excerpt()
  • get_the_ID()
  • get_the_modified_date()
  • get_the_modified_time()
  • get_the_permalink()
  • get_the_post_thumbnail()
  • get_the_tags()
  • get_the_time()
  • get_the_title()
  • get_uploaded_header_images()
  • get_year_link()
  • has_category()
  • has_custom_logo()
  • has_header_image()
  • has_header_video()
  • has_nav_menu()
  • has_post_thumbnail()
  • has_tag()
  • header_image()
  • home_url()
  • is_admin()
  • is_category()
  • is_date()
  • is_front_page()
  • is_home()
  • is_main_query()
  • is_page()
  • is_search()
  • is_single()
  • language_attributes()
  • the_category()
  • the_content()
  • the_custom_header_markup()
  • the_custom_logo()
  • the_date()
  • the_excerpt()
  • the_ID()
  • the_modified_date()
  • the_modified_time()
  • the_permalink()
  • the_post_thumbnail()
  • the_search_query()
  • the_tags()
  • the_time()
  • the_title()
  • update_post_meta()
  • wp_get_attachment_image_src()
  • wp_nav_menu()
  • WP_Query()