開発(PHP):リソースに設定してある複数のテンプレート変数の情報を取得

リソースに設定してある複数のテンプレート変数の情報を取得するには、$modx->getTemplateVarsメソッドを使用します。

構文

引数名 初期値 説明
第一引数 変数IDまたは変数名 array '*' 取得したいテンプレート変数またはリソース変数のIDまたは名前。
'*'を指定すると割り当てられている全てのテンプレート変数およびリソース変数を取得する。
array(3, 11)のように指定。
第二引数 取得する情報 string '*' 取得する情報のキー。
'*'を指定すると全てを取得する。
valueは必ず返すのでそれ以外を指定する。
第三引数 リソースID integer   テンプレート変数の情報を取得する対象のリソース。
空を指定すると現在のリソースを対象とする。
第四引数 公開/非公開 integer 1 対象のリソースが公開か非公開のどちらかの場合のみ取得する。
指定可能な値は次の通り。
0 ... 非公開
1 ... 公開
第五引数 並び替える基準 string 'rank' 戻り値の配列の順序を変更することが可能で、基準となるテンプレート変数またはリソース変数を指定する。
カンマ区切りで複数指定することが可能。
第六引数 順序 string 'ASC' 第五引数'並び替える基準'で指定したリソース変数を基準に順序方向を指定する。
指定可能な値は次の通り。
ASC ... 昇順
DESC ... 降順
第五引数'並び替える基準'に合わせてカンマ区切りで複数指定することが可能。

戻り値

取得に成功した場合は2次元配列、失敗した場合はfalseを返します。
テンプレート変数とリソース変数で取得可能な情報が違います。

テンプレート変数:
キー 説明
id テンプレート変数のID。
type "入力フォーム"で選択した値。
name テンプレート変数の名称。
caption "投稿画面内の見出し"のテキスト。
description 説明文章。
editor_type ※ 不明
category 選択したカテゴリーのインデックス番号。
locked ロックしているかどうか。
0 ... ロックしていない
1 ... ロック中
elements 選択フィールドの全選択肢。
rank 並び順。
display "プロセッサ"で選択した値。
display_params "プロセッサ"のURLパラメータ。
default_text 既定値。
value リソースに設定されている値。
リソース変数:
キー 説明
name リソース変数の名称。
value リソースに設定されている値。

サンプルコード

CMS「MODX Evolution」逆引きリファレンス一覧へ戻る