وردپرس نسخه 3,0+مرجع توابع مورد استفاده در کد نویسی پوسته
توابع لیست ها و منوهای افتادنی
WP Dropdown Categories wp_dropdown_categories();
نمایش یا فراخوانی یک لیست افتادنی از دسته ها.
<?php wp_dropdown_categories($args); ?>
$args
Array
بازنویسی مقادیر اولیه. مقادیر پیش فرض:
| <?php $args = array( | ||
| 'show_option_all' | => | , |
| 'show_option_none' | => | , |
| 'orderby' | => | 'ID', |
| 'order' | => | 'ASC', |
| 'show_last_update' | => | 0, |
| 'show_count' | => | 0, |
| 'hide_empty' | => | 1, |
| 'child_of' | => | 0, |
| 'exclude' | => | , |
| 'echo' | => | 1, |
| 'selected' | => | 0, |
| 'hierarchical' | => | 0, |
| 'name' | => | 'cat', |
| 'id' | => | , |
| 'class' | => | 'postform', |
| 'depth' | => | 0, |
| 'tab_index' | => | 0, |
| 'taxonomy' | => | 'category', |
| 'hide_if_empty' | => | false |
| ); | ||
| ?> |
در حالت پیش فرض، نتایج به صورت زیر خواهند بود:
- دسته ها بر اساس آیدیشان به صورت سعودی مرتب می شوند
- آخرین تاریخ به روزرسانی نمایش داده نمی شود
- تعداد نوشته های هر دسته نمایش داده نمی شود
- دسته های خالی (بدون نوشته) نمایش داده نمی شوند
- هیچ موردی چشم پوشی نمی گردد
- دسته ها را نمایش می دهد(echo)
- هیچ دسته ای به صورت پیش فرض انتخاب شده نیست
- دسته ها را به صورت درختی نمایش نمی دهد
- نام فرم 'cat' می باشد
- به فرم کلاس 'postform' نسبت داده می شود
- آیدی ای برای لیست تعیین نمی شود پس نام لیست به عنوان آیدی نسبت داده می شود
- محدودیتی در عمق دسته ها وجود ندارد
- Tab index لیست برابر 0 می باشد
- انتخاب دسته (category) ها به عنوان رده بندی (taxonomy)
- لیست افتادنی در صورت خالی بودن مخفی می شود
WP Dropdown Pages wp_dropdown_pages();
لیستی از برگه ها را در یک عنصر select (لیست افتادنی) بدون دکمه ارسال نمایش خواهد داد.
<?php wp_dropdown_pages($args); ?>
$args
آرایه
مقادیر پیش فرض:
| <?php $args = array( | ||
| 'depth' | => | 0, |
| 'child_of' | => | 0, |
| 'selected' | => | 0, |
| 'echo' | => | 1, |
| 'name' | => | 'page_id', |
| 'show_option_none' | => | |
| 'exclude' | => | |
| 'exclude_tree' | => | |
| ); | ||
| ?> |
در حالت پیش فرض، نتایج به صورت زیر خواهند بود:
- برگه های مادر و فرزند به صورت درختی نمایش داده خواهند شد
- تمامی برگه ها نمایش داده می شوند
- هیچ برگه ای انتخاب شده نخواهد بود
- نام لیست افتادنی 'page_id' می باشدس
- قابلیت انتخاب نکردن هیچ یک از برگه ها فراهم است (show_option_none)
WP Dropdown Users wp_dropdown_users();
لیستی از کاربران را در یک عنصر select (لیست افتادنی) بدون دکمه ارسال نمایش می دهد.
<?php wp_dropdown_users($args); ?>
$args
آرایه
مقادیر پیش فرض:
| <?php $args = array( | ||
| 'show_option_all' | => | , |
| 'show_option_none' | => | , |
| 'orderby' | => | 'display_name', |
| 'order' | => | 'ASC', |
| 'include' | => | , |
| 'exclude' | => | , |
| 'multi' | => | 0, |
| 'show' | => | 'display_name', |
| 'echo' | => | 1, |
| 'selected' | => | 0, |
| 'name' | => | 'user', |
| 'class' | => | |
| ); | ||
| ?> |
show_option_all
رشته
فراهم کردن قابلیت انتخاب همه ی کاربران.
show_option_none
رشته
فراهم کردن قابلیت انتخاب هیچ یک از کاربران.
orderby
رشته
خصوصه مورد نظر جهت مرتب سازی بر اساس آن. مقادیر معتبر:
- 'ID'
- 'user_nicename'
- 'display_name' - پیش فرض
order
رشته
ترتیب نمایش کاربران. مقادیر معتبر:
- 'ASC' - پیش فرض
- 'DESC'
include
رشته
آیدی کاربرانی که مایل به نمایش آن ها در لیست هستید.
exclude
رشته
آیدی کاربرانی که مایل به نمایش آن ها نیستید. به صورت پیش فرض تمامی کاربران به لیست افزوده خواهند شد.
multi
بولی
تعیین نادیده گرفتن خصوصه ی ID در عنصر select. مقدار پیش فرض، False می باشد.
show
رشته
عنوان ستون کاربر در پایگاه داده جهت نمایش (تعیین نمایش کاربران بر اساس مشخصه مورد نظر). اگر عنوان انخاب شده برای یک کاربر خالی باشد، user_login نمایش داده خواهد شد.
- 'ID'
- 'user_login'
- 'display_name' - پیش فرض
echo
بولی
نمایش کاربران (True) یا فراخوانی برای استفاده در کد پی اچ پی (False). مقدار پیش فرض: True.
selected
عدد صحیح
آیدی کاربری که به صورت پیش فرض انتخاب شده است. در حالت پیش فرض کاربری انتخاب نمی شود.
name
نوع: رشته
نام اختصاص یافته به لیست. مقدار پیش فرض 'user' می باشد.
class
نوع: رشته
اگر مایلید می توانید با مقداردهی این پارامتر یک کلاس به لیست اختصاص دهید.
WP Get Archiveswp_get_archives();
این تابع یک لیست از بایگانی بر اساس تاریخ نمایش خواهد داد. این تابع می تواند هر جایی از پوسته مورد استفاده قرار گیرد.
<?php wp_get_archives($args); ?>
$args
آرایه
مقادیر پیش فرض:
| <?php $args = array( | ||
| 'type' | => | 'monthly', |
| 'limit' | => | , |
| 'format' | => | 'html', |
| 'before' | => | , |
| 'after' | => | , |
| 'show_post_count' | => | false, |
| 'echo' | => | 1 |
| ); | ||
| ?> |
در حالت پیش فرض، نتایج زیر حاصل می شوند:
- پیوندهای بایگانی های ماهانه نمایش داده می شوند
- تمامی بایگانی ها نمایش داده می شوند (محدودیتی در تعداد وجود ندارد)
- بایگانی ها را در یک لیست اچ تی ام ال <li> قرار می دهد
- قبل یا بعد از هر پیوند چیزی افزوده نمی شود
- تعداد مطالب نشان داده نمی شود
WP List Authorswp_list_authors();
نمایش لیستی از نویسنده های سایت، اگر کاربری نوشته ای منتشر کرده باشد، نام نویسنده به همراه پیوندی به نوشته هایش نمایش داده می شود. می توانید از این تابع طوری استفاده کنید که تعداد نوشته های هر نویسنده را و پیوند به فید آر اس اس او را نمایش دهد.
<?php wp_list_authors($args); ?>
$args
آرایه
مقادیر پیش فرض:
| <?php $args = array( | ||
| 'optioncount' | => | false, |
| 'exclude_admin' | => | true, |
| 'show_fullname' | => | false, |
| 'hide_empty' | => | true, |
| 'echo' | => | true, |
| 'feed' | => | [empty string], |
| 'feed_image' | => | [empty string], |
| 'style' | => | list, |
| 'html' | => | [empty string] |
| ); | ||
| ? |
در حالت پیش فرض، عملکرد تابع به این صورت می باشد:
- تعداد نوشته ها نمایش داده نمی شود
- مدیر را از لیست شده مستثنا می کند
- مقداری را که کاربر جهت نمایش عمومی نام انتخاب کرده نمایش می دهد"
- کاربرانی که نوشته ای ارسال نکرده اند، در لیست قرار ندارند
- نتایج را نمایش می دهد
- فید نویسنده یا عکس او نمایش داده نمی شود
- خروجی به صورت لیست خواهد بود
- خروجی ها با HTML معتبر برگردانده می شوند
WP List Categorieswp_list_categories();
لیستی از دسته ها را به صورت پیوند نمایش خواهد داد. وقتی روی پیوند یک دسته کلیک شود، صفحه حاوی لیست نوشته های دسته باز می شود. نکته: عملکرد این تابع شبیه توابع list_cats و wp_list_cats می باشد که هر دو منسوخ شده اند.
<?php wp_list_categories($args); ?>
$args
آرایه
مقادیر پیش فرض:
| <?php $args = array( | ||
| 'show_option_all' | => | , |
| 'orderby' | => | 'name', |
| 'order' | => | 'ASC', |
| 'show_last_update' | => | 0, |
| 'style' | => | 'list', |
| 'show_count' | => | 0, |
| 'hide_empty' | => | 1, |
| 'use_desc_for_title' | => | 1, |
| 'child_of' | => | 0, |
| 'feed' | => | , |
| 'feed_type' | => | , |
| 'feed_image' | => | , |
| 'exclude' | => | , |
| 'exclude_tree' | => | , |
| 'include' | => | , |
| 'hierarchical' | => | true, |
| 'title_li' | => | __( 'Categories' ), |
| 'number' | => | NULL, |
| 'echo' | => | 1, |
| 'depth' | => | 0, |
| 'current_category' | => | 0, |
| 'pad_counts' | => | 0, |
| 'taxonomy' | => | 'category', |
| 'walker' | => | 'Walker_Category' |
| ); | ||
| ?> |
در حالت پیش فرض، عملکرد تابع به صورت زیر خواهد بود:
- پیوندی به تمامی دسته ها وجود ندارد
- لیست دسته ها را بر اساس نام دسته و به صورت صعودی مرتب می کند
- آخرین به روز رسانی را نمایش نمی دهد (آخرین نوشته به روز رسانی شده هر دسته)
- لیست دسته ها در یک Unordered list قرار می گیرد
- تعداد نوشته ها را نمایش نمی دهد
- تنها دسته هایی که شامل نوشته هستند نمایش داده می شوند
- خصوصیت title تگ پیوند را برابر توضیحات دسته تنظیم می کند
- توسط پارامتر child_of محدود نشده است
- فید یا عکسی برای فید نمایش داده نخواهد شد
- تمامی دسته ها نمایش داده می شوند و از دسته ای چشم پوشی نمی گردد
- به دسته فعال (اگر کاربر در حال دیدن یک دسته باشد) کلاس 'current-cat' افزوده می شود
- دسته ها را به صورت درختی نمایش می دهد
- "دسته" به عنوان تیتر بالای لیست قرار می گیرد
- محدودیتی توسط اس کیو ال لحاظ نشده است
- دسته ها را نمایش می دهد (echo می کند)
- محدودیتی در عمق وجود ندارد
- تمامی دسته ها.
- لیست توسط کلاس Walker_Category بارگذاری می شود
WP List Comments wp_list_comments();
دیدگاه های یک نوشته یا برگه را بر اساس آرگومان های تابع نمایش می دهد
<?php wp_list_comments($args); ?>
$args
آرایه
مقادیر پیش فرض:
| <?php $args = array( | ||
| 'walker' | => | null, |
| 'max_depth' | => | , |
| 'style' | => | 'ul', |
| 'callback' | => | null, |
| 'end-callback' | => | null, |
| 'type' | => | 'all', |
| 'page' | => | , |
| per_page' | => | , |
| 'avatar_size' | => | 32, |
| 'reverse_top_level' | => | null, |
| 'reverse_children' | => | |
| ); | ||
| ?> |
avatar_size
عدد صحیح
ابعادی که آواتار باید نمایش یابد (برحسب پیکسل) مقدار پیش فرض: 32. گراواتار از طول یا عرض با ابعاد حداقل 1 پیکسل و حداکثر 512 پیکسل پشتیبانی می کند
style
رشته
نوع عنصری که دیدگاه ها باید در آن قرار داده شوند. مقادیر قابل قبول 'div'، 'ol'، یا 'ul'. پیش فرض 'ul' می باشد. نکته: ساختاری که انتخاب می کنید، باید مطابق با ساختاری باشد که این تابع را احاطه کرده است. مثلا <div class="commentlist"><?php wp_list_comments(array('style' => 'div')); ?></div> یا <ol class="commentlist"><?php wp_list_comments(array('style' => 'ol')); ?></ol>
type
رشته
نوع دیدگاه ها برای نمنایش. گزینه های قابل استفاده 'all'، 'comment'، 'trackback'، 'pingback' یا 'pings' می باشد. 'pings' شامل 'trackback' و 'pingback' است. مقدار پیش فرض 'all' می باشد.
reply_text
رشته
متن پیوند پاسخ دادن به دیدگاه. (این پارامتر به این تابع تعلق ندارد اما به تابع get_comment_reply_link ارسال می شود.) مقدار پیش فرض 'پاسخ دادن' است.
login_text
رشته
متن نمایش یافته هنگامی که کاربران برای ارسال دیدگاه باید وارد شوند. (این پارامتر به این پارامتر تعلق ندارد اما به تابع get_comment_reply_link ارسال می شود.) متن پیش فرض 'ببخشید، برای نوشتن دیدگاه باید وارد بشوید' است.
callback
رشته
نام تابع دلخواه جهت نمایش دیدگاه ها. مقدار پیش فرض null است. استفاده از این پارامتر به شما قابلیت استفاده از تابعی دلخواه برای نمایش دیدگاه ها را می دهد.
reverse_top_level
بولی
اگر این پارامتر مقدارش True باشد، ترتیب دیدگاه ها برعکس خواهد بود. یعنی جدیدترین ها بالاتر قرار می گیرند.
reverse_children
رشته
اگر true باشد دیدگاه های زیرمجموعه (فرزند) دارای ترتیب بلعکس می شوند. یعنی جدیدتر ها بالاتر قرار می گیرند.
WP List Pages wp_list_pages();
لیست برگه های وردپرس را نمایش می دهد. این تابع معمولا برای سفارشی کردن نوارکناری یا سربرگ استفاده می شود اما می توان در جاهای دیگر نیز از آن استفاده نمود.
<?php wp_list_pages($args); ?>
$args
آرایه
پارامترهای پیش فرض:
| <?php $args = array( | ||
| 'depth' | => | 0, |
| 'show_date' | => | , |
| 'date_format' | => | get_option('date_format'), |
| 'child_of' | => | 0, |
| 'exclude' | => | , |
| 'include' | => | , |
| 'title_li' | => | __('Pages'), |
| 'echo' | => | 1, |
| 'authors' | => | , |
| 'sort_column' | => | 'menu_order, post_title', |
| 'link_before' | => | , |
| 'link_after' | => | , |
| 'exclude_tree' | => | |
| ); | ||
| ?> |
خروجی تابع در حالت پیش فرض:
- تمامی برگه ها و زیرمجموعه هایشان نمایش داده خواهند شد (محدودیتی در عمق نیست)
- تاریخ ایجاد نمایش داده نمی شود
- با پارامتر child_of محدود نشده
- از لیست کردن هیچ برگه ای چشم پوشی نمی شود
- عنوانی که بالای لیست برگه ها نمایش داده می شود "برگه‌ها" می باشد
- خروجی نمایش داده می شود (echo می شود)
- به برگه های ایجاد شده توسط یک کاربر خاص محدود نیست
- ابتدا براساس ترتیب برگه‌ها و سپس براساس عنوان برگه‌ها مرتب می شوند.
- به صورت صعودی مرتب می شوند (به عنوان مقادیر پیش فرض در بالا لیست نشده است)
- برگه‌ها به صورت درختی نمایش داده می شوند (به عنوان مقدار پیش فرض در بالا لیست نشده است)
- لیست شامل تمامی برگه‌ها است (به عنوان مقدار پیش فرض در بالا لیست نشده است)
- به برگه هایی با مشخصات خاص محدود نشده است (به عنوان مقدار پیش فرض در بالا لیست نشده است)
- تمامی برگه‌های مادر و فرزند نمایش داده خواهند شد
WP Page Menu wp_page_menu();
لیستی از برگه های سایت نمایش می دهد و همچنین قابلیت افزودن صفحه اصلی به این لسیت فراهم است. این تابع معمولا برای سفارشی کردن نوارکناری یا سربرگ استفاده می شود اما می تواند در جاهای دیگر نیز مورد استفاده قرار گیرد.
<?php wp_page_menu($args); ?>
$args
آرایه
پارامترهای پیش فرض:
| <?php $args = array( | ||
| 'sort_column' | => | 'menu_order, post_title', |
| 'menu_class' | => | 'menu', |
| 'include' | => | , |
| 'exclude' | => | , |
| 'echo' | => | true, |
| 'show_home' | => | false, |
| 'link_before' | => | , |
| 'link_after' | => | |
| ); | ||
| ?> |
در حالت پیش فرض، خروجی تابع به قرار زیر خواهد بود:
- براساس ترتیب فهرست و عنوان مرتب می شوند
- کلاس تگ div برابر 'menu' می باشد
- از لیست کردن برگه ای چشم پوشی نشده است
- خروجی نمایش داده می شود (echo می شود)
- متنی قبل یا بعد از پیوند درج نمی شود
- صفحه اصلی به لیست صفحات افزوده نمی شود
- نکته: خروجی با تگ های <ul> و </ul> احاطه می شود