add_shortcode

（2.5.0以降）
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>';
	}
}
?>

最終更新 : 2018年05月27日 10:51

参考

Code Reference: add_shortcode

お勧め

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

リクエスト応答を終了する前に何かを処理する（2013年9月26日更新）

PHPでは、register_shutdown_function関数を使うことでリクエストに対してレスポンスを返した後に何らかの処理を行うことができる。WordPressでもregister_shutdown_function関数は使えると思うのだが、テーマ内のテンプレートでページを表示した後で何かを行う場合はどうすればいいのか、ちょっと調べてみた。

投稿情報を連想配列で参照する（2018年5月27日更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

段落ブロックに日付・時刻の入力支援を実装した（2023年1月25日更新）

ブロックエディターには文字入力を支援するAutocompleteがある。自作ブロックだけでなく既存のブロックに適用できるため、ブロックの利用シーンを踏まえた入力支援機能を追加できる。

ブロックエディターのタグ入力にタグクラウド機能を追加した（2019年1月10日更新）

ブロックエディターのタグ入力には「よく使われているタグから選択」から表示される「タグクラウド」がない。ブロックエディターの不満なところのひとつがこれであり、うまく解消することができないか考えてみた。

説明

パラメータ

返り値

注意

使用例

関連

参考

お勧め