وردپرس نسخه 3,0+مرجع توابع مورد استفاده در کد نویسی پوسته
توابع مدیریت پیوندها
Get Bookmarkget_bookmark();
فراخوانی اطلاعات پیوند بر اساس آیدی آن.
<?php get_bookmark($bookmark, $output, $filter); ?>
$bookmark
عدد صحیح
آیدی پیوند.
$output
رشته
(اختیاری) خروجی به صورت OBJECT، ARRAY_N، یا ثابت ARRAY_A باشد. مقدار پیش فرض: OBJECT.
$filter
رشته
(اختیاری) مقدار پیش فرض: 'raw'
Get Bookmarksget_bookmarks();
این تابع یک آرایه از پیوندهای سایت را بر می گرداند. این تابع به کاربر اجازه فراخوانی مستقیم اطلاعات پیوند را می دهد.
<?php get_bookmarks($args); ?>
$args
آرایه
پیش فرض:
| <?php $args = array( | ||
| 'orderby' | => | 'name', |
| 'order' | => | 'ASC', |
| 'limit' | => | -1, |
| 'category' | => | , |
| 'category_name' | => | , |
| 'hide_invisible' | => | 1, |
| 'show_updated' | => | 0, |
| 'include' | => | , |
| 'exclude' | => | , |
| 'search' | => | |
| ); | ||
| ?> |
به صورت پیش فرض، نتایج زیر حاصل می شوند:
- تمامی پیوندها بر اساس نامشان به صورت سعودی مرتب می شوند.
- پیوند های خصوصی برگردانده نمی شوند.
- فیلد link_updated_f (زمان به روز رسانی پیوند) برگردانده نمی شود.
orderby
رشته
خصوصیتی که پیوندها باید براساس آن مرتب شوند. مقدار پیش فرض 'name' می باشد مگر اینکه مقدار '' (خالی) را به تابع بفرستید. در این صورت پیوندها بر اساس آیدی مرتب خواهند شد. مقادیر معتبر عبارتند از:
- 'id'
- 'url'
- 'name' - پیش فرض
- 'target'
- 'description'
- 'owner' - کاربری که پیوند را افزوده است.
- 'rating'
- 'updated'
- 'rel' - اگر این پیوند به یک شخص است و شما رابطه خود را با ایشان مشخص کرده اید (XFN).
- 'notes'
- 'rss'
- 'length' - طول نام پیوند، از کوتاه ترین به بلند ترین.
- 'rand' - نمایش پیوندها در ترتیب تصادفی.
order
رشته
حالت مرتب سازی، صعودی یا نزونلی. مقادیر معتبر:
- ASC - پیش فرض
- DESC
limit
عدد صحیح
حداکثر تعداد پیوندها برای نمایش. مقدار پیش فرض -1 است(نمایش همه پیوندها).
category
رشته
لیست آیدی دسته های پیوند ها (جدا شده با کاما).
category_name
رشته
نام دسته پیوند مورد نظر جهت فراخوانی پیوندها. مقدار پارامتر category را باطل می کند.
hide_invisible
بولی
TRUE باعث می شود تنها پیوندهایی که link_visible آن ها برابر 'Y' هست فراخوانی شود (پیوند هایی که خصوصی نیستند).
- 1 (True) - پیش فرض
- 0 (False)
show_updated
بولی
TRUE باعث درج یک ستون اضافه در نتایج با نام "link_category_f" و محتوای یکسان با "link_updated" می گردد. اما با ساختار زمانی یونیکس. برای استفاده توابع پی اچ پی با از این داده ها مفید است.
- 1 (True)
- 0 (False) - پیش فرض
include
رشته
آیدی پیوندهایی که مایلید خروجی شامل آن ها باشد. مثلا، 'include=1,3,6' به معنای برگرداندن یا نمایش پیوندهایی با آیدی های 1 و 3 و 6 می باشد. اگر از دستور include استفاده شود، پارامترهای category، category_name، و exclude نادیده گرفته می شوند. به صورت پیش فرض تمامی پیوند ها نمایش داده می شوند.
exclude
رشته
آیدی پیوندهایی که مایلید خروجی شامل آن ها نباشد. مثلا، 'exclude=4,12' به معنای این است که پیوندهایی با آیدی 4 و 12 در خروجی برگردانده یا نمایش داده نمی شوند. به صورت پیش فرض تمامی پیوندها نمایش داده می شوند.
search
رشته
link_url، link_name یا link_description را همانند متن جستجو، جستجو می کند.
WP List Bookmarkswp_list_bookmarks();
پیوندهای سایت را نمایش می دهد. این تابع به کاربر اجازه می دهد چگونگی مرتب سازی و نمایش پیوندها را تعیین کند. نکته: از تابع wp_list_bookmarks() به جای توابع منسوخ شده ی get_links_list() و get_links() استفاده کنید.
<?php wp_list_bookmarks($args); ?>
$args
Array
مقادیر پیش فرض:
| <?php $args = array( | ||
| 'orderby' | => | 'name', |
| 'order' | => | 'ASC', |
| 'limit' | => | -1, |
| 'category' | => | , |
| 'exclude_category' | => | , |
| 'category_name' | => | , |
| 'hide_invisible' | => | 1, |
| 'show_updated' | => | 0, |
| 'echo' | => | 1, |
| 'categorize' | => | 1, |
| 'title_li' | => | __('Bookmarks'), |
| 'title_before' | => | '<h2>', |
| 'title_after' | => | '</h2>', |
| 'category_orderby' | => | 'name', |
| 'category_order' | => | 'ASC', |
| 'class' | => | 'linkcat', |
| 'category_before' | => | '$lt;li id=%id class=%class>', |
| 'category_after' | => | '</li>' |
| ); | ||
| ?> |
به صورت پیش فرض خروجی تابع به قرار زیر خواهد شود:
- پیوندها براساس دسته هایشان تقسیم می شوند و نام هر دسته سرتیتر آن خواهد بود
- تمامی پیوندها بدون در نظر گرفتن نام دسته یا آیدی دسته نمایش خواهند یافت
- لیست براساس نام مرتب می شود
- یک عکس اگر وجودداشته باشد
- فاصله بین عکس و متن
- نمایش توضیحات پیوند
- عدم نمایش نمره پیوند
- تا موقعی که محدودیتی تعیین نشده باشد تمامی پیوندها نمایش می یابند
- پیوندها نمایش می یابند
$output
رشته
(اختیاری) خروجی به صورت OBJECT، ARRAY_N، یا ثابت ARRAY_A باشد. مقدار پیش فرض: OBJECT.
$filter
رشته
(اختیاری) مقدار پیش فرض: 'raw'
categorize
بولی
پیوندها باید دسته بندی شوند یا خیر.
- 1 (True) - پیش فرض
- 0 (False)
category
رشته
آیدی پیوندهایی که باید نمایش یابند. اگر وارد نشود، تمامی پیوندها نمایش می یابند (پیش فرض).
exclude_category
رشته
آیدی پیوندهایی که نباید نمایش یابند. اگر وارد نشود، تمامی پیوندها نمایش می یابند (پیش فرض).
category_name
رشته
نام دسته ای که پیوندهایش باید نمایش یابد. اگر مشخص نشود تمامی دسته ها به همراه پیوندهایشان نمایش داده خواهند شد (به صورت پیش فرض تمامی دسه ها).
category_before
رشته
متن مورد نظر جهت قراردادن پیش از هر دسته. مقدار پیش فرض '<li id="[category id]" class="linkcat">' می باشد.
category_after
رشته
متن مورد نظر جهت قراردادن پیش از هر دسته. مقدار پیش فرض '</li>' می باشد.
class
رشته
کلاسی که به هر آیتم از لیست دسته ها نسبت داده می شود. مقدار پیش فرض 'linkcat' می باشد. (این پارامتر در نسخه 2,2 اضافه شد)
category_orderby
رشته
مشخصه ای که دسته ها بر اساس آن مرتب می شوند. مقادیر معتبر:
- 'name' - پیش فرض
- 'id'
- 'slug'
- 'count'
- 'term_group' (تا کنون استفاده نشده است)
category_order
رشته
ترتیب مرتب سازی پارامتر category_orderby. مقادیر معتبر:
- ASC - پیش فرض
- DESC
title_li
رشته
متن سرتیتر لیست پیوندها. مقدار پیش فرض '__('Bookmarks')' می باشد که "پیوندها" را نمایش می دهد. (از __('') برای دادن امکان تغییر زبان در آینده استفاده شده است). تنها زمانی استفاده می شود که دسته بندی پیوندها روی 0 [false] قرار داشته باشد. (در غیر این صورت نام دسته ها استفاده خواهند شد). اگر 'title_li' روی null (0) تنظیم شده باشد، عنوانی نمایش داده نمی شود و لیست بین تگ های <ul>, </ul> قرار نخواهد گرفت (حتما باید دسته بندی را 0 [false] تنظیم کنید تا این قابلیت عمل کند).
title_before
رشته
متنی که باید پیش از توضیحات هر دسته قرار گیرد اگر 'categorize' برابر 1 [true] باشد، یا متنی که در "title_li" تعیین شده است اگر 'categorize' برابر 0 [false] باشد. مقدار پیش فرض '<h2>' می باشد.
title_after
رشته
متنی که باید پس از توضیحات هر دسته قرار گیرد اگر 'categorize' برابر 1 [true] باشد، یا متنی که در "title_li" تعیین شده است اگر 'categorize' برابر 0 [false] باشد. مقدار پیش فرض '</h2>' می باشد.
show_private
بولی
آیا دسته های پیوندی که به عنوان خصوصی علامتگذاری شده اند هم باید نمایش یابند؟. برای نمایش دسته های خصوصی (True) و برای عدم نمایش آن ها (False) استفاده می شود. مقدار پیش فرض: False.
include
رشته
آیدی پیوندهایی که مایلید خروجی شامل آن ها باشد. مثلا، 'include=1,3,6' به معنای برگرداندن یا نمایش پیوندهایی با آیدی های 1 و 3 و 6 می باشد. اگر از دستور include استفاده شود، پارامترهای category، category_name، و exclude نادیده گرفته می شوند. به صورت پیش فرض تمامی پیوند ها نمایش داده می شوند.
exclude
رشته
آیدی پیوندهایی که مایلید خروجی شامل آن ها نباشد. مثلا، 'exclude=4,12' به معنای این است که پیوندهایی با آیدی 4 و 12 در خروجی برگردانده یا نمایش داده نمی شوند. به صورت پیش فرض تمامی پیوندها نمایش داده می شوند.
orderby
رشته
خصوصیتی که پیوندها باید براساس آن مرتب شوند. مقدار پیش فرض 'name' می باشد مگر اینکه مقدار '' (خالی) را به تابع بفرستید. در این صورت پیوندها بر اساس آیدی مرتب خواهند شد. مقادیر معتبر عبارتند از:
- 'id'
- 'url'
- 'name' - پیش فرض
- 'target'
- 'description'
- 'owner' - کاربری که پیوند را افزوده است.
- 'rating'
- 'updated' تکته: فیلد link_updated تغییرات محلی را ردگیری نمی کند. زمانی ردگیری می کند که جایی که پیوند به آن اشاره دارد با درخواست های راه دور pingomatic به روز رسانی شود.
- 'rel' - اگر این پیوند به یک شخص است و شما رابطه خود را با ایشان مشخص کرده اید (XFN).
- 'notes'
- 'rss'
- 'length' - طول نام پیوند، از کوتاه ترین به بلند ترین.
- 'rand' - نمایش پیوندها در ترتیب تصادفی.
order
رشته
حالت مرتب سازی پیوندها، صعودی یا نزونلی. مقادیر معتبر:
- ASC - پیش فرض
- DESC
limit
عدد صحیح
حداکثر تعداد پیوندها برای نمایش. مقدار پیش فرض -1 است(نمایش همه پیوندها).
before
رشته
متن مورد نظر جهت قراردادن پیش از هر پیوند. مقدار پیش فرض: '<li>'.
after
رشته
متن مورد نظر جهت قراردادن پس از هر پیوند. مقدار پیش فرض: '</li>'.
link_before
رشته
متن جهت قراردادن پیش از عنوان هر پیوند (درون عنصر لینک). مقدار پیش فرض ندارد. (این پارامتر در نسخه 2,7 اضافه شد)
link_after
رشته
متن جهت قراردادن پس از عنوان هر پیوند (درون عنصر لینک). مقدار پیش فرض ندارد. (این پارامتر در نسخه 2,7 اضافه شد)
between
رشته
متن مورد نظر جهت قرارگرفتن بین تصویر پیوند و توضیحات آن. مقدار پیش فرض: '\n' (خط جدید).
show_images
بولی
آیا تصویر هر پیوند باید نمایش داده شود (True) یا خیر (False). مقدار پیش فرض: True.
show_description
بولی
نمایش (True) یا عدم نمایش (False) توضیحات پیوندها. وقتی show_images برابر False باشد یا عکسی تعیین نشده باشد. مقدار پیش فرض: False.
show_name
بولی
متن پیوند نمایش داده می شود (True). وقتی کار می کند که show_images هم True باشد. (این پارامتر در نسخه 2,7 افزوده شد) مقدار پیش فرض: False.
show_rating
بولی
نمایش (True) یا عدم نمایش (False) ستاره های نمره دادن. مقدار پیش فرض: False.
show_updated
بولی
نمایش (True) یا عدم نمایش (False) زمان آخرین به روز رسانی. تکته: فیلد link_updated تغییرات محلی را ردگیری نمی کند. زمانی ردگیری می کند که جایی که پیوند به آن اشاره دارد با درخواست های راه دور pingomatic به روز رسانی شود. مقدار پیش فرض: False.
hide_invisible
بولی
نمایش پیوند حتی در صورتی که یک پیوند مخفی باشد. مقدار پیش فرض: True.
echo
بولی
نمایش پیوندها (True) یا برگرداندن آن ها جهت استفاده در کد های پی اچ پی (False). مقدار پیش فرض: True.