COLUM

コラム

Wayfinder でメニューを生成

MODX備忘録

2025/12/03

Wayfinder でメニューを生成

Wayfinderは、MODXへ同梱されている階層化されたメニューを作成するのに便利なスニペットです

 

スニペットコール
[[Wayfinder? &startId=`0`&level=`1`]]

※[ ]は半角に変換してください。

結果表示

 

主なパラメーター
Parameter Description Default
startId ドキュメントの一覧を表示するメニューの開始点(ドキュメントID)。サイトルートから開始する場合は0を指定します。 current docId
displayStart startIdで参照されるドキュメントをメニューに表示する。 0
level メニューを構築する深さ(レベル数)。0」はすべてのレベルを通過する。 0
limit limit パラメータを指定すると、Wayfinder はレベルごとに指定された数のアイテムのみを処理します。 0
ignoreHidden ドキュメントの「メニューに表示」チェックボックスは無視して、とにかくメニューに含める。 0
ph 出力を直接返す代わりに、出力結果に設定するプレースホルダーの名前。 0
debug トラブルシューティングのためにデバッグモードを有効にするには'1'を設定する。 0
hideSubMenus アクティブなサブメニューのみを出力する場合は'1'に設定する。 0
removeNewLines 出力から改行文字を取り除くには'1'を設定する。 0
textOfLinks 実際のリンクテキストを取得するフィールド。とりうる値: menutitle, id, pagetitle, description, parent, alias, longtitle, introtext menutitle
titleOfLinks リンクタイトルを取得するフィールド。とりうる値: menutitle, id, pagetitle, description, parent, alias, longtitle, introtext pagetitle
rowIdPrefix このパラメータが設定されている場合、各項目に一意の ID が作成されます。値は rowIdPrefix + docId となります。 0
useWeblinkUrl 1に設定すると、ウェブリンク文書で指定されたリンクは、ウェブリンクへのリンクではなく、プレースホルダ [ wf.link] に出力されます。 1
includeDocs メニューに含める文書IDのカンマ区切りリスト。  
excludeDocs メニューから除外する文書IDのカンマ区切りリスト。 0
cacheResults クエリをキャッシュして読み込みを高速化 ( 2.2.0-rc1 で追加)  
cacheTime cacheResults が 1 の場合、キャッシュされたメニューを保存する秒数。キャッシュが手動でクリアされるまで無期限に保存する場合は 0 を設定する。 3600
contexts メニューの構築に使用するコンテキスト。デフォルトは現在のコンテキスト。( 2.2.0-rc1 で追加)  
startIdContext ( added in 2.2.0-rc1)  
config Wayfinderを設定するための外部phpファイル(例はcore/components/wayfinder/configsを参照)。  
scheme URL の生成方法のフォーマット。指定可能な値は (makeURL API 呼び出しに基づく): -1 : (デフォルト値) URLはsite_urlからの相対 URL、0: httpを参照、1: httpsを参照、full: URLは絶対で、configからsite_urlを前置する: URLは絶対、設定からbase_urlを前置、http: URLは絶対、httpスキームを強制、https: URLは絶対、httpsスキームを強制 (2.3.1-plで追加) -1
sortBy どのフィールドでソートするか(例:'published'  
sortOrder ソート順、'ASC'または'DESC'  
where JSONスタイルのフィルタリングオプション。例えば、Articlesアドオンからブログやニュースを非表示にしようとするとき: where=[{"class_key:!=": "Article"}]。  
hereId スニペットに使用する現在のIDを定義します。hereTplとactiveRowParentTplで指定されたテンプレートがメニュー項目に正しく適用されない場合、の値を使用します。 iterated ID
hereTpl hereTpl テンプレートは、現在の項目がメニューに表示されているときに使用される。  

| 一覧へ |

CONTACT

092-406-9941

受付 9:30~18:00(土・日・祝日除く)

MEETING

福岡市近郊は
無料でお伺いします

九州