インストール

モジュールをインストールします 

  1. npm install @wordpress/escape-html

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。もし、言語機能やAPIのサポートが限られているか、全くない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含めるべきです。

API

escapeAmpersand

アンパサンドがエスケープされた文字列を返します。この実装は不完全であり、名前付き、10進数、または16進数の文字参照のパターンとして現れないアンパサンドのみがエスケープされます。無効な名前付き参照（すなわち、あいまいなアンパサンド）は依然として許可されます。

関連

パラメータ

  • value string: 元の文字列。

戻り値

  • string: エスケープされた文字列。

escapeAttribute

エスケープされた属性値を返します。

関連

また、wptexturizeによってHTML文字列を分割するために使用されるため、より大きな記号もエスケープします。これはWordPress特有の修正です。

Trac#45387の解決策が実現すれば、unstableEscapeGreaterThanを使用する必要はなくなります。

参照: https://core.trac.wordpress.org/ticket/45387

パラメータ

  • value string: 属性値。

戻り値

  • string: エスケープされた属性値。

escapeEditableHTML

エスケープされたEditable HTML要素の値を返します。これはescapeHTMLとは異なり、編集可能なHTMLの場合、すべてのアンパサンドをエスケープする必要があります。そうしないと、ページ上でコンテンツが正しく表示されません。

パラメータ

  • value string: 要素の値。

戻り値

  • string: エスケープされたHTML要素の値。

escapeHTML

エスケープされたHTML要素の値を返します。

関連

パラメータ

  • value string: 要素の値。

戻り値

  • string: エスケープされたHTML要素の値。

escapeLessThan

小なり記号が置き換えられた文字列を返します。

パラメータ

  • value string: 元の文字列。

戻り値

  • string: エスケープされた文字列。

escapeQuotationMark

引用符が置き換えられた文字列を返します。

パラメータ

  • value string: 元の文字列。

戻り値

  • string: エスケープされた文字列。

isValidAttributeName

指定された属性名が有効であればtrueを返し、そうでなければfalseを返します。

パラメータ

  • name string: テストする属性名。

戻り値

  • boolean: 属性が有効かどうか。

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。