リソース変数一覧

リソース変数はリソースの投稿情報が格納されている変数です。
[*リソース変数名*]という構文で書きます。

目次
  1. 主なリソース変数
  2. 日付に関するリソース変数
  3. ユーザーに関するリソース変数
  4. リソース構造に関するリソース変数
  5. リソースの状態に関するリソース変数
  6. リソースの種別に関するリソース変数
  7. アクセス権限に関するリソース変数
  8. その他のリソース変数

主なリソース変数

リソース変数 名称 説明
[*id*] リソースID リソースごとの固有ID。
リソースを生成するごとに自動的に発行され割り当てられる。
管理画面ではツリーのリソース名の右側に括弧で表示されている。
[*content*] 本文 リソースの本文。
テキストエディタ（WYSIWYG）の場合はソースコードであるHTMLを返す。
ページのメインコンテンツのような箇所で使用されることを想定。
なお、ウェブリンクの参照先もこの変数で返す。
[*pagetitle*] リソース名 リソースの名前。
ページのタイトル（title要素やh1要素など）のような箇所で使用されることを想定。
管理画面ではツリーやサブリソース一覧で表示されている。
[*longtitle*] タイトル [*pagetitle*]と区別したいときに用いることができる。
管理画面ではなくページ側で使用するためのもの。
[*menutitle*] メニュータイトル ナビゲーションやメニューなどのような箇所で使用されることを想定。
管理画面のツリーなどとは無関係でページ側で使用するためのもの。
[*description*] 説明 リソースのページとしての説明文。
ページ側のmeta[name="description"]要素で使用されることを想定。
[*introtext*] 要約(序説) リソースのページとしての要約文。
ページのリード文や一覧で表示したときの説明文などで使用されることを想定。

日時に関するリソース変数

日時は年/月/日 時:分:秒 の形式で返します。
（$modx->documentObjectプロパティなど開発で使用する場合は、UNIX時間の形式（1970年1月1日 0時0分0秒からの経過秒数）で返します。）
書式を指定したい場合はモディファイアを使用します。
日時に関するモディファイアは モディファイア：日付の書式を変更 をご覧ください。

リソース変数 名称 説明
[*createdon*] 作成日時 リソースを作成した日時。
[*publishedon*] 公開日時 リソースが公開された日時。
リソースの[*published*]が公開状態になるたびに自動的に更新される。
[*pub_date*]とは関係がない。
[*editedon*] 更新日時 リソースが更新された日時。
リソースが更新されるたびに自動的にこの[*editedon*]も更新される。
[*pub_date*] 公開予定日時 リソースがページとして公開される日時。
設定した日時からページが公開（表示）される。
設定しないと即公開状態となる。
[*unpub_date*] 公開終了日時 リソースの公開を終了する日時。
設定した日時以降、ページが非公開（非表示）になる。
[*deletedon*] 削除日時 ページを削除した日時。
復元できる状態のリソースの場合のみ。
復元するとこの値は空になる。

ユーザーに関するリソース変数

リソース変数 名称 説明
[*createdby*] 作成者 リソースを作成したユーザーのID。
[*publishedby*] 公開者 リソースを公開したユーザーのID。
[*published*]を公開状態にしたユーザーのID。
[*editedby*] 編集者 リソースを更新したユーザーのID。
[*deletedby*] 削除者 リソースを削除を実行したユーザーのID。

ID以外の情報を得るにはモディファイアを使用します。
ユーザーに関するモディファイアは モディファイア：ユーザーに関する情報を取得 をご覧ください。

リソース構造に関するリソース変数

リソース変数 名称 説明
[*template*] テンプレート リソースで使用しているテンプレートのID。
[*parent*] 親リソース 1つ上の階層の親リソースのID。
[*menuindex*] メニューオーダー 管理画面上のツリーやサブリソース、ページ上のナビゲーションやメニューで表示する際の並び順。
主にWayfinderやDittoのスニペットなどで表示する際に用いられることを想定。
並び順を変更した際、同じ階層にあるリソースに同じ並び順が設定されている場合、設定は自動的に更新されるわけではなく同じ並び順のリソースはIDを基準にして並ぶ。
[*hidemenu*] メニューに表示 ナビゲーションやメニューで表示するかどうか。
主にWayfinderやDittoのスニペットなどで表示する際に用いられる。
管理画面上のツリーやサブリソース一覧の表示とは関係ない。
[*alias*] エイリアス グローバル設定にある「フレンドリーURLを使用」を「はい」で設定してある場合にURL表現として用いられる。

リソースの状態に関するリソース変数

リソース変数 名称 説明
[*published*] 公開ステータス 公開されているかどうか。
公開中は1、非公開は0が設定されている。
[*deleted*] 削除の状態 削除されているかどうか。
削除されている場合は1、削除されていない場合は0が設定されている。
[*cacheable*] キャッシュの有効無効 キャッシュするかどうか。
有効の場合は1、無効の場合は0が設定されている。
[*searchable*] 検索対象に含める 検索対象に含めるかどうか。
検索対象に含める場合は1、含めない場合は0が設定されている。
標準では使われることはない。
サイト内検索（AjaxSearchプラグインなど）を実装した際などに使用されることを想定。
[*donthit*] ログ記録の対象 アクセスログの対象にするかどうか。
標準では使われることはない。

リソースの種別に関するリソース変数

リソース変数 名称 説明
[*contentType*] コンテントタイプ リソース（ページ）のMIMEタイプ。
[*content_dispo*] コンテントディスポジション リソース（ページ）がブラウザから見た表示する方法。
HTTPヘッダーのContent-Dispositionにあたる。

アクセス権限に関するリソース変数

リソース変数 名称 説明
[*privateweb*] リソースグループ ウェブユーザグループでリソースグループとして属しているかどうか。
属している場合は1、属していない場合は0が設定されている。
[*privatemgr*] リソースグループ 管理ユーザグループでリソースグループとして属しているかどうか。
属している場合は1、属していない場合は0が設定されている。

その他のリソース変数

リソース変数 名称 説明
[*type*] リソースタイプ リソースが通常かウェブリンクか。
通常はdocument、ウェブリンクはreferenceが設定されている。
[*isfolder*] コンテナ属性 コンテナとして扱うかどうか。
コンテナの場合は1、そうでなければ0が設定されている。
コンテナはつまりフォルダのことだが、インデックスページとして扱われる。
[*link_attributes*] リンク属性 a要素などのリンクに関する属性。
標準では使われることはない。
[*richtext*] リッチテキストエディタで編集 リッチテキストエディタで編集するかどうか。
有効の場合は1、無効の場合は0が設定されている。

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