Docs for page link-template.php

/wp-includes/link-template.php

Description

WordPress Link Template Functions

Functions

adjacent_posts_rel_link (line 1210)

Display relational links for the posts adjacent to the current post.

since: 2.8.0

void adjacent_posts_rel_link ([string $title = '%title'], [bool $in_same_cat = false], [array|string $excluded_categories = ''])

string $title: Optional. Link title format.
bool $in_same_cat: Optional. Whether link should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.

adjacent_posts_rel_link_wp_head (line 1222)

Display relational links for the posts adjacent to the current post for single post pages.

This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.

since: 3.0.0

void adjacent_posts_rel_link_wp_head ()

adjacent_post_link (line 1340)

Display adjacent post link.

Can be either next post link or previous.

since: 2.5.0

void adjacent_post_link (string $format, string $link, [bool $in_same_cat = false], [array|string $excluded_categories = ''], [bool $previous = true])

string $format: Link anchor format.
string $link: Link permalink format.
bool $in_same_cat: Optional. Whether link should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.
bool $previous: Optional, default is true. Whether to display link to previous or next post.

admin_url (line 1960)

Retrieve the url to the admin area for the current site.

return: Admin url link with optional path appended.
since: 2.6.0

string admin_url ([string $path = ''], [string $scheme = 'admin'])

string $path: Optional path relative to the admin url.
string $scheme: The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

content_url (line 2011)

Retrieve the url to the content directory.

return: Content url link with optional path appended.
since: 2.6.0

string content_url ([string $path = ''])

string $path: Optional. Path relative to the content url.

edit_bookmark_link (line 1044)

Display edit bookmark (literally a URL external to blog) link anchor content.

since: 2.7.0

void edit_bookmark_link ([string $link = ''], [string $before = ''], [string $after = ''], [int $bookmark = null])

string $link: Optional. Anchor text.
string $before: Optional. Display before edit link.
string $after: Optional. Display after edit link.
int $bookmark: Optional. Bookmark ID.

edit_comment_link (line 1003)

Display or retrieve edit comment link with formatting.

return: HTML content, if $echo is set to false.
since: 1.0.0

string|null edit_comment_link ([string $link = null], [string $before = ''], [string $after = ''])

string $link: Optional. Anchor text.
string $before: Optional. Display before edit link.
string $after: Optional. Display after edit link.

edit_post_link (line 927)

Display edit post link for post.

since: 1.0.0

void edit_post_link ([string $link = null], [string $before = ''], [string $after = ''], [int $id = 0])

string $link: Optional. Anchor text.
string $before: Optional. Display before edit link.
string $after: Optional. Display after edit link.
int $id: Optional. Post ID.

edit_tag_link (line 671)

Display or retrieve edit tag link with formatting.

return: HTML content.
since: 2.7.0

string edit_tag_link ([string $link = ''], [string $before = ''], [string $after = ''], [int|object $tag = null])

string $link: Optional. Anchor text.
string $before: Optional. Display before edit link.
string $after: Optional. Display after edit link.
int|object $tag: Tag object or ID

edit_term_link (line 718)

Display or retrieve edit term link with formatting.

return: HTML content.
since: 3.1.0

string edit_term_link ([string $link = ''], [string $before = ''], [string $after = ''], [object $term = null], [ $echo = true])

string $link: Optional. Anchor text.
string $before: Optional. Display before edit link.
string $after: Optional. Display after edit link.
object $term: Term object
$echo

get_adjacent_post (line 1097)

Retrieve adjacent post.

Can either be next or previous post.

return: Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
since: 2.5.0

mixed get_adjacent_post ([bool $in_same_cat = false], [array|string $excluded_categories = ''], [bool $previous = true])

bool $in_same_cat: Optional. Whether post should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.
bool $previous: Optional. Whether to retrieve previous post.

get_adjacent_post_rel_link (line 1175)

Get adjacent post relational link.

Can either be next or previous post relational link.

since: 2.8.0

string get_adjacent_post_rel_link ([string $title = '%title'], [bool $in_same_cat = false], [array|string $excluded_categories = ''], [bool $previous = true])

string $title: Optional. Link title format.
bool $in_same_cat: Optional. Whether link should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.
bool $previous: Optional, default is true. Whether to display link to previous or next post.

get_admin_url (line 1975)

Retrieve the url to the admin area for a given site.

return: Admin url link with optional path appended.
since: 3.0.0

string get_admin_url ([int $blog_id = null], [string $path = ''], [string $scheme = 'admin'])

int $blog_id: (optional) Blog ID. Defaults to current blog.
string $path: Optional path relative to the admin url.
string $scheme: The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

get_attachment_link (line 302)

Retrieve permalink for attachment.

This can be used in the WordPress Loop or outside of it.

since: 2.0.0

string get_attachment_link ([int $id = false])

int $id: Optional. Post ID.

get_author_feed_link (line 536)

Retrieve the feed link for a given author.

Returns a link to the feed for all posts by a given author. A specific feed can be requested or left blank to get the default feed.

return: Link to the feed for the author specified by $author_id.
since: 2.5.0

string get_author_feed_link (int $author_id, [string $feed = ''])

int $author_id: ID of an author.
string $feed: Optional. Feed type.

get_boundary_post (line 1267)

Retrieve boundary post.

Boundary being either the first or last post by publish date within the constraints specified by $in_same_cat or $excluded_categories.

since: 2.8.0

object get_boundary_post ([bool $in_same_cat = false], [array|string $excluded_categories = ''], [bool $start = true])

bool $in_same_cat: Optional. Whether returned post should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.
bool $start: Optional. Whether to retrieve first or last post.

get_category_feed_link (line 574)

Retrieve the feed link for a category.

Returns a link to the feed for all posts in a given category. A specific feed can be requested or left blank to get the default feed.

return: Link to the feed for the category specified by $cat_id.
since: 2.5.0

string get_category_feed_link (int $cat_id, [string $feed = ''])

int $cat_id: ID of a category.
string $feed: Optional. Feed type.

get_comments_pagenum_link (line 1648)

Retrieve comments page number link.

since: 2.7.0

string get_comments_pagenum_link ([int $pagenum = 1], [ $max_page = 0])

int $pagenum: Optional. Page number.
$max_page

get_dashboard_url (line 2214)

Get the URL to the user's dashboard.

If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site, the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's primary blog is returned.

return: Dashboard url link with optional path appended.
since: 3.1.0

string get_dashboard_url (int $user_id, [string $path = ''], [string $scheme = 'admin'])

int $user_id: User ID
string $path: Optional path relative to the dashboard. Use only paths known to both blog and user admins.
string $scheme: The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

get_day_link (line 389)

Retrieve the permalink for the day archives with year and month.

since: 1.0.0

string get_day_link (bool|int $year, bool|int $month, bool|int $day)

bool|int $year: False for current year. Integer of year.
bool|int $month: False for current month. Integer of month.
bool|int $day: False for current day. Integer of day.

get_delete_post_link (line 954)

Retrieve delete posts link for post.

Can be used within the WordPress loop or outside of it, with any post type.

since: 2.9.0

string get_delete_post_link ([int $id = 0], [string $deprecated = ''], [bool $force_delete = false])

int $id: Optional. Post ID.
string $deprecated: Not used.
bool $force_delete: Whether to bypass trash and force deletion. Default is false.

get_edit_bookmark_link (line 1024)

Display edit bookmark (literally a URL external to blog) link.

since: 2.7.0

string get_edit_bookmark_link ([int $link = 0])

int $link: Optional. Bookmark ID.

get_edit_comment_link (line 983)

Retrieve edit comment link.

since: 2.3.0

string get_edit_comment_link ([int $comment_id = 0])

int $comment_id: Optional. Comment ID.

get_edit_post_link (line 898)

Retrieve edit posts link for post.

Can be used within the WordPress loop or outside of it. Can be used with pages, posts, attachments, and revisions.

since: 2.3.0
usedby: wp_list_post_revisions()

string get_edit_post_link ([int $id = 0], [string $context = 'display'])

int $id: Optional. Post ID.
string $context: Optional, defaults to display. How to write the '&', defaults to '&'.

get_edit_profile_url (line 2247)

Get the URL to the user's profile editor.

return: Dashboard url link with optional path appended.
since: 3.1.0

string get_edit_profile_url (int $user, [string $scheme = 'admin'])

int $user: User ID
string $scheme: The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

get_edit_tag_link (line 656)

Retrieve edit tag link.

since: 2.7.0

string get_edit_tag_link (int $tag_id, [string $taxonomy = 'post_tag'])

int $tag_id: Tag ID
string $taxonomy: Taxonomy

get_edit_term_link (line 686)

Retrieve edit term url.

since: 3.1.0

string get_edit_term_link (int $term_id, string $taxonomy, [string $object_type = ''])

int $term_id: Term ID
string $taxonomy: Taxonomy
string $object_type: The object type

get_feed_link (line 430)

Retrieve the permalink for the feed type.

since: 1.5.0

string get_feed_link ([string $feed = ''])

string $feed: Optional, defaults to default feed. Feed type.

get_home_url (line 1863)

Retrieve the home url for a given site.

Returns the 'home' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.

return: Home url link with optional path appended.
since: 3.0.0
usedby: home_url()

string get_home_url ([int $blog_id = null], [string $path = ''], [string $scheme = null])

int $blog_id: (optional) Blog ID. Defaults to current blog.
string $path: (optional) Path relative to the home url.
string $scheme: (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.

get_month_link (line 363)

Retrieve the permalink for the month archives with year.

since: 1.0.0

string get_month_link (bool|int $year, bool|int $month)

bool|int $year: False for current year. Integer of year.
bool|int $month: False for current month. Integer of month.

get_next_comments_link (line 1685)

Return the link to next comments page.

since: 2.7.1

string|null get_next_comments_link ([string $label = ''], [int $max_page = 0])

string $label: Optional. Label for link text.
int $max_page: Optional. Max page.

get_next_post (line 1081)

Retrieve next post that is adjacent to current post.

return: Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
since: 1.5.0

mixed get_next_post ([bool $in_same_cat = false], [array|string $excluded_categories = ''])

bool $in_same_cat: Optional. Whether post should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.

get_next_posts_link (line 1484)

Return the next posts page link.

since: 2.7.0
usedby: next_posts_link()

string|null get_next_posts_link ([string $label = null], [int $max_page = 0])

string $label: Content for link text.
int $max_page: Optional. Max pages.

get_next_posts_page_link (line 1446)

Retrieve next posts page link.

Backported from 2.1.3 to 2.0.10.

since: 2.0.10

string get_next_posts_page_link ([int $max_page = 0])

int $max_page: Optional. Max pages.

get_pagenum_link (line 1379)

Retrieve links for page numbers.

since: 1.5.0

string get_pagenum_link ([int $pagenum = 1], [bool $escape = true])

int $pagenum: Optional. Page ID.
bool $escape: Optional. Whether to escape the URL for display, with esc_url(). Defaults to true. Otherwise, prepares the URL with esc_url_raw().

get_page_link (line 238)

Retrieve the permalink for current page or page ID.

Respects page_on_front. Use this one.

since: 1.5.0

string get_page_link ([int $id = false], [bool $leavename = false], [bool $sample = false])

int $id: Optional. Post ID.
bool $leavename: Optional, defaults to false. Whether to keep page name.
bool $sample: Optional, defaults to false. Is it a sample permalink.

get_permalink (line 80)

Retrieve full permalink for current post or post ID.

since: 1.0.0

string get_permalink ([int $id = 0], [bool $leavename = false])

int $id: Optional. Post ID.
bool $leavename: Optional, defaults to false. Whether to keep post name or page name.

get_posts_nav_link (line 1595)

Return post pages link navigation for previous and next pages.

return: The posts link navigation.
since: 2.8

string get_posts_nav_link ([string|array $args = array()])

string|array $args: Optional args.

get_post_comments_feed_link (line 468)

Retrieve the permalink for the post comments feed.

since: 2.2.0

string get_post_comments_feed_link ([int $post_id = 0], [string $feed = ''])

int $post_id: Optional. Post ID.
string $feed: Optional. Feed type.

get_post_permalink (line 176)

Retrieve the permalink for a post with a custom post type.

since: 3.0.0

string get_post_permalink ([int $id = 0], [bool $leavename = false], [bool $sample = false])

int $id: Optional. Post ID.
bool $leavename: Optional, defaults to false. Whether to keep post name.
bool $sample: Optional, defaults to false. Is it a sample permalink.

get_post_type_archive_feed_link (line 866)

Retrieve the permalink for a post type archive feed.

since: 3.1.0

string get_post_type_archive_feed_link (string $post_type, [string $feed = ''])

string $post_type: Post type
string $feed: Optional. Feed type

get_post_type_archive_link (line 835)

Retrieve the permalink for a post type archive.

since: 3.1.0

string get_post_type_archive_link (string $post_type)

string $post_type: Post type

get_previous_comments_link (line 1730)

Return the previous comments page link.

since: 2.7.1

string|null get_previous_comments_link ([string $label = ''])

string $label: Optional. Label for comments link text.

get_previous_post (line 1068)

Retrieve previous post that is adjacent to current post.

return: Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
since: 1.5.0

mixed get_previous_post ([bool $in_same_cat = false], [array|string $excluded_categories = ''])

bool $in_same_cat: Optional. Whether post should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.

get_previous_posts_link (line 1563)

Return the previous posts page link.

since: 2.7.0
usedby: previous_posts_link()

string|null get_previous_posts_link ([string $label = null])

string $label: Optional. Previous page link text.

get_previous_posts_page_link (line 1528)

Retrieve previous posts page link.

Will only return string, if not on a single page or post.

Backported to 2.0.10 from 2.1.3.

since: 2.0.10

string|null get_previous_posts_page_link ()

get_search_comments_feed_link (line 807)

Retrieve the permalink for the comments feed of the search results.

since: 2.5.0

string get_search_comments_feed_link ([string $search_query = ''], [string $feed = ''])

string $search_query: Optional. Search query.
string $feed: Optional. Feed type.

get_search_feed_link (line 777)

Retrieve the permalink for the feed of the search results.

since: 2.5.0

string get_search_feed_link ([string $search_query = ''], [string $feed = ''])

string $search_query: Optional. Search query.
string $feed: Optional. Feed type.

get_search_link (line 746)

Retrieve permalink for search.

since: 3.0.0

string get_search_link ([string $query = ''])

string $query: Optional. The query string to use. If empty the current query is used.

get_shortcut_link (line 1806)

Retrieve the Press This bookmarklet link.

Use this in 'a' element 'href' attribute.

since: 2.6.0

string get_shortcut_link ()

get_site_url (line 1920)

Retrieve the site url for a given site.

Returns the 'site_url' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.

return: Site url link with optional path appended.
since: 3.0.0
usedby: site_url()

string get_site_url ([int $blog_id = null], [string $path = ''], [string $scheme = null])

int $blog_id: (optional) Blog ID. Defaults to current blog.
string $path: Optional. Path relative to the site url.
string $scheme: Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.

get_tag_feed_link (line 643)

Retrieve permalink for feed of tag.

since: 2.3.0

string get_tag_feed_link (int $tag_id, [string $feed = ''])

int $tag_id: Tag ID.
string $feed: Optional. Feed type.

get_term_feed_link (line 591)

Retrieve the feed link for a term.

Returns a link to the feed for all posts in a given term. A specific feed can be requested or left blank to get the default feed.

return: Link to the feed for the term specified by $term_id and $taxonomy.
since: 3.0

string get_term_feed_link (int $term_id, [string $taxonomy = 'category'], [string $feed = ''])

int $term_id: ID of a category.
string $taxonomy: Optional. Taxonomy of $term_id
string $feed: Optional. Feed type.

get_year_link (line 341)

Retrieve the permalink for the year archives.

since: 1.5.0

string get_year_link (int|bool $year)

int|bool $year: False for current year or year for permalink.

home_url (line 1844)

Retrieve the home url for the current site.

Returns the 'home' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.

return: Home url link with optional path appended.
since: 3.0.0
uses: get_home_url()

string home_url ([string $path = ''], [string $scheme = null])

string $path: (optional) Path relative to the home url.
string $scheme: (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.

includes_url (line 1993)

Retrieve the url to the includes directory.

return: Includes url link with optional path appended.
since: 2.6.0

string includes_url ([string $path = ''])

string $path: Optional. Path relative to the includes url.

network_admin_url (line 2150)

Retrieve the url to the admin area for the network.

return: Admin url link with optional path appended.
since: 3.0.0

string network_admin_url ([string $path = ''], [string $scheme = 'admin'])

string $path: Optional path relative to the admin url.
string $scheme: The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

network_home_url (line 2118)

Retrieve the home url for the current network.

Returns the home url with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.

return: Home url link with optional path appended.
since: 3.0.0

string network_home_url ([string $path = ''], [string $scheme = null])

string $path: (optional) Path relative to the home url.
string $scheme: (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.

network_site_url (line 2075)

Retrieve the site url for the current network.

Returns the site url with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.

return: Site url link with optional path appended.
since: 3.0.0

string network_site_url ([string $path = ''], [string $scheme = null])

string $path: Optional. Path relative to the site url.
string $scheme: Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.

next_comments_link (line 1718)

Display the link to next comments page.

since: 2.7.0

void next_comments_link ([string $label = ''], [int $max_page = 0])

string $label: Optional. Label for link text.
int $max_page: Optional. Max page.

next_posts (line 1466)

Display or return the next posts page link.

since: 0.71

void next_posts ([int $max_page = 0], [boolean $echo = true])

int $max_page: Optional. Max pages.
boolean $echo: Optional. Echo or return;

next_posts_link (line 1513)

Display the next posts page link.

since: 0.71
uses: get_next_posts_link()

void next_posts_link ([string $label = null], [int $max_page = 0])

string $label: Content for link text.
int $max_page: Optional. Max pages.

next_post_link (line 1323)

Display next post link that is adjacent to the current post.

since: 1.5.0

void next_post_link ([string $format = '%link &raquo;'], [string $link = '%title'], [bool $in_same_cat = false], [array|string $excluded_categories = ''])

string $format: Optional. Link anchor format.
string $link: Optional. Link permalink format.
bool $in_same_cat: Optional. Whether link should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.

next_post_rel_link (line 1237)

Display relational link for the next post adjacent to the current post.

since: 2.8.0

void next_post_rel_link ([string $title = '%title'], [bool $in_same_cat = false], [array|string $excluded_categories = ''])

string $title: Optional. Link title format.
bool $in_same_cat: Optional. Whether link should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.

paginate_comments_links (line 1767)

Create pagination links for the comments on the current post.

return: Markup for pagination links.
see: paginate_links()
since: 2.7.0

string paginate_comments_links ([string|array $args = array()])

string|array $args: Optional args. See paginate_links().

permalink_anchor (line 57)

Display permalink anchor for current post.

The permalink mode title will use the post title for the 'a' element 'id' attribute. The id mode uses 'post-' with the post ID for the 'id' attribute.

since: 0.71

void permalink_anchor ([string $mode = 'id'])

string $mode: Permalink mode can be either 'title', 'id', or default, which is 'id'.

plugins_url (line 2033)

Retrieve the url to the plugins directory or to a specific file within that directory.

You can hardcode the plugin slug in $path or pass __FILE__ as a second argument to get the correct folder name.

return: Plugins url link with optional path appended.
since: 2.6.0

string plugins_url ([string $path = ''], [string $plugin = ''])

string $path: Optional. Path relative to the plugins url.
string $plugin: Optional. The plugin file that you want to be relative to - i.e. pass in __FILE__

posts_nav_link (line 1635)

Display post pages link navigation for previous and next pages.

since: 0.71

void posts_nav_link ([string $sep = ''], [string $prelabel = ''], [string $nxtlabel = ''])

string $sep: Optional. Separator for posts navigation links.
string $prelabel: Optional. Label for previous pages.
string $nxtlabel: Optional Label for next pages.

post_comments_feed_link (line 514)

Display the comment feed link for a post.

Prints out the comment feed link for a post. Link text is placed in the anchor. If no link text is specified, default text is used. If no post ID is specified, the current post is used.

return: Link to the comment feed for the current post.
since: 2.5.0

string post_comments_feed_link ([string $link_text = ''], [int $post_id = ''], [string $feed = ''])

string $link_text: Descriptive text.
int $post_id: Optional post ID. Default to current post.
string $feed: Optional. Feed format.

post_permalink (line 219)

Retrieve permalink from post ID.

since: 1.0.0

string post_permalink ([int $post_id = 0], [mixed $deprecated = ''])

int $post_id: Optional. Post ID.
mixed $deprecated: Not used.

previous_comments_link (line 1754)

Display the previous comments page link.

since: 2.7.0

void previous_comments_link ([string $label = ''])

string $label: Optional. Label for comments link text.

previous_posts (line 1546)

Display or return the previous posts page link.

since: 0.71

void previous_posts ([boolean $echo = true])

boolean $echo: Optional. Echo or return;

previous_posts_link (line 1583)

Display the previous posts page link.

since: 0.71
uses: get_previous_posts_link()

void previous_posts_link ([string $label = null])

string $label: Optional. Previous page link text.

previous_post_link (line 1309)

Display previous post link that is adjacent to the current post.

since: 1.5.0

void previous_post_link ([string $format = '&laquo; %link'], [string $link = '%title'], [bool $in_same_cat = false], [array|string $excluded_categories = ''])

string $format: Optional. Link anchor format.
string $link: Optional. Link permalink format.
bool $in_same_cat: Optional. Whether link should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.

prev_post_rel_link (line 1250)

Display relational link for the previous post adjacent to the current post.

since: 2.8.0

void prev_post_rel_link ([string $title = '%title'], [bool $in_same_cat = false], [array|string $excluded_categories = ''])

string $title: Optional. Link title format.
bool $in_same_cat: Optional. Whether link should be in a same category.
array|string $excluded_categories: Optional. Array or comma-separated list of excluded category IDs.

rel_canonical (line 2266)

Output rel=canonical for singular queries.

since: 2.9.0

void rel_canonical ()

self_admin_url (line 2191)

Retrieve the url to the admin area for either the current blog or the network depending on context.

return: Admin url link with optional path appended.
since: 3.1.0

string self_admin_url ([string $path = ''], [string $scheme = 'admin'])

string $path: Optional path relative to the admin url.
string $scheme: The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

site_url (line 1901)

Retrieve the site url for the current site.

Returns the 'site_url' option with the appropriate protocol, 'https' if is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is overridden.

return: Site url link with optional path appended.
since: 2.6.0
usedby: wp_lostpassword_url() - To generate the lost password URL
usedby: wp_login_url() - To generate the log in URL
usedby: wp_logout_url() - To generate the log in URL
uses: get_site_url()

string site_url ([string $path = ''], [string $scheme = null])

string $path: Optional. Path relative to the site url.
string $scheme: Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.

the_feed_link (line 417)

Display the permalink for the feed type.

since: 3.0.0

void the_feed_link (string $anchor, [string $feed = ''])

string $anchor: The link's anchor text.
string $feed: Optional, defaults to default feed. Feed type.

the_permalink (line 15)

Display the permalink for the current post.

since: 1.2.0
uses: apply_filters() - Calls 'the_permalink' filter on the permalink string.

void the_permalink ()

the_shortlink (line 2373)

Display the Short Link for a Post

Must be called from inside "The Loop"

Call like the_shortlink(__('Shortlinkage FTW'))

since: 3.0.0

void the_shortlink ([string $text = ''], [string $title = ''], [string $before = ''], [string $after = ''])

string $text: Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
string $title: Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
string $before: Optional HTML to display before the link.
string $after: Optional HTML to display after the link.

user_admin_url (line 2172)

Retrieve the url to the admin area for the current user.

return: Admin url link with optional path appended.
since: 3.0.0

string user_admin_url ([string $path = ''], [string $scheme = 'admin'])

string $path: Optional path relative to the admin url.
string $scheme: The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.

user_trailingslashit (line 34)

Retrieve trailing slash string, if blog set for adding trailing slashes.

Conditionally adds a trailing slash if the permalink structure has a trailing slash, strips the trailing slash if not. The string is passed through the 'user_trailingslashit' filter. Will remove trailing slash from string, if blog is not set to have them.

since: 2.2.0
uses: $wp_rewrite

string user_trailingslashit (string $string, [string $type_of_url = ''])

string $string: URL with or without a trailing slash.
string $type_of_url: The type of URL being considered (e.g. single, category, etc) for use in the filter.

wp_get_shortlink (line 2293)

Return a shortlink for a post, page, attachment, or blog.

This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts. Plugins can short-circuit this function via the pre_get_shortlink filter or filter the output via the get_shortlink filter.

return: A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
since: 3.0.0.
usedby: wp_shortlink_header()
usedby: wp_shortlink_wp_head()

string wp_get_shortlink ([int $id = 0], [string $context = 'post'], [bool $allow_slugs = true])

int $id: A post or blog id. Default is 0, which means the current post or blog.
string $context: Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'.
bool $allow_slugs: Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.

wp_shortlink_header (line 2347)

Send a Link: rel=shortlink header if a shortlink is defined for the current page.

Attached to the wp action.

since: 3.0.0
uses: wp_get_shortlink()

void wp_shortlink_header ()

wp_shortlink_wp_head (line 2329)

Inject rel=shortlink into head if a shortlink is defined for the current page.

Attached to the wp_head action.

since: 3.0.0
uses: wp_get_shortlink()

void wp_shortlink_wp_head ()

Documentation generated on Tue, 15 May 2012 23:18:08 +0000 by phpDocumentor 1.4.1