add_shortcode

説明

void add_shortcode( string $tag, mixed $func )
ショートコード(独自タグ)を追加する。ショートコードは、投稿記事内でテキスト内容がない[tag]や、テキストを内包する[tag]テキスト[/tag]の書式で使用できる独自タグのこと。標準の状態では、 the_content関数によって表示する直前のフィルター処理内でパラメータ$funcで指定した関数・メソッドが実行される。

パラメータ

  • $tag
    タグ名。
  • $func
    関数名またはメソッドを配列(例:array( $this, 'name' ))で指定。

返り値

返り値はありません。

注意

登録の際パラメータ$funcが有効かどうかを調べるが、無効な場合でもエラーは返らない。また、すでにパラメータ$tagで指定されたショートコードが登録されている場合は上書きされる。
なおパラメータ$funcで指定した関数・メソッドでは、独自処理(テキスト加工)した文字列を返すこと(echoやprint関数を使って表示してはいけない)。

使用例

  • [func_link]というショートコードを追加する。
    <?php
    add_shortcode( 'func_link', 'tag_func_link' );
    function tag_func_link( $atts, $content='' ) {
    	extract( shortcode_atts( array(
    		'target' => '_self',
    		), $atts ) );
    	return '<a href="/function/'.$content.'.html" target="'.
    		attribtue_escape( $target ).'">'.$content.'</a>';
    }
    ?>
  • クラスを使用して[var_link]というショートコードを追加する。
    <?php
    class my_shortcode {
    	function my_shortcode() {
    		add_shortcode( 'var_link', array( $this, 'tag_var_link') );
    	}
    	function tag_var_link( $atts, $content='' ) {
    		return '<a href="/var/'.$content.'.html">$'.
    			$content.'</a>';
    	}
    }
    ?>

最終更新 : 2013年08月08日 15:33



お勧め

LevelとCapability(2011年4月14日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

プラグインのヘッダー情報を国際化対応しよう(2017年8月4日 更新)

バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。

投稿一覧に独自リンクを追加する(2013年10月16日 更新)

管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

canvasタグを投稿したい(2013年12月27日 更新)

以前「投稿内容のid属性などを保存するための対策」で取り上げたように、WordPressでは投稿に記述できるHTMLタグが制限されている。同コラムでこの制限を調整する対策を紹介しているが、3.5以降ではフィルター関数を登録して対応できるようだ。