get_shortcode_list

(CDBT 2.0.0)

get_shortcode_list指定したショートコードの一覧を取得します

Description

array get_shortcode_list ( [ string $shortcode_type ] )
指定したショートコードの一覧を取得します。

Parameters

shortcode_type
取得するショートコードの種別を表す文字列。未指定時にはすべてのショートコードが対象になります。

ショートコードの種別は下記のとおりです。

種別 ショートコードの属性
built-in 現在のプラグインで有効なビルドインショートコード
deprecated バージョン2で無効になった非推奨ショートコード
custom ユーザーが定義したカスタムショートコード

Return

指定した種別に合致するショートコードの配列が返ります。ショートコード配列の構成要素は下記のようになります。

array(
  [{shortcode_name}] => array(
    ["method"] => string, // ショートコードが実行するメソッド名
    ["description"] => string, // ショートコードの説明
    ["type"] => string, // ショートコード種別
    ["author"] => int, // ショートコード登録ユーザーのユーザーID（`0`の場合はシステムが定義）
    ["permission"] => string, // ショートコードにアクセス可能なユーザーロール（複数ある場合はカンマ区切りの文字列）
    ["alias_id"] => string, // カスタムショートコードID（CSID）。カスタムショートコード以外はNULLとなる
  ), 
  [{shortcode_name}] => array( // 次のショートコード
  ), 
  ...
);

History

バージョン 内容
2.0.0 新規追加
2.0.7 不具合を修正

Example

<?php
  global $cdbt;
  print_r( $cdbt->get_shortcode_list( "custom" ) );

Reference

Related Methods