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



お勧め

Contact Form 7に確認フェーズを(2012年12月16日 更新)

Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。

Somewhere search box:プラグイン作ってみました(2021年4月26日 更新)

投稿済みの記事を修正する際、毎回「投稿一覧」に戻るのは面倒だ、そんなことを感じて作ったのがこのプラグインです。また1.2.0では投稿内容(本文、カテゴリーや投稿タグ、カスタムフィールド)を複製するリンクを投稿一覧ページと投稿編集ページに追加、1.3.0では投稿タイトルのみの検索をサポートしました。

カスタムブロックを作っていると、ブロック自身の「サイズ」を指定するUIを持たせることがある。そんなときにちょっとモヤっとするのが、「マージン」や「パディング」の設定しているパネルのタイトルが「サイズ」なこと。この「サイズ」の原文は「Dimensions」であり、個人的にもう少しスッキリするワードに変更してみた。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。