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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。