wp_nav_menu( array $args = array())
نمایش یک فهرست(navigation menu) در سایت
توضیحات wp_nav_menu()
زمانی که میخواهید فهرستی که کاربر ایجاد میکند را در قالب وردپرس نمایش دهید از این تابع میتوانید استفاده کنید و فهرستهای که کاربر در بخش فهرستهای وردپرس ایجاد میکند را نمایش دهید.
پارامترها wp_nav_menu()
args: آرایهای از آرگومانهای فهرست(nav menu). این پارامتر از نوع آرایه و اختیاری است و شامل پارامترهای زیر میباشد.
- menu: فهرست(nav menu)دلخواه. این پارامتر میتواند با مقدار شناسه منو(menu ID)، اسلاگ منو، یا یک آبجکت (int|string|WP_Term)مقداردهی شود.
- menu_class: کلاس css که برای تگ ul استفاده میشود در این بخش قرار میگیرد. به صورت پیش فرض کلاس menu میباشد.
- menu_id: از این پارامتر برای اختصاص ID به تگ ul در منو استفاده میشود.پیش فرض مقدار meun slug را یک عدد افزایشی است.
- container: در صورتی که به جای استفاده از ul از تگ دیگری برای طراحی منو استفاده میکنید در این پارامتر قرار دهید.
- container_class: کلاسی که میخواهید به container اعمال شود. پیش فرض به صورت menu-{menu slug}-container میباشد.
- container_id: شناسه (ID) که میخواهید به container اختصاص دهید.
- fallback_cb: اگر فهرستی وجود نداشته باشد تابع fallback_cb فراخوانی میشود. به صورت پیش فرض wp_page_menu فراخوانی میشود. یک مقدار false (callable|bool) برای فراخوانی نشدن fallback ست کنید.
- before: متنی که قبل از لینک میخواهید نمایش داده شود. مانند قرار دادن آیکن قبل از عنوان منو
- after: متنی که بعد از لینک نمایش داده میشود.
- link_before : متن قبل از لینک
- link_after: متن بعد از لینک
- echo: چاپ کردن منو به صورت پیش فرض true میباشد.
- depth: میزان عمق منو را مشخص میکند. 0 به معنی بی نهایت است. پیش فرض 0 است.
- walker: نمونه کلاس سفارشی walker
- theme_location: برای مشخص کردن موقعیت استفاده منو. اگر بخواهید از این گزینه استفاده کنید باید منو را در register_nav_menu() معرفی کرده باشید تا زمانی که کاربر فهرستی را ایجاد میکند نمایش یابد.
- item_wrap: نحوه نمایش و نگهدارنده منو. به صورت پیش فرض یک ul با id و class. از فرمت printf() با جایگزینی عددی.
- item_spacing: فاصله خالی بین تگ های html. مقدارهای ‘preserve’ یا ‘discard’ . مقدار پیش فرض ‘preserve’.
مقدار پیش فرض: array()
-
مقدار بازگشتی:
اگر پارامتر echo مقدار false باشد، یعنی منویی برای نمایش وجود ندارد(string|false|void)
منبع :
File: wp-includes/nav-menu-template.php