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



お勧め

使っていないか確認しないとね!(フィルター編)(2019年4月24日 更新)

先週末にWordPress 5.2 Beta3(以降5.2Beta3)が公開され、正式リリースまであとわずか。ソースコードの変更点を見ていくと、wp-login.phpの中に非推奨となったフィルターが目に留まった。

ブロックエディターで現在の「ロケール」を取得した時のメモ(2024年8月10日 更新)

ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール(言語)を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。