開発(PHP):特定のリソースの情報を取得($modx->getDocument)
特定のリソースの情報を取得するには、$modx->getDocument
メソッドを使用します。
テンプレート変数は含まれませんのでご注意ください。
構文
引数名 | 型 | 初期値 | 説明 | |
---|---|---|---|---|
第一引数 必須 |
リソースID | integer | 0 | 取得するリソースのリソースID。 |
第二引数 | リソース変数名 | string | * | 取得する変数。 指定しない場合はすべてのリソース変数を取得する。 カンマ区切りで複数の情報を取得できる。 |
第三引数 | 公開対象 | integer | 1 | 対象のリソースが公開か非公開のどちらかの場合のみ取得する。 指定可能な値は次の通り。 0 ... 非公開1 ... 公開 |
第四引数 | 削除対象 | integer | 0 | 対象のリソースが削除済みかそうでないかの場合のみ取得する。 指定可能な値は次の通り。 0 ... 削除されていない1 ... 削除済み
|
戻り値
見つかった場合は連想配列、見つからなかった場合はfalseを返します。
第二引数を指定した場合、そのまま値を返すわけではなく指定していない場合と同じ連想配列で返します。(内容は第二引数で指定したリソース変数名のみのキーだけを返します。)