این تابع یک آرایه از پیوندهای سایت را بر می گرداند. این تابع به کاربر اجازه فراخوانی مستقیم اطلاعات پیوند را می دهد.

<?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 را همانند متن جستجو، جستجو می کند.