esc_js

説明

string esc_js( string $text )
文字列をインラインJavaScript向けにエスケープ処理する。

パラメータ

  • $text
    文字列を指定。

返り値

エスケープ処理した文字列を返す。

注意

具体的には次のような処理を行っている。
  • ・文字エンコーディングUTF-8における無効な文字を取り除く。
  • ・特殊文字をHTMLエンティティに変換する。
  • ・'(シングルクォート)のHTMLエンティティを'に変換する。
  • ・"\r"を除外する。
  • ・"\n"を"\\n"に置き換える。

使用例

  • 文字列をインラインJavaScript向けにエスケープ処理する。
    <?php $escaped_text = esc_js( $text ); ?>

フィルター

[2.0.6]エスケープ処理した文字列を返す前に'js_escape'フィルターを呼び出す。パラメータ$safe_textにはエスケープ処理した文字列が、$textには本関数が受け取った内容が格納されている。
return apply_filters( 'js_escape', $safe_text, $text );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/formatting.php

最終更新 : 2019年01月24日 11:49



お勧め

テーブルブロックを定形に整える(2021年12月27日 更新)

ブロックエディターについて調べていると、「段落ブロックをもう少しカスタマイズした」で使ったRichTextShortcutとは別にショートカットキーを使うためのKeyboardShortcutsが見つかった。今回はこのKeyboardShortcutsを使ってテーブルブロックを定形に整える仕組みを考えてみた。

各種リンクを取得する関数一覧(2014年6月12日 更新)

サイト設計において、ページ間の相互リンクは重要である。WordPressでは各種ページのリンク(パーマリンク)を取得する関数を用意しており、それらを一通り把握しておくべきだろう。

スクリプトファイルのバージョンパラメータを変更する(2018年5月27日 更新)

Java Scriptやスタイルシートの指定を直接head要素内に記述せず、wp_enqueue_scriptsフィルターなどを使って指定する場合、WordPressのバージョン番号が付与されている。このバージョン番号は、妥当なんだろうか。

4.2の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2018年5月27日 更新)

ダッシュボードの「アクティビティ」ウィジェットは「投稿(post)」の状況を表示し、固定ページ(page)やカスタム投稿タイプの投稿記事の状況については標準では表示されない。このことに対して以前『3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する』を紹介したのだが、4.2では新しいフィルターが追加され、カスタマイズが少し容易になった。

投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)

WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。