インストール

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

  1. npm install @wordpress/shortcode --save

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

API

attrs

ショートコード属性を解析します。

ショートコードは多くのタイプの属性を受け入れます。これらは主に名前付き属性と数値属性に分けられます：

名前付き属性はキー/値の形式で割り当てられ、数値属性は配列として扱われます。

名前付き属性は、name="value"、name='value'、またはname=valueのいずれかの形式でフォーマットできます。数値属性は"value"または単にvalueの形式でフォーマットできます。

パラメータ

  • テキスト string: シリアライズされたショートコード属性。

戻り値

  • WPShortcodeAttrs: 解析されたショートコード属性。

default

ショートコードインスタンスを作成します。

ショートコードの生の表現にアクセスするには、optionsオブジェクトを渡します。このオブジェクトには、tag文字列、attrsの文字列またはオブジェクト、ショートコードのtype（‘single’、‘self-closing’、または‘closed’）を示す文字列、およびcontent文字列が含まれます。

パラメータ

  • オプション Object: 説明されたオプション。

戻り値

  • WPShortcode: ショートコードインスタンス。

fromMatch

RegExpマッチからショートコードオブジェクトを生成します。 

  2. *パラメータ*  
  4. - マッチ `````Array`````: マッチ配列。
  6. *戻り値*  
  8. - `````WPShortcode`````: ショートコードインスタンス。
  9.  <a name="next"></a>
  12. ### next
  14. 次の一致するショートコードを見つけます。  
  16. *パラメータ*  
  18. - タグ `````string`````: ショートコードタグ。 
  19. - テキスト `````string`````: 検索するテキスト。 
  20. - インデックス `````number`````: 検索を開始するインデックス。
  22. *戻り値*  
  24. - `````WPShortcodeMatch | undefined`````: 一致した情報。
  25.  <a name="regexp"></a>
  28. ### regexp
  30. ショートコードを識別するためのRegExpを生成します。  
  32. 基本の正規表現は、`````wp-includes/shortcodes.php`````の`````get_shortcode_regex()`````に見られるものと機能的に同等です。  
  34. キャプチャグループ：  
  36. - 1*.* ショートコードをダブル`````[[]]`````でエスケープするための追加の`````[
  • 2. ショートコード名
  • 3. ショートコード引数リスト
  • 4. 自己閉じる/
  • 5. コンテンツをラップするショートコードの内容。
  • 6. 閉じタグ。
  • 7. ダブル[[]]でショートコードをエスケープするための追加の]

パラメータ

  • タグ string: ショートコードタグ。

戻り値

  • RegExp: ショートコードRegExp。

replace

テキストブロック内の一致するショートコードを置き換えます。

パラメータ

  • タグ string: ショートコードタグ。
  • テキスト string: 検索するテキスト。
  • コールバック Function: マッチを処理し、置き換え文字列を返す関数。

戻り値

  • string: ショートコードが置き換えられたテキスト。

string

ショートコードパラメータから文字列を生成します。

ショートコードインスタンスを作成し、文字列を返します。

shortcode()コンストラクタと同じoptionsを受け入れ、tag文字列、attrsの文字列またはオブジェクト、ショートコードをsingleタグを使用してフォーマットするかどうかを示すブール値、およびcontent文字列を含みます。

パラメータ

  • オプション Object:

戻り値

  • string: ショートコードの文字列表現。

このパッケージへの貢献

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

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な[https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md]をお読みください。