説明
あなたはショートコードをお使いですか?
現状のブロックエディタにも 標準のショートコード ブロックは存在します。
しかし それはコードを書かないと使用することができません。
また 他のブロックをショートコードで囲むことはできないため、あなたはHTMLコードを書く必要があります。
このプラグインはショートコード ブロックを提供します。単なるショートコードではなく、他のブロックを包むショートコード ブロックです。
** 簡単な設定 **
あなたはWordPressで有効にしたショートコードを選択するだけで使用可能です。
ショートコードの引数も設定可能です。
ブロックエディタのサイドバーで設定可能です。
またエディタ上のブロックには選択中のショートコード名が表示されます。
** 入れ子にできるブロック **
このブロックは「段落」や「画像」などのブロックを配置することが可能です。
ショートコード ブロックもネスト可能です。
例えば カスタムフィールドを列記できるショートコードと併用して 見出しと段落を繰り返して表記することも可能です。
このブロックは「覚書ラベル」を設定することが可能です。
このブロックの前後に指定したHTMLコメントアウトを記述します。
デザインの調整などに有用です。
設定しなければHTMLソースには記述されません。
** 置換キーワード **
このブロックはいくつかの置換キーワードを持ちます。
キーワードはショートコードの情報を表示するために使います。
例えば 追加CSSクラス に「%shortcode%」と記入すると 選択中のショートコード名 をCSSクラスに表記します。
このブロック自体は HTMLタグを出力しません。
「グループ」ブロックなどと併用してください。
このプラグインには サンプルショートコードとして「commentout」と「meta-loop」を同梱しています。
他にも多くのショートコードが世界には存在します。
このブロックで 有用なショートコード資産を活用してください。
使い方
子ブロック
子ブロック内で置換キーワードを利用することは可能です。
「Wrapping ShortCode」自体はHTMLタグを持ちません。
「グループ」ブロックを併用してください
ショートコード
あなたのWordPressサイト内で有効なショートコードを列記します。
使いたいショートコードを選択してください。
※Pro版(有償)では ショートコードの絞り込み機能を開発中。
ショートコードの引数
引数はオプションです。
指定したショートコードに設定する引数を設定できます。
キーなし引数とキーあり引数を混在させても問題はありません。
ダブルクォーテーションの有無にも対応しています。
引数内で置換キーワードを利用することは可能です。
覚書ラベル
覚書ラベルはオプションです。
このブロックの前後に指定したHTMLコメントアウトを記述します。
設定しなければHTMLソースには記述されません。
覚書ラベル内で置換キーワードを利用することは可能です。
追加CSSクラス
追加CSSクラスは標準項目です。
追加CSSクラスはオプションです。
追加CSSクラス内で置換キーワードを利用することは可能です。
置換キーワード
ブロック内に以下の置換キーワードがあれば、該当する値と置き換えます。
ただし ショートコードや子ブロックが入れ子の場合、置換キーワードはショートコードや子ブロックを優先します。
* %shortcode%: 選択中のショートコード名
* %shortcodeAttrs%: 設定したショートコードの引数
* %shortcodeStr%: 生成したショートコード文字列
* %wscClass%; 追加CSSクラス
ショートコード: commentout
概要
[commentout (引数) ]ここにコメント[/commentout]
ショートコードのコンテンツをHTMLコメントアウトとして表記します。
ショートコードの引数
- trim_br: コンテントの前後の< br > を除去。デフォルトは「yes」
- do_trim: コンテントの前後の空白を除去。デフォルトは「no」
- do_shortcode: コンテントのショートコードを実行。デフォルトは「yes」
- esc_html: コンテント内のHTMLタグをエスケープ。デフォルトは「yes」
ショートコード: meta-loop
概要
[meta-loop (引数) ]テンプレートHTML[/meta-loop]
投稿のカスタムフィールドのキーを列記することで ショートコードのコンテンツをテンプレートにして 繰り返します。
例)[meta-loop sample1 sample2 sample3 order=random]
#%number%) %key%:%value%
[/meta-loop]
ショートコードの引数
- (メタキー): 出力するカスタムフィールドのキー。複数可。省略時は連番。
- start: 出力開始位置。先頭は0。デフォルト「0」
- end: 出力終了位置。nullの場合はキーの数。デフォルト「null」
- step: 位置の増減値。デフォルト「1」
- lines: 出力数。デフォルト「null」。nullは最後まで出力。0は非表示
- order: ソートの方向。デフォルト「none」
** none: ソートしない。
** asc: 順ソート。
** desc: 逆ソート。
** random: ランダム。 - orderby: ソートする対象
** counter: 出力位置
** metakey: カスタムフィールドのキー
** metavalue: カスタムフィールドの値 - replaceNumber: 出力順位の置換キーワード。デフォルト「%number%」
- replaceCounter: 出力位置の置換キーワード。デフォルト「%counter%」
- repkaceKey: カスタムフィールドのキーの置換キーワード。デフォルト「%key%」
- repkaceValue: カスタムフィールドの値の置換キーワード。デフォルト「%value%」
- noContent: テンプレートを指定しない場合の代替コンテンツ。
- nl3br: カスタムフィールドの値内に改行がある場合のBRタグ変換の有無。デフォルト「yes」
代替コンテンツ
< div class=”no-%number%”>%key%:%value%
置換キーワード
- %counter%:0から始まる繰り返される番号
- %number%:1から始まる繰り返される番号
- %key%:カスタムフィールドのキー
- %value%:カスタムフィールドの値
スクリーンショット
ブロック
このプラグインは1個のブロックを提供します。
- Wrapping ShortCode This plugin provides a shortcode block. It is not just a shortcode, it is a shortcode block that wraps other blocks.
インストール
- プラグイン ファイルを
/wp-content/plugins/asm-wrapping-shortcode-block
ディレクトリにアップロードするか、WordPress プラグイン画面からプラグインを直接インストールします。 - WordPress の「プラグイン」画面でプラグインを有効化します
- 投稿やページの編集で ブロックエディタを選択して 「Wrapping ShortCode」ブロックを追加してください。
- ブロックを選択して「設定」から「ショートコード」「ショートコードの引数」を設定してください。
- そのブロック内にいくつかのブロックを配置してください。
FAQ
-
ショートコードを指定しないとどうなりますか?
-
そのブロック内に配置したブロックが表示されます。
-
引数を設定しないとどうなりますか?
-
引数はオプションです。
指定したショートコードに従います。 -
子ブロックが存在しないとどうなりますか?
-
子ブロックはオプションです。
何もおきません -
アイコンは何ですか?
-
日本の食べ物「おにぎり」です。
-
アイコンはなぜ「おにぎり」なのですか?
-
「おにぎり」は「海苔」で巻くことが多いです。
中のご飯が、子ブロック。
巻く「海苔」が ショートコードと見立てました。 -
キーなし引数とキーあり引数に対応しますか?
-
キーなし引数とキーあり引数を混在させても問題はありません。
内部で分けて処理します。
ダブルクォーテーションの有無にも対応しています。 -
置換キーワードは引数や覚書ラベル、追加CSSクラスでも使えますか?
-
使えます。
ただし、このブロックを入れ子にした場合、置換キーワードは子ブロックを優先します。
評価
このプラグインにはレビューがありません。
貢献者と開発者
変更履歴
0.1.0
- 公開