WordPress

WordPress ショートコードをエスケープする方法

投稿日:2017年8月18日 更新日:

Wordpress Logo

ショートコードを使っているプラグインは結構あります。Table of Contents PlusやPz-LinkCardなどがそうです。さて、これらのショートコードを投稿に載せるときにどうしていますか?[toc]を文字として打ち出そうとすると目次に変換されてしまって困ったりしていませんか?エスケープするのにはどうすればよいのでしょうか?

komatta_man2

知ってる人にとっては本当にくだらない内容と思います。しかし、知らない人もいるのです。

<スポンサーリンク>

ショートコードとは?

半角のカッコで括られた命令のようなものです。編集している間はただの文字ですが、公開する際に準備されたコードによって意味のある文字列に変換されます

例えば、Table of Contents Plusでは以下のようなショートコードを用いています。

[toc]

[toc heading_levels=2]

何が問題なのか?

文字列として”[”と”]”で括られているものをショートコードと認識します。もちろん括弧の中の文字は定められている文字列です。それらは置換されてしまうので、[toc]のように文字として打ち出す際にエスケープしてあげる必要があります。

前述しているような  [toc] は当たり前のように表示されていますが、普通に[toc]と書いてしまうと、目次に変換されます。従って、

”ショートコードは[toc]のように書くのです!”

のような文章を書くのが難しいのです。

 

もちろん最初は私もわからなくて、超悩みました。

 

あるサイトではきちんと[toc]のように表示されていたり、よくよく見るとそれは画像だったりしていました。

もちろん、私の投稿はきちんと文字になっています。よければご覧ください。

<code></code>でエスケープできるんじゃないのか?

できないんですね。

私も最初は深く考えずにこんな感じにやってみました。

<code>[toc]</code>

見事にエスケープされず、目次になりました。しかし、これが正解なのではないかと思って、これで結構粘りましたね。(苦)

&とか付ければいいんじゃないの?

さすがにこれが正解だとは思いませんでしたが・・・

 

一応、やってみました。

 

もちろんできませんでした。(汗)

エスケープの正解はこれだ

正解はこれです。

[[toc]]

きちんと調べれば書いてあるんです。

WordPress Codex日本語版 ショートコード

中段ぐらいに以下の記載があります。

投稿の中でふつうはショートコードを表す文字列をただの文字列として使いたい場合があります。そうするには1組ではなく2組のかぎかっこを使ってショートコードをエスケープする必要があります。例えば次のように投稿内に表示するには:

[gallery]

次のように書きます:

[[gallery]]

開始タグと終了タグを持つショートコードの場合は、一番最初と一番最後のかぎかっこをエスケープする必要があります:

[[shortcode] … [/shortcode]]

引用元:WordPress Codex 日本語版 ショートコードより

もちろん、上記の引用もそのままコピー&ペーストすると括弧が足りない(gallery で変換されてしまう)ので、括弧[]を足してあげています。

追記:2017/08/24

開始タグと終了タグを持つショートコードの場合、こちらの表記の方が正しいかもしれません。

[[[shortcode] … [/shortcode]]]

<スポンサーリンク>

まとめ

最初はわからないのは当たり前なので恥ずかしいことではないのです。

しかし、意外にこのような常識がわからなかったりもするのです。この投稿見て”ハッ!”とする人もいるんじゃないかと思っています。

そして、こういうニッチな話はネットで見つけにくかったりします。実際に私はこの情報に中々当たりませんでした。

  • ショートコードをエスケープしたい場合は括弧を重ねる
  • <code></code>で囲ってもエスケープできない

お役に立てば嬉しいです。

-WordPress
-

執筆者:

<スポンサーリンク>

comment

メールアドレスが公開されることはありません。

*

関連記事

whiteboard

WordPress 画面が真っ白になって超焦った話

WordPress環境でプラグインのスクリプトを修正しようとしていたら、WordPressの管理画面、もちろん、ページ自体にもアクセスできなくなりました。正確には真っ白な画面になりました。「ああ、これ…

もっと見る

jibun_sagashi_man

WordPress 自分の投稿で自分の投稿に勝手にコメントさせない方法

WordPress環境で、自分の投稿にリンクを張っている投稿をすると勝手にコメントがついたりしませんか?いままでは一つ一つ手で削除していたのですが、面倒になり調べました。どうやら、WordPressの…

もっと見る

wordpress-logo

WordPress 5の新エディターが酷かったので Classic Editor を入れた

WordPress4.9で粘っていたのですが、5.1.1が出たということで粗方バグも処理されているだろうと思いUpdateしました。ところがGutenbergという新エディターがあまりにも使いにくかっ…

もっと見る

YoastSEO-logo

WordPress SEO対策 Yoast SEOの初期設定(初心者向け)

WordPress環境にYoast SEOを入れてみました。Yoast SEOは高機能のSEO対策プラグインです。初期の設定、一部機能の使い方などをまとめてみました。とても良いプラグインなので、一度イ…

もっと見る

サイト内の検索はこちらから

サイト内の検索はこちらから

サイト内の検索はこちらから

カテゴリー

アーカイブ

最近の投稿
Scroll Up