Tuts+ Guide to the Eighth Batch of Template Tags

In part eight of this series, we looked at the seventh batch of WordPress template tags. In Part 9, we'll take a look at the final batch of nearly 200 template tags. Throughout this tutorial we'll see template tags for bookmarks as well as other "miscellaneous" template tags.

Warning about Bookmarks: Starting with WordPress 3.5, “Bookmarks” are hidden by default in the admin panel. To use bookmarks, you need to install the link manager plugin.

Get and display the bookmark list: wp_list_bookmarks()

This template tag returns or echoes a list of bookmarks, which is an old feature of WordPress.

parameter

This template tag accepts only one parameter:

<li> $args (optional - array) :

Array of the following parameters:

<li> 'orderby' (String): How to order bookmarks. Accepts "name", "link_id", "url", "target", "description", "owner" (user who added the bookmark), "rating", "update" (date updated), "rel" (XFN) bookmark relationship), 'notes', 'rss', 'length' (bookmark name length), 'rand' (random).

(Default: 'name')

<li> 'order' (string): Whether to sort items in ascending ('ASC') or descending ('DESC') order.

(Default: 'ASC')

<li> 'limit' (integer): Number of items to display.

(Default: -1 means all bookmarks)

<li> 'category' (String): Comma-separated category IDs from which to get items.

(Default: ' ' means all categories)

<li> 'exclude_category' (String): ID of the bookmark category to exclude.

(default:' ')

<li> 'category_name' (string): Display the bookmark's category name (overrides 'category').

(default:'')

<li> 'hide_invisible' (integer): Whether to hide invisible links or show them.

(Default: 1)

<li> 'show_updated' (integer): Whether to display the last updated timestamp.

(Default: 0)

<li> 'echo' (integer): Whether to echo the output (1) or return it (0).

(Default: 1)

<li> 'categorize' (integer): Whether to group bookmarks by category (1) or not (0).

(Default: 1)

<li> 'title_li' (string): Wrap the output with <li> tags and display the title before the bookmark list. You may want to set it to an empty string and disable newlines.

(Default: "Bookmark")

<li> 'title_before' (string): HTML code to add before each title.

(default:'

')

<li> 'title_after' (string): HTML code added after each title.

(default:'')

<li> 'class' (string): CSS class name to add to each category.

(Default: 'linkcat')

<li> 'category_before' (string): HTML code to add before each category.

(default:'

• ')
<li> 'category_after' (string): HTML code added after each category.

(default:'

')
<li> 'category_orderby' (String): How to sort categories. Accepts "name", "id", "slug" and "count".

(default: "name")

<li> 'category_order' (string): Whether to sort categories in ascending ('ASC') or descending ('DESC') order.

(Default: 'ASC')

usage

<?php

$args = array(
    
    // Random order.
    'orderby' => 'rand',
    
    // Take just 5 bookmarks.
    'limit' => 5,
    
    // Take bookmarks from a specific category.
    'category_name' => 'Friends',
    
    // Don't echo.
    'echo' => 0,
    
    // Custom class.
    'class' => 'friends-bookmark-list'
    
);

$bookmarks_list = wp_list_bookmarks( $args );

?>

Get the array of all bookmarks: get_bookmarks()

This template tag returns an array of WordPress bookmarks.

parameter

This template tag accepts only one parameter:

<li> $args (optional - array) :

Array of the following parameters:

<li> 'orderby' (String): How to order links. Accepts post fields such as Name, ID, Title, Date, etc.

(default: "name") <li> 'order' (string): Whether to sort items in ascending ('ASC') or descending ('DESC') order.

(Default: 'ASC') <li> 'limit' (integer): Number of items to display.

(Default value: -1 means all) <li> 'category' (String): Comma-separated category IDs from which to get items.

(default: empty) <li> 'category_name' (String): Category name to get the item from.

（默认：空） <li> 'hide_invisible'（整数或布尔值）：是否显示或隐藏标记为“不可见”的链接。

（默认：1|TRUE） <li> 'show_updated'（整数或布尔值）：是否显示书签上次更新时间。

（默认：0|FALSE） <li> 'include'（字符串）：要包含的以逗号分隔的 ID 列表。

（默认：空） <li> 'exclude'（字符串）：要排除的 ID 的逗号分隔列表。

（默认：空）

用法

<?php

$args = array(
    'orderby' => 'title',
    'order' => 'ASC',
    'limit' => 15,
    'hide_invisible' => false,
    'exclude' => '12,16,23'
);

$bookmarks_array =  get_bookmarks( $args );

?>

获取书签数据：get_bookmark()

此模板标记返回给定书签的所有数据。

参数

此模板标记接受三个参数：

<li> $bookmark （必需 - 混合）：

书签 ID 或对象。

（默认：NULL） > <li> $output （可选 - 字符串）：

OBJECT、ARRAY_N 或 ARRAY_A 常量。

（默认：OBJECT） <li> $filter （可选—字符串）：

是否转义输出。如果您想过滤输出，请将其设置为“display”。

（默认：“raw”）

用法

<?php

// Getting a specific bookmark's fields with escaping the output.
$bookmark_data( 19, OBJECT, 'display' );

?>

获取单个书签字段的数据：get_bookmark_field()

此模板标记可让您获取单个书签字段的数据。

参数

此模板标记接受三个参数：

<li> $field （必填—字符串）：

字段名称。

（默认：NULL） <li> $bookmark （必需 — 整数）：

书签 ID。

（默认：NULL） <li> $context （可选—字符串）：

如何过滤字段值—“raw”、“edit”、“attribute”、“js”、“db” '，或'显示'。

（默认：'显示'）

用法

<?php

// Get the bookmark with the id 16 and escape & echo its title.
echo get_bookmark_field( 'title', 16, 'display' );

?>

获取并显示“编辑书签”链接：get_edit_bookmark_link() & edit_bookmark_link()

这些模板标签可让您获取或回显“编辑此书签”链接以在模板中使用。

参数

get_edit_bookmark_link() 只接受一个参数：

<li> $bookmark_id （必需 - 整数）：

书签的 ID。

（默认：0）

而 edit_bookmark_link() 接受四个参数：

<li> $text （可选—字符串）：

显示链接的文本。

（默认：“编辑此”） <li> $before （可选—字符串）：

在输出之前显示的文本或 HTML 代码。

（默认：空） <li> $after （可选—字符串）：

输出后显示的文本或 HTML 代码。

（默认：空） <li> $bookmark_id （必需 - 整数）：

书签的 ID。

（默认：NULL） >

<?php

// Retrieve the current bookmark's "edit bookmark" link.
$edit_bookmark_link = get_edit_bookmark_link();

// Retrieve a specific bookmark's "edit bookmark" link.
$edit_bookmark_link = get_edit_bookmark_link( 98 );

// Display the current bookmark's "edit bookmark" link.
edit_bookmark_link( __( 'Edit', 'translation-domain' ), '<strong>', '</strong>' );

// Display a specific bookmark's "edit bookmark" link.
edit_bookmark_link( __( 'Edit', 'translation-domain' ), '', '', 98 );

?>

<?php

// Display the name of the site.
bloginfo();

// Get the stylesheet url.
$stylesheet = get_bloginfo( 'stylesheet_url' );

// Display the WordPress version.
bloginfo( 'version' );

?>

<?php

// Display the body class.
body_class();

// Retrieve the body class with an extra class.
$body_class = get_body_class( 'mytheme-body' );

?>

<?php

$args = array(
    'container_id' => 'primary-nav',
    'link_before' => '<i class="icon-link"></i>',
    'theme_location' => 'primary'
);

wp_nav_menu( $args );

?>

<?php

wp_title( ' - ', true );

// Reverse the separator location to use left-hand indicators.
$page_title = wp_title( ' &laquo ', false, 'right' );

?>

<?php

// Getting a specific blog's home url with https.
$home_url_of_petes_blog = get_home_url( 2, '', 'https' );

// Echoes the current home url with a little addition.
echo home_url( '?rel=navlink' );

?>

<?php

// Getting a specific blog's site url with https.
$site_url_of_janes_blog = get_site_url( 3, '', 'https' );

// Echoes the current site url.
echo site_url();

?>

<?php

get_current_blog_id();

?>

<?php

// Get the dashboard url of the current blog.
$admin_url = get_admin_url();

// Display the admin url and force a secure connection.
admin_url( '', 'https' );

?>

<?php

// Get default feed type's link.
get_feed_link();

// Display a link for the "atom" feed.
the_feed_link( __( 'Atom Feed', 'translation-domain' ), 'atom' );

?>

<?php

$url_to_fix = user_trailingslashit( get_home_url() . 'some-special-page' );

?>

<?php

// Umm...
echo calendar_week_mod( 199 );

// Right? (it echoes "3" by the way).

?>

<?php

// Return the calendar.
$my_calendar = get_calendar( true, false );

// Display the calendar. 
get_calendar();

?>