wp-includes/link-template.php

   1 <?php
   2 /**
   3  * WordPress Link Template Functions
   4  *
   5  * @package WordPress
   6  * @subpackage Template
   7  */
   8
   9 /**
  10  * Display the permalink for the current post.
  11  *
  12  * @since 1.2.0
  13  * @uses apply_filters() Calls 'the_permalink' filter on the permalink string.
  14  */
  15 function the_permalink() {
  16         echo apply_filters('the_permalink', get_permalink());
  17 }
  18
  19 /**
  20  * Retrieve trailing slash string, if blog set for adding trailing slashes.
  21  *
  22  * Conditionally adds a trailing slash if the permalink structure has a trailing
  23  * slash, strips the trailing slash if not. The string is passed through the
  24  * 'user_trailingslashit' filter. Will remove trailing slash from string, if
  25  * blog is not set to have them.
  26  *
  27  * @since 2.2.0
  28  * @uses $wp_rewrite
  29  *
  30  * @param string $string URL with or without a trailing slash.
  31  * @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter.
  32  * @return string
  33  */
  34 function user_trailingslashit($string, $type_of_url = '') {
  35         global $wp_rewrite;
  36         if ( $wp_rewrite->use_trailing_slashes )
  37                 $string = trailingslashit($string);
  38         else
  39                 $string = untrailingslashit($string);
  40
  41         // Note that $type_of_url can be one of following:
  42         // single, single_trackback, single_feed, single_paged, feed, category, page, year, month, day, paged, post_type_archive
  43         $string = apply_filters('user_trailingslashit', $string, $type_of_url);
  44         return $string;
  45 }
  46
  47 /**
  48  * Display permalink anchor for current post.
  49  *
  50  * The permalink mode title will use the post title for the 'a' element 'id'
  51  * attribute. The id mode uses 'post-' with the post ID for the 'id' attribute.
  52  *
  53  * @since 0.71
  54  *
  55  * @param string $mode Permalink mode can be either 'title', 'id', or default, which is 'id'.
  56  */
  57 function permalink_anchor($mode = 'id') {
  58         global $post;
  59         switch ( strtolower($mode) ) {
  60                 case 'title':
  61                         $title = sanitize_title($post->post_title) . '-' . $post->ID;
  62                         echo '<a id="'.$title.'"></a>';
  63                         break;
  64                 case 'id':
  65                 default:
  66                         echo '<a id="post-' . $post->ID . '"></a>';
  67                         break;
  68         }
  69 }
  70
  71 /**
  72  * Retrieve full permalink for current post or post ID.
  73  *
  74  * @since 1.0.0
  75  *
  76  * @param int $id Optional. Post ID.
  77  * @param bool $leavename Optional, defaults to false. Whether to keep post name or page name.
  78  * @return string
  79  */
  80 function get_permalink($id = 0, $leavename = false) {
  81         $rewritecode = array(
  82                 '%year%',
  83                 '%monthnum%',
  84                 '%day%',
  85                 '%hour%',
  86                 '%minute%',
  87                 '%second%',
  88                 $leavename? '' : '%postname%',
  89                 '%post_id%',
  90                 '%category%',
  91                 '%author%',
  92                 $leavename? '' : '%pagename%',
  93         );
  94
  95         if ( is_object($id) && isset($id->filter) && 'sample' == $id->filter ) {
  96                 $post = $id;
  97                 $sample = true;
  98         } else {
  99                 $post = &get_post($id);
 100                 $sample = false;
 101         }
 102
 103         if ( empty($post->ID) )
 104                 return false;
 105
 106         if ( $post->post_type == 'page' )
 107                 return get_page_link($post->ID, $leavename, $sample);
 108         elseif ( $post->post_type == 'attachment' )
 109                 return get_attachment_link($post->ID);
 110         elseif ( in_array($post->post_type, get_post_types( array('_builtin' => false) ) ) )
 111                 return get_post_permalink($post->ID, $leavename, $sample);
 112
 113         $permalink = get_option('permalink_structure');
 114
 115         $permalink = apply_filters('pre_post_link', $permalink, $post, $leavename);
 116
 117         if ( '' != $permalink && !in_array($post->post_status, array('draft', 'pending', 'auto-draft')) ) {
 118                 $unixtime = strtotime($post->post_date);
 119
 120                 $category = '';
 121                 if ( strpos($permalink, '%category%') !== false ) {
 122                         $cats = get_the_category($post->ID);
 123                         if ( $cats ) {
 124                                 usort($cats, '_usort_terms_by_ID'); // order by ID
 125                                 $category = $cats[0]->slug;
 126                                 if ( $parent = $cats[0]->parent )
 127                                         $category = get_category_parents($parent, false, '/', true) . $category;
 128                         }
 129                         // show default category in permalinks, without
 130                         // having to assign it explicitly
 131                         if ( empty($category) ) {
 132                                 $default_category = get_category( get_option( 'default_category' ) );
 133                                 $category = is_wp_error( $default_category ) ? '' : $default_category->slug;
 134                         }
 135                 }
 136
 137                 $author = '';
 138                 if ( strpos($permalink, '%author%') !== false ) {
 139                         $authordata = get_userdata($post->post_author);
 140                         $author = $authordata->user_nicename;
 141                 }
 142
 143                 $date = explode(" ",date('Y m d H i s', $unixtime));
 144                 $rewritereplace =
 145                 array(
 146                         $date[0],
 147                         $date[1],
 148                         $date[2],
 149                         $date[3],
 150                         $date[4],
 151                         $date[5],
 152                         $post->post_name,
 153                         $post->ID,
 154                         $category,
 155                         $author,
 156                         $post->post_name,
 157                 );
 158                 $permalink = home_url( str_replace($rewritecode, $rewritereplace, $permalink) );
 159                 $permalink = user_trailingslashit($permalink, 'single');
 160         } else { // if they're not using the fancy permalink option
 161                 $permalink = home_url('?p=' . $post->ID);
 162         }
 163         return apply_filters('post_link', $permalink, $post, $leavename);
 164 }
 165
 166 /**
 167  * Retrieve the permalink for a post with a custom post type.
 168  *
 169  * @since 3.0.0
 170  *
 171  * @param int $id Optional. Post ID.
 172  * @param bool $leavename Optional, defaults to false. Whether to keep post name.
 173  * @param bool $sample Optional, defaults to false. Is it a sample permalink.
 174  * @return string
 175  */
 176 function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
 177         global $wp_rewrite;
 178
 179         $post = &get_post($id);
 180
 181         if ( is_wp_error( $post ) )
 182                 return $post;
 183
 184         $post_link = $wp_rewrite->get_extra_permastruct($post->post_type);
 185
 186         $slug = $post->post_name;
 187
 188         $draft_or_pending = isset($post->post_status) && in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
 189
 190         $post_type = get_post_type_object($post->post_type);
 191
 192         if ( !empty($post_link) && ( !$draft_or_pending || $sample ) ) {
 193                 if ( ! $leavename ) {
 194                         if ( $post_type->hierarchical )
 195                                 $slug = get_page_uri($id);
 196                         $post_link = str_replace("%$post->post_type%", $slug, $post_link);
 197                 }
 198                 $post_link = home_url( user_trailingslashit($post_link) );
 199         } else {
 200                 if ( $post_type->query_var && ( isset($post->post_status) && !$draft_or_pending ) )
 201                         $post_link = add_query_arg($post_type->query_var, $slug, '');
 202                 else
 203                         $post_link = add_query_arg(array('post_type' => $post->post_type, 'p' => $post->ID), '');
 204                 $post_link = home_url($post_link);
 205         }
 206
 207         return apply_filters('post_type_link', $post_link, $post, $leavename, $sample);
 208 }
 209
 210 /**
 211  * Retrieve permalink from post ID.
 212  *
 213  * @since 1.0.0
 214  *
 215  * @param int $post_id Optional. Post ID.
 216  * @param mixed $deprecated Not used.
 217  * @return string
 218  */
 219 function post_permalink( $post_id = 0, $deprecated = '' ) {
 220         if ( !empty( $deprecated ) )
 221                 _deprecated_argument( __FUNCTION__, '1.3' );
 222
 223         return get_permalink($post_id);
 224 }
 225
 226 /**
 227  * Retrieve the permalink for current page or page ID.
 228  *
 229  * Respects page_on_front. Use this one.
 230  *
 231  * @since 1.5.0
 232  *
 233  * @param int $id Optional. Post ID.
 234  * @param bool $leavename Optional, defaults to false. Whether to keep page name.
 235  * @param bool $sample Optional, defaults to false. Is it a sample permalink.
 236  * @return string
 237  */
 238 function get_page_link( $id = false, $leavename = false, $sample = false ) {
 239         global $post;
 240
 241         $id = (int) $id;
 242         if ( !$id )
 243                 $id = (int) $post->ID;
 244
 245         if ( 'page' == get_option('show_on_front') && $id == get_option('page_on_front') )
 246                 $link = home_url('/');
 247         else
 248                 $link = _get_page_link( $id , $leavename, $sample );
 249
 250         return apply_filters('page_link', $link, $id, $sample);
 251 }
 252
 253 /**
 254  * Retrieve the page permalink.
 255  *
 256  * Ignores page_on_front. Internal use only.
 257  *
 258  * @since 2.1.0
 259  * @access private
 260  *
 261  * @param int $id Optional. Post ID.
 262  * @param bool $leavename Optional. Leave name.
 263  * @param bool $sample Optional. Sample permalink.
 264  * @return string
 265  */
 266 function _get_page_link( $id = false, $leavename = false, $sample = false ) {
 267         global $post, $wp_rewrite;
 268
 269         if ( !$id )
 270                 $id = (int) $post->ID;
 271         else
 272                 $post = &get_post($id);
 273
 274         $draft_or_pending = in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
 275
 276         $link = $wp_rewrite->get_page_permastruct();
 277
 278         if ( !empty($link) && ( ( isset($post->post_status) && !$draft_or_pending ) || $sample ) ) {
 279                 if ( ! $leavename ) {
 280                         $link = str_replace('%pagename%', get_page_uri($id), $link);
 281                 }
 282
 283                 $link = home_url($link);
 284                 $link = user_trailingslashit($link, 'page');
 285         } else {
 286                 $link = home_url("?page_id=$id");
 287         }
 288
 289         return apply_filters( '_get_page_link', $link, $id );
 290 }
 291
 292 /**
 293  * Retrieve permalink for attachment.
 294  *
 295  * This can be used in the WordPress Loop or outside of it.
 296  *
 297  * @since 2.0.0
 298  *
 299  * @param int $id Optional. Post ID.
 300  * @return string
 301  */
 302 function get_attachment_link($id = false) {
 303         global $post, $wp_rewrite;
 304
 305         $link = false;
 306
 307         if ( ! $id)
 308                 $id = (int) $post->ID;
 309
 310         $object = get_post($id);
 311         if ( $wp_rewrite->using_permalinks() && ($object->post_parent > 0) && ($object->post_parent != $id) ) {
 312                 $parent = get_post($object->post_parent);
 313                 if ( 'page' == $parent->post_type )
 314                         $parentlink = _get_page_link( $object->post_parent ); // Ignores page_on_front
 315                 else
 316                         $parentlink = get_permalink( $object->post_parent );
 317
 318                 if ( is_numeric($object->post_name) || false !== strpos(get_option('permalink_structure'), '%category%') )
 319                         $name = 'attachment/' . $object->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker
 320                 else
 321                         $name = $object->post_name;
 322
 323                 if ( strpos($parentlink, '?') === false )
 324                         $link = user_trailingslashit( trailingslashit($parentlink) . $name );
 325         }
 326
 327         if ( ! $link )
 328                 $link = home_url( "/?attachment_id=$id" );
 329
 330         return apply_filters('attachment_link', $link, $id);
 331 }
 332
 333 /**
 334  * Retrieve the permalink for the year archives.
 335  *
 336  * @since 1.5.0
 337  *
 338  * @param int|bool $year False for current year or year for permalink.
 339  * @return string
 340  */
 341 function get_year_link($year) {
 342         global $wp_rewrite;
 343         if ( !$year )
 344                 $year = gmdate('Y', current_time('timestamp'));
 345         $yearlink = $wp_rewrite->get_year_permastruct();
 346         if ( !empty($yearlink) ) {
 347                 $yearlink = str_replace('%year%', $year, $yearlink);
 348                 return apply_filters('year_link', home_url( user_trailingslashit($yearlink, 'year') ), $year);
 349         } else {
 350                 return apply_filters('year_link', home_url('?m=' . $year), $year);
 351         }
 352 }
 353
 354 /**
 355  * Retrieve the permalink for the month archives with year.
 356  *
 357  * @since 1.0.0
 358  *
 359  * @param bool|int $year False for current year. Integer of year.
 360  * @param bool|int $month False for current month. Integer of month.
 361  * @return string
 362  */
 363 function get_month_link($year, $month) {
 364         global $wp_rewrite;
 365         if ( !$year )
 366                 $year = gmdate('Y', current_time('timestamp'));
 367         if ( !$month )
 368                 $month = gmdate('m', current_time('timestamp'));
 369         $monthlink = $wp_rewrite->get_month_permastruct();
 370         if ( !empty($monthlink) ) {
 371                 $monthlink = str_replace('%year%', $year, $monthlink);
 372                 $monthlink = str_replace('%monthnum%', zeroise(intval($month), 2), $monthlink);
 373                 return apply_filters('month_link', home_url( user_trailingslashit($monthlink, 'month') ), $year, $month);
 374         } else {
 375                 return apply_filters('month_link', home_url( '?m=' . $year . zeroise($month, 2) ), $year, $month);
 376         }
 377 }
 378
 379 /**
 380  * Retrieve the permalink for the day archives with year and month.
 381  *
 382  * @since 1.0.0
 383  *
 384  * @param bool|int $year False for current year. Integer of year.
 385  * @param bool|int $month False for current month. Integer of month.
 386  * @param bool|int $day False for current day. Integer of day.
 387  * @return string
 388  */
 389 function get_day_link($year, $month, $day) {
 390         global $wp_rewrite;
 391         if ( !$year )
 392                 $year = gmdate('Y', current_time('timestamp'));
 393         if ( !$month )
 394                 $month = gmdate('m', current_time('timestamp'));
 395         if ( !$day )
 396                 $day = gmdate('j', current_time('timestamp'));
 397
 398         $daylink = $wp_rewrite->get_day_permastruct();
 399         if ( !empty($daylink) ) {
 400                 $daylink = str_replace('%year%', $year, $daylink);
 401                 $daylink = str_replace('%monthnum%', zeroise(intval($month), 2), $daylink);
 402                 $daylink = str_replace('%day%', zeroise(intval($day), 2), $daylink);
 403                 return apply_filters('day_link', home_url( user_trailingslashit($daylink, 'day') ), $year, $month, $day);
 404         } else {
 405                 return apply_filters('day_link', home_url( '?m=' . $year . zeroise($month, 2) . zeroise($day, 2) ), $year, $month, $day);
 406         }
 407 }
 408
 409 /**
 410  * Display the permalink for the feed type.
 411  *
 412  * @since 3.0.0
 413  *
 414  * @param string $anchor The link's anchor text.
 415  * @param string $feed Optional, defaults to default feed. Feed type.
 416  */
 417 function the_feed_link( $anchor, $feed = '' ) {
 418         $link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
 419         echo apply_filters( 'the_feed_link', $link, $feed );
 420 }
 421
 422 /**
 423  * Retrieve the permalink for the feed type.
 424  *
 425  * @since 1.5.0
 426  *
 427  * @param string $feed Optional, defaults to default feed. Feed type.
 428  * @return string
 429  */
 430 function get_feed_link($feed = '') {
 431         global $wp_rewrite;
 432
 433         $permalink = $wp_rewrite->get_feed_permastruct();
 434         if ( '' != $permalink ) {
 435                 if ( false !== strpos($feed, 'comments_') ) {
 436                         $feed = str_replace('comments_', '', $feed);
 437                         $permalink = $wp_rewrite->get_comment_feed_permastruct();
 438                 }
 439
 440                 if ( get_default_feed() == $feed )
 441                         $feed = '';
 442
 443                 $permalink = str_replace('%feed%', $feed, $permalink);
 444                 $permalink = preg_replace('#/+#', '/', "/$permalink");
 445                 $output =  home_url( user_trailingslashit($permalink, 'feed') );
 446         } else {
 447                 if ( empty($feed) )
 448                         $feed = get_default_feed();
 449
 450                 if ( false !== strpos($feed, 'comments_') )
 451                         $feed = str_replace('comments_', 'comments-', $feed);
 452
 453                 $output = home_url("?feed={$feed}");
 454         }
 455
 456         return apply_filters('feed_link', $output, $feed);
 457 }
 458
 459 /**
 460  * Retrieve the permalink for the post comments feed.
 461  *
 462  * @since 2.2.0
 463  *
 464  * @param int $post_id Optional. Post ID.
 465  * @param string $feed Optional. Feed type.
 466  * @return string
 467  */
 468 function get_post_comments_feed_link($post_id = 0, $feed = '') {
 469         $post_id = absint( $post_id );
 470
 471         if ( ! $post_id )
 472                 $post_id = get_the_ID();
 473
 474         if ( empty( $feed ) )
 475                 $feed = get_default_feed();
 476
 477         if ( '' != get_option('permalink_structure') ) {
 478                 if ( 'page' == get_option('show_on_front') && $post_id == get_option('page_on_front') )
 479                         $url = _get_page_link( $post_id );
 480                 else
 481                         $url = get_permalink($post_id);
 482
 483                 $url = trailingslashit($url) . 'feed';
 484                 if ( $feed != get_default_feed() )
 485                         $url .= "/$feed";
 486                 $url = user_trailingslashit($url, 'single_feed');
 487         } else {
 488                 $type = get_post_field('post_type', $post_id);
 489                 if ( 'page' == $type )
 490                         $url = home_url("?feed=$feed&amp;page_id=$post_id");
 491                 else
 492                         $url = home_url("?feed=$feed&amp;p=$post_id");
 493         }
 494
 495         return apply_filters('post_comments_feed_link', $url);
 496 }
 497
 498 /**
 499  * Display the comment feed link for a post.
 500  *
 501  * Prints out the comment feed link for a post. Link text is placed in the
 502  * anchor. If no link text is specified, default text is used. If no post ID is
 503  * specified, the current post is used.
 504  *
 505  * @package WordPress
 506  * @subpackage Feed
 507  * @since 2.5.0
 508  *
 509  * @param string $link_text Descriptive text.
 510  * @param int $post_id Optional post ID.  Default to current post.
 511  * @param string $feed Optional. Feed format.
 512  * @return string Link to the comment feed for the current post.
 513 */
 514 function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
 515         $url = get_post_comments_feed_link($post_id, $feed);
 516         if ( empty($link_text) )
 517                 $link_text = __('Comments Feed');
 518
 519         echo apply_filters( 'post_comments_feed_link_html', "<a href='$url'>$link_text</a>", $post_id, $feed );
 520 }
 521
 522 /**
 523  * Retrieve the feed link for a given author.
 524  *
 525  * Returns a link to the feed for all posts by a given author. A specific feed
 526  * can be requested or left blank to get the default feed.
 527  *
 528  * @package WordPress
 529  * @subpackage Feed
 530  * @since 2.5.0
 531  *
 532  * @param int $author_id ID of an author.
 533  * @param string $feed Optional. Feed type.
 534  * @return string Link to the feed for the author specified by $author_id.
 535 */
 536 function get_author_feed_link( $author_id, $feed = '' ) {
 537         $author_id = (int) $author_id;
 538         $permalink_structure = get_option('permalink_structure');
 539
 540         if ( empty($feed) )
 541                 $feed = get_default_feed();
 542
 543         if ( '' == $permalink_structure ) {
 544                 $link = home_url("?feed=$feed&amp;author=" . $author_id);
 545         } else {
 546                 $link = get_author_posts_url($author_id);
 547                 if ( $feed == get_default_feed() )
 548                         $feed_link = 'feed';
 549                 else
 550                         $feed_link = "feed/$feed";
 551
 552                 $link = trailingslashit($link) . user_trailingslashit($feed_link, 'feed');
 553         }
 554
 555         $link = apply_filters('author_feed_link', $link, $feed);
 556
 557         return $link;
 558 }
 559
 560 /**
 561  * Retrieve the feed link for a category.
 562  *
 563  * Returns a link to the feed for all post in a given category. A specific feed
 564  * can be requested or left blank to get the default feed.
 565  *
 566  * @package WordPress
 567  * @subpackage Feed
 568  * @since 2.5.0
 569  *
 570  * @param int $cat_id ID of a category.
 571  * @param string $feed Optional. Feed type.
 572  * @return string Link to the feed for the category specified by $cat_id.
 573 */
 574 function get_category_feed_link($cat_id, $feed = '') {
 575         return get_term_feed_link($cat_id, 'category', $feed);
 576 }
 577
 578 /**
 579  * Retrieve the feed link for a taxonomy.
 580  *
 581  * Returns a link to the feed for all post in a given term. A specific feed
 582  * can be requested or left blank to get the default feed.
 583  *
 584  * @since 3.0
 585  *
 586  * @param int $term_id ID of a category.
 587  * @param string $taxonomy Optional. Taxonomy of $term_id
 588  * @param string $feed Optional. Feed type.
 589  * @return string Link to the feed for the taxonomy specified by $term_id and $taxonomy.
 590 */
 591 function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
 592         global $wp_rewrite;
 593
 594         $term_id = ( int ) $term_id;
 595
 596         $term = get_term( $term_id, $taxonomy  );
 597
 598         if ( empty( $term ) || is_wp_error( $term ) )
 599                 return false;
 600
 601         if ( empty( $feed ) )
 602                 $feed = get_default_feed();
 603
 604         $permalink_structure = get_option( 'permalink_structure' );
 605
 606         if ( '' == $permalink_structure ) {
 607                 if ( 'category' == $taxonomy ) {
 608                         $link = home_url("?feed=$feed&amp;cat=$term_id");
 609                 }
 610                 elseif ( 'post_tag' == $taxonomy ) {
 611                         $link = home_url("?feed=$feed&amp;tag=$term->slug");
 612                 } else {
 613                         $t = get_taxonomy( $taxonomy );
 614                         $link = home_url("?feed=$feed&amp;$t->query_var=$term->slug");
 615                 }
 616         } else {
 617                 $link = get_term_link( $term_id, $term->taxonomy );
 618                 if ( $feed == get_default_feed() )
 619                         $feed_link = 'feed';
 620                 else
 621                         $feed_link = "feed/$feed";
 622
 623                 $link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' );
 624         }
 625
 626         if ( 'category' == $taxonomy )
 627                 $link = apply_filters( 'category_feed_link', $link, $feed );
 628         elseif ( 'post_tag' == $taxonomy )
 629                 $link = apply_filters( 'category_feed_link', $link, $feed );
 630         else
 631                 $link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy );
 632
 633
 634         return $link;
 635 }
 636
 637 /**
 638  * Retrieve permalink for feed of tag.
 639  *
 640  * @since 2.3.0
 641  *
 642  * @param int $tag_id Tag ID.
 643  * @param string $feed Optional. Feed type.
 644  * @return string
 645  */
 646 function get_tag_feed_link($tag_id, $feed = '') {
 647         return get_term_feed_link($tag_id, 'post_tag', $feed);
 648 }
 649
 650 /**
 651  * Retrieve edit tag link.
 652  *
 653  * @since 2.7.0
 654  *
 655  * @param int $tag_id Tag ID
 656  * @param string $taxonomy Taxonomy
 657  * @return string
 658  */
 659 function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
 660         return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag_id, $taxonomy ) );
 661 }
 662
 663 /**
 664  * Display or retrieve edit tag link with formatting.
 665  *
 666  * @since 2.7.0
 667  *
 668  * @param string $link Optional. Anchor text.
 669  * @param string $before Optional. Display before edit link.
 670  * @param string $after Optional. Display after edit link.
 671  * @param int|object $tag Tag object or ID
 672  * @return string HTML content.
 673  */
 674 function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
 675         $link = edit_term_link( $link, '', '', false, $tag );
 676         echo $before . apply_filters( 'edit_tag_link', $link ) . $after;
 677 }
 678
 679 /**
 680  * Retrieve edit term url.
 681  *
 682  * @since 3.1.0
 683  *
 684  * @param int $term_id Term ID
 685  * @param string $taxonomy Taxonomy
 686  * @param string $object_type The object type
 687  * @return string
 688  */
 689 function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
 690         $tax = get_taxonomy( $taxonomy );
 691         if ( !current_user_can( $tax->cap->edit_terms ) )
 692                 return;
 693
 694         $term = get_term( $term_id, $taxonomy );
 695
 696         $args = array(
 697                 'action' => 'edit',
 698                 'taxonomy' => $taxonomy,
 699                 'tag_ID' => $term->term_id,
 700         );
 701
 702         if ( $object_type )
 703                 $args['post_type'] = $object_type;
 704
 705         $location = add_query_arg( $args, admin_url( 'edit-tags.php' ) );
 706
 707         return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type );
 708 }
 709
 710 /**
 711  * Display or retrieve edit term link with formatting.
 712  *
 713  * @since 3.1.0
 714  *
 715  * @param string $link Optional. Anchor text.
 716  * @param string $before Optional. Display before edit link.
 717  * @param string $after Optional. Display after edit link.
 718  * @param object $term Term object
 719  * @return string HTML content.
 720  */
 721 function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
 722         if ( is_null( $term ) ) {
 723                 $term = get_queried_object();
 724         }
 725
 726         $tax = get_taxonomy( $term->taxonomy );
 727         if ( !current_user_can($tax->cap->edit_terms) )
 728                 return;
 729
 730         if ( empty( $link ) )
 731                 $link = __('Edit This');
 732
 733         $link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '" title="' . $link . '">' . $link . '</a>';
 734         $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after;
 735
 736         if ( $echo )
 737                 echo $link;
 738         else
 739                 return $link;
 740 }
 741
 742 /**
 743 * Retrieve permalink for search.
 744 *
 745 * @since  3.0.0
 746 * @param string $query Optional. The query string to use. If empty the current query is used.
 747 * @return string
 748 */
 749 function get_search_link( $query = '' ) {
 750         global $wp_rewrite;
 751
 752         if ( empty($query) )
 753                 $search = get_search_query( false );
 754         else
 755                 $search = stripslashes($query);
 756
 757         $permastruct = $wp_rewrite->get_search_permastruct();
 758
 759         if ( empty( $permastruct ) ) {
 760                 $link = home_url('?s=' . urlencode($search) );
 761         } else {
 762                 $search = urlencode($search);
 763                 $search = str_replace('%2F', '/', $search); // %2F(/) is not valid within a URL, send it unencoded.
 764                 $link = str_replace( '%search%', $search, $permastruct );
 765                 $link = home_url( user_trailingslashit( $link, 'search' ) );
 766         }
 767
 768         return apply_filters( 'search_link', $link, $search );
 769 }
 770
 771 /**
 772  * Retrieve the permalink for the feed of the search results.
 773  *
 774  * @since 2.5.0
 775  *
 776  * @param string $search_query Optional. Search query.
 777  * @param string $feed Optional. Feed type.
 778  * @return string
 779  */
 780 function get_search_feed_link($search_query = '', $feed = '') {
 781         global $wp_rewrite;
 782         $link = get_search_link($search_query);
 783
 784         if ( empty($feed) )
 785                 $feed = get_default_feed();
 786
 787         $permastruct = $wp_rewrite->get_search_permastruct();
 788
 789         if ( empty($permastruct) ) {
 790                 $link = add_query_arg('feed', $feed, $link);
 791         } else {
 792                 $link = trailingslashit($link);
 793                 $link .= "feed/$feed/";
 794         }
 795
 796         $link = apply_filters('search_feed_link', $link, $feed, 'posts');
 797
 798         return $link;
 799 }
 800
 801 /**
 802  * Retrieve the permalink for the comments feed of the search results.
 803  *
 804  * @since 2.5.0
 805  *
 806  * @param string $search_query Optional. Search query.
 807  * @param string $feed Optional. Feed type.
 808  * @return string
 809  */
 810 function get_search_comments_feed_link($search_query = '', $feed = '') {
 811         global $wp_rewrite;
 812
 813         if ( empty($feed) )
 814                 $feed = get_default_feed();
 815
 816         $link = get_search_feed_link($search_query, $feed);
 817
 818         $permastruct = $wp_rewrite->get_search_permastruct();
 819
 820         if ( empty($permastruct) )
 821                 $link = add_query_arg('feed', 'comments-' . $feed, $link);
 822         else
 823                 $link = add_query_arg('withcomments', 1, $link);
 824
 825         $link = apply_filters('search_feed_link', $link, $feed, 'comments');
 826
 827         return $link;
 828 }
 829
 830 /**
 831  * Retrieve the permalink for a post type archive.
 832  *
 833  * @since 3.1.0
 834  *
 835  * @param string $post_type Post type
 836  * @return string
 837  */
 838 function get_post_type_archive_link( $post_type ) {
 839         global $wp_rewrite;
 840         if ( ! $post_type_obj = get_post_type_object( $post_type ) )
 841                 return false;
 842
 843         if ( ! $post_type_obj->has_archive )
 844                 return false;
 845
 846         if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) ) {
 847                 $struct = ( true === $post_type_obj->has_archive ) ? $post_type_obj->rewrite['slug'] : $post_type_obj->has_archive;
 848                 if ( $post_type_obj->rewrite['with_front'] )
 849                         $struct = $wp_rewrite->front . $struct;
 850                 $link = home_url( user_trailingslashit( $struct, 'post_type_archive' ) );
 851         } else {
 852                 $link = home_url( '?post_type=' . $post_type );
 853         }
 854
 855         return apply_filters( 'post_type_archive_link', $link, $post_type );
 856 }
 857
 858 /**
 859  * Retrieve the permalink for a post type archive feed.
 860  *
 861  * @since 3.1.0
 862  *
 863  * @param string $post_type Post type
 864  * @param string $feed Optional. Feed type
 865  * @return string
 866  */
 867 function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
 868         $default_feed = get_default_feed();
 869         if ( empty( $feed ) )
 870                 $feed = $default_feed;
 871
 872         if ( ! $link = get_post_type_archive_link( $post_type ) )
 873                 return false;
 874         $post_type_obj = get_post_type_object( $post_type );
 875         if ( $post_type_obj->rewrite['feeds'] && get_option( 'permalink_structure' ) ) {
 876                 $link = trailingslashit($link);
 877                 $link .= 'feed/';
 878                 if ( $feed != $default_feed )
 879                         $link .= "$feed/";
 880         } else {
 881                 $link = add_query_arg( 'feed', $feed, $link );
 882         }
 883
 884         return apply_filters( 'post_type_archive_feed_link', $link, $feed );
 885 }
 886
 887 /**
 888  * Retrieve edit posts link for post.
 889  *
 890  * Can be used within the WordPress loop or outside of it. Can be used with
 891  * pages, posts, attachments, and revisions.
 892  *
 893  * @since 2.3.0
 894  *
 895  * @param int $id Optional. Post ID.
 896  * @param string $context Optional, default to display. How to write the '&', defaults to '&amp;'.
 897  * @return string
 898  */
 899 function get_edit_post_link( $id = 0, $context = 'display' ) {
 900         if ( !$post = &get_post( $id ) )
 901                 return;
 902
 903         if ( 'display' == $context )
 904                 $action = '&amp;action=edit';
 905         else
 906                 $action = '&action=edit';
 907
 908         $post_type_object = get_post_type_object( $post->post_type );
 909         if ( !$post_type_object )
 910                 return;
 911
 912         if ( !current_user_can( $post_type_object->cap->edit_post, $post->ID ) )
 913                 return;
 914
 915         return apply_filters( 'get_edit_post_link', admin_url( sprintf($post_type_object->_edit_link . $action, $post->ID) ), $post->ID, $context );
 916 }
 917
 918 /**
 919  * Display edit post link for post.
 920  *
 921  * @since 1.0.0
 922  *
 923  * @param string $link Optional. Anchor text.
 924  * @param string $before Optional. Display before edit link.
 925  * @param string $after Optional. Display after edit link.
 926  * @param int $id Optional. Post ID.
 927  */
 928 function edit_post_link( $link = null, $before = '', $after = '', $id = 0 ) {
 929         if ( !$post = &get_post( $id ) )
 930                 return;
 931
 932         if ( !$url = get_edit_post_link( $post->ID ) )
 933                 return;
 934
 935         if ( null === $link )
 936                 $link = __('Edit This');
 937
 938         $post_type_obj = get_post_type_object( $post->post_type );
 939         $link = '<a class="post-edit-link" href="' . $url . '" title="' . esc_attr( $post_type_obj->labels->edit_item ) . '">' . $link . '</a>';
 940         echo $before . apply_filters( 'edit_post_link', $link, $post->ID ) . $after;
 941 }
 942
 943 /**
 944  * Retrieve delete posts link for post.
 945  *
 946  * Can be used within the WordPress loop or outside of it, with any post type.
 947  *
 948  * @since 2.9.0
 949  *
 950  * @param int $id Optional. Post ID.
 951  * @param string $deprecated Not used.
 952  * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
 953  * @return string
 954  */
 955 function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
 956         if ( ! empty( $deprecated ) )
 957                 _deprecated_argument( __FUNCTION__, '3.0' );
 958
 959         if ( !$post = &get_post( $id ) )
 960                 return;
 961
 962         $post_type_object = get_post_type_object( $post->post_type );
 963         if ( !$post_type_object )
 964                 return;
 965
 966         if ( !current_user_can( $post_type_object->cap->delete_post, $post->ID ) )
 967                 return;
 968
 969         $action = ( $force_delete || !EMPTY_TRASH_DAYS ) ? 'delete' : 'trash';
 970
 971         $delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) );
 972
 973         return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-{$post->post_type}_{$post->ID}" ), $post->ID, $force_delete );
 974 }
 975
 976 /**
 977  * Retrieve edit comment link.
 978  *
 979  * @since 2.3.0
 980  *
 981  * @param int $comment_id Optional. Comment ID.
 982  * @return string
 983  */
 984 function get_edit_comment_link( $comment_id = 0 ) {
 985         $comment = &get_comment( $comment_id );
 986
 987         if ( !current_user_can( 'edit_comment', $comment->comment_ID ) )
 988                 return;
 989
 990         $location = admin_url('comment.php?action=editcomment&amp;c=') . $comment->comment_ID;
 991         return apply_filters( 'get_edit_comment_link', $location );
 992 }
 993
 994 /**
 995  * Display or retrieve edit comment link with formatting.
 996  *
 997  * @since 1.0.0
 998  *
 999  * @param string $link Optional. Anchor text.
1000  * @param string $before Optional. Display before edit link.
1001  * @param string $after Optional. Display after edit link.
1002  * @return string|null HTML content, if $echo is set to false.
1003  */
1004 function edit_comment_link( $link = null, $before = '', $after = '' ) {
1005         global $comment;
1006
1007         if ( !current_user_can( 'edit_comment', $comment->comment_ID ) )
1008                 return;
1009
1010         if ( null === $link )
1011                 $link = __('Edit This');
1012
1013         $link = '<a class="comment-edit-link" href="' . get_edit_comment_link( $comment->comment_ID ) . '" title="' . esc_attr__( 'Edit comment' ) . '">' . $link . '</a>';
1014         echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID ) . $after;
1015 }
1016
1017 /**
1018  * Display edit bookmark (literally a URL external to blog) link.
1019  *
1020  * @since 2.7.0
1021  *
1022  * @param int $link Optional. Bookmark ID.
1023  * @return string
1024  */
1025 function get_edit_bookmark_link( $link = 0 ) {
1026         $link = get_bookmark( $link );
1027
1028         if ( !current_user_can('manage_links') )
1029                 return;
1030
1031         $location = admin_url('link.php?action=edit&amp;link_id=') . $link->link_id;
1032         return apply_filters( 'get_edit_bookmark_link', $location, $link->link_id );
1033 }
1034
1035 /**
1036  * Display edit bookmark (literally a URL external to blog) link anchor content.
1037  *
1038  * @since 2.7.0
1039  *
1040  * @param string $link Optional. Anchor text.
1041  * @param string $before Optional. Display before edit link.
1042  * @param string $after Optional. Display after edit link.
1043  * @param int $bookmark Optional. Bookmark ID.
1044  */
1045 function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) {
1046         $bookmark = get_bookmark($bookmark);
1047
1048         if ( !current_user_can('manage_links') )
1049                 return;
1050
1051         if ( empty($link) )
1052                 $link = __('Edit This');
1053
1054         $link = '<a href="' . get_edit_bookmark_link( $bookmark ) . '" title="' . esc_attr__( 'Edit Link' ) . '">' . $link . '</a>';
1055         echo $before . apply_filters( 'edit_bookmark_link', $link, $bookmark->link_id ) . $after;
1056 }
1057
1058 // Navigation links
1059
1060 /**
1061  * Retrieve previous post that is adjacent to current post.
1062  *
1063  * @since 1.5.0
1064  *
1065  * @param bool $in_same_cat Optional. Whether post should be in same category.
1066  * @param string $excluded_categories Optional. Excluded categories IDs.
1067  * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
1068  */
1069 function get_previous_post($in_same_cat = false, $excluded_categories = '') {
1070         return get_adjacent_post($in_same_cat, $excluded_categories);
1071 }
1072
1073 /**
1074  * Retrieve next post that is adjacent to current post.
1075  *
1076  * @since 1.5.0
1077  *
1078  * @param bool $in_same_cat Optional. Whether post should be in same category.
1079  * @param string $excluded_categories Optional. Excluded categories IDs.
1080  * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
1081  */
1082 function get_next_post($in_same_cat = false, $excluded_categories = '') {
1083         return get_adjacent_post($in_same_cat, $excluded_categories, false);
1084 }
1085
1086 /**
1087  * Retrieve adjacent post.
1088  *
1089  * Can either be next or previous post.
1090  *
1091  * @since 2.5.0
1092  *
1093  * @param bool $in_same_cat Optional. Whether post should be in same category.
1094  * @param string $excluded_categories Optional. Excluded categories IDs.
1095  * @param bool $previous Optional. Whether to retrieve previous post.
1096  * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
1097  */
1098 function get_adjacent_post($in_same_cat = false, $excluded_categories = '', $previous = true) {
1099         global $post, $wpdb;
1100
1101         if ( empty( $post ) )
1102                 return null;
1103
1104         $current_post_date = $post->post_date;
1105
1106         $join = '';
1107         $posts_in_ex_cats_sql = '';
1108         if ( $in_same_cat || !empty($excluded_categories) ) {
1109                 $join = " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy tt ON tr.term_taxonomy_id = tt.term_taxonomy_id";
1110
1111                 if ( $in_same_cat ) {
1112                         $cat_array = wp_get_object_terms($post->ID, 'category', array('fields' => 'ids'));
1113                         $join .= " AND tt.taxonomy = 'category' AND tt.term_id IN (" . implode(',', $cat_array) . ")";
1114                 }
1115
1116                 $posts_in_ex_cats_sql = "AND tt.taxonomy = 'category'";
1117                 if ( !empty($excluded_categories) ) {
1118                         $excluded_categories = array_map('intval', explode(' and ', $excluded_categories));
1119                         if ( !empty($cat_array) ) {
1120                                 $excluded_categories = array_diff($excluded_categories, $cat_array);
1121                                 $posts_in_ex_cats_sql = '';
1122                         }
1123
1124                         if ( !empty($excluded_categories) ) {
1125                                 $posts_in_ex_cats_sql = " AND tt.taxonomy = 'category' AND tt.term_id NOT IN (" . implode($excluded_categories, ',') . ')';
1126                         }
1127                 }
1128         }
1129
1130         $adjacent = $previous ? 'previous' : 'next';
1131         $op = $previous ? '<' : '>';
1132         $order = $previous ? 'DESC' : 'ASC';
1133
1134         $join  = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_cat, $excluded_categories );
1135         $where = apply_filters( "get_{$adjacent}_post_where", $wpdb->prepare("WHERE p.post_date $op %s AND p.post_type = %s AND p.post_status = 'publish' $posts_in_ex_cats_sql", $current_post_date, $post->post_type), $in_same_cat, $excluded_categories );
1136         $sort  = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1" );
1137
1138         $query = "SELECT p.* FROM $wpdb->posts AS p $join $where $sort";
1139         $query_key = 'adjacent_post_' . md5($query);
1140         $result = wp_cache_get($query_key, 'counts');
1141         if ( false !== $result )
1142                 return $result;
1143
1144         $result = $wpdb->get_row("SELECT p.* FROM $wpdb->posts AS p $join $where $sort");
1145         if ( null === $result )
1146                 $result = '';
1147
1148         wp_cache_set($query_key, $result, 'counts');
1149         return $result;
1150 }
1151
1152 /**
1153  * Get adjacent post relational link.
1154  *
1155  * Can either be next or previous post relational link.
1156  *
1157  * @since 2.8.0
1158  *
1159  * @param string $title Optional. Link title format.
1160  * @param bool $in_same_cat Optional. Whether link should be in same category.
1161  * @param string $excluded_categories Optional. Excluded categories IDs.
1162  * @param bool $previous Optional, default is true. Whether display link to previous post.
1163  * @return string
1164  */
1165 function get_adjacent_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $previous = true) {
1166         if ( $previous && is_attachment() && is_object( $GLOBALS['post'] ) )
1167                 $post = & get_post($GLOBALS['post']->post_parent);
1168         else
1169                 $post = get_adjacent_post($in_same_cat,$excluded_categories,$previous);
1170
1171         if ( empty($post) )
1172                 return;
1173
1174         if ( empty($post->post_title) )
1175                 $post->post_title = $previous ? __('Previous Post') : __('Next Post');
1176
1177         $date = mysql2date(get_option('date_format'), $post->post_date);
1178
1179         $title = str_replace('%title', $post->post_title, $title);
1180         $title = str_replace('%date', $date, $title);
1181         $title = apply_filters('the_title', $title, $post->ID);
1182
1183         $link = $previous ? "<link rel='prev' title='" : "<link rel='next' title='";
1184         $link .= esc_attr( $title );
1185         $link .= "' href='" . get_permalink($post) . "' />\n";
1186
1187         $adjacent = $previous ? 'previous' : 'next';
1188         return apply_filters( "{$adjacent}_post_rel_link", $link );
1189 }
1190
1191 /**
1192  * Display relational links for the posts adjacent to the current post.
1193  *
1194  * @since 2.8.0
1195  *
1196  * @param string $title Optional. Link title format.
1197  * @param bool $in_same_cat Optional. Whether link should be in same category.
1198  * @param string $excluded_categories Optional. Excluded categories IDs.
1199  */
1200 function adjacent_posts_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
1201         echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', true);
1202         echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', false);
1203 }
1204
1205 /**
1206  * Display relational links for the posts adjacent to the current post for single post pages.
1207  *
1208  * This is meant to be attached to actions like 'wp_head'.  Do not call this directly in plugins or theme templates.
1209  * @since 3.0.0
1210  *
1211  */
1212 function adjacent_posts_rel_link_wp_head() {
1213         if ( !is_singular() || is_attachment() )
1214                 return;
1215         adjacent_posts_rel_link();
1216 }
1217
1218 /**
1219  * Display relational link for the next post adjacent to the current post.
1220  *
1221  * @since 2.8.0
1222  *
1223  * @param string $title Optional. Link title format.
1224  * @param bool $in_same_cat Optional. Whether link should be in same category.
1225  * @param string $excluded_categories Optional. Excluded categories IDs.
1226  */
1227 function next_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
1228         echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', false);
1229 }
1230
1231 /**
1232  * Display relational link for the previous post adjacent to the current post.
1233  *
1234  * @since 2.8.0
1235  *
1236  * @param string $title Optional. Link title format.
1237  * @param bool $in_same_cat Optional. Whether link should be in same category.
1238  * @param string $excluded_categories Optional. Excluded categories IDs.
1239  */
1240 function prev_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
1241         echo get_adjacent_post_rel_link($title, $in_same_cat, $excluded_categories = '', true);
1242 }
1243
1244 /**
1245  * Retrieve boundary post.
1246  *
1247  * Boundary being either the first or last post by publish date within the constraints specified
1248  * by in same category or excluded categories.
1249  *
1250  * @since 2.8.0
1251  *
1252  * @param bool $in_same_cat Optional. Whether returned post should be in same category.
1253  * @param string $excluded_categories Optional. Excluded categories IDs.
1254  * @param bool $start Optional. Whether to retrieve first or last post.
1255  * @return object
1256  */
1257 function get_boundary_post($in_same_cat = false, $excluded_categories = '', $start = true) {
1258         global $post;
1259
1260         if ( empty($post) || !is_single() || is_attachment() )
1261                 return null;
1262
1263         $cat_array = array();
1264         $excluded_categories = array();
1265         if ( !empty($in_same_cat) || !empty($excluded_categories) ) {
1266                 if ( !empty($in_same_cat) ) {
1267                         $cat_array = wp_get_object_terms($post->ID, 'category', array('fields' => 'ids'));
1268                 }
1269
1270                 if ( !empty($excluded_categories) ) {
1271                         $excluded_categories = array_map('intval', explode(',', $excluded_categories));
1272
1273                         if ( !empty($cat_array) )
1274                                 $excluded_categories = array_diff($excluded_categories, $cat_array);
1275
1276                         $inverse_cats = array();
1277                         foreach ( $excluded_categories as $excluded_category)
1278                                 $inverse_cats[] = $excluded_category * -1;
1279                         $excluded_categories = $inverse_cats;
1280                 }
1281         }
1282
1283         $categories = implode(',', array_merge($cat_array, $excluded_categories) );
1284
1285         $order = $start ? 'ASC' : 'DESC';
1286
1287         return get_posts( array('numberposts' => 1, 'category' => $categories, 'order' => $order, 'update_post_term_cache' => false, 'update_post_meta_cache' => false) );
1288 }
1289
1290 /**
1291  * Get boundary post relational link.
1292  *
1293  * Can either be start or end post relational link.
1294  *
1295  * @since 2.8.0
1296  *
1297  * @param string $title Optional. Link title format.
1298  * @param bool $in_same_cat Optional. Whether link should be in same category.
1299  * @param string $excluded_categories Optional. Excluded categories IDs.
1300  * @param bool $start Optional, default is true. Whether display link to first or last post.
1301  * @return string
1302  */
1303 function get_boundary_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $start = true) {
1304         $posts = get_boundary_post($in_same_cat, $excluded_categories, $start);
1305         // If there is no post stop.
1306         if ( empty($posts) )
1307                 return;
1308
1309         // Even though we limited get_posts to return only 1 item it still returns an array of objects.
1310         $post = $posts[0];
1311
1312         if ( empty($post->post_title) )
1313                 $post->post_title = $start ? __('First Post') : __('Last Post');
1314
1315         $date = mysql2date(get_option('date_format'), $post->post_date);
1316
1317         $title = str_replace('%title', $post->post_title, $title);
1318         $title = str_replace('%date', $date, $title);
1319         $title = apply_filters('the_title', $title, $post->ID);
1320
1321         $link = $start ? "<link rel='start' title='" : "<link rel='end' title='";
1322         $link .= esc_attr($title);
1323         $link .= "' href='" . get_permalink($post) . "' />\n";
1324
1325         $boundary = $start ? 'start' : 'end';
1326         return apply_filters( "{$boundary}_post_rel_link", $link );
1327 }
1328
1329 /**
1330  * Display relational link for the first post.
1331  *
1332  * @since 2.8.0
1333  *
1334  * @param string $title Optional. Link title format.
1335  * @param bool $in_same_cat Optional. Whether link should be in same category.
1336  * @param string $excluded_categories Optional. Excluded categories IDs.
1337  */
1338 function start_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
1339         echo get_boundary_post_rel_link($title, $in_same_cat, $excluded_categories, true);
1340 }
1341
1342 /**
1343  * Get site index relational link.
1344  *
1345  * @since 2.8.0
1346  *
1347  * @return string
1348  */
1349 function get_index_rel_link() {
1350         $link = "<link rel='index' title='" . esc_attr( get_bloginfo( 'name', 'display' ) ) . "' href='" . esc_url( user_trailingslashit( get_bloginfo( 'url', 'display' ) ) ) . "' />\n";
1351         return apply_filters( "index_rel_link", $link );
1352 }
1353
1354 /**
1355  * Display relational link for the site index.
1356  *
1357  * @since 2.8.0
1358  */
1359 function index_rel_link() {
1360         echo get_index_rel_link();
1361 }
1362
1363 /**
1364  * Get parent post relational link.
1365  *
1366  * @since 2.8.0
1367  *
1368  * @param string $title Optional. Link title format.
1369  * @return string
1370  */
1371 function get_parent_post_rel_link($title = '%title') {
1372         if ( ! empty( $GLOBALS['post'] ) && ! empty( $GLOBALS['post']->post_parent ) )
1373                 $post = & get_post($GLOBALS['post']->post_parent);
1374
1375         if ( empty($post) )
1376                 return;
1377
1378         $date = mysql2date(get_option('date_format'), $post->post_date);
1379
1380         $title = str_replace('%title', $post->post_title, $title);
1381         $title = str_replace('%date', $date, $title);
1382         $title = apply_filters('the_title', $title, $post->ID);
1383
1384         $link = "<link rel='up' title='";
1385         $link .= esc_attr( $title );
1386         $link .= "' href='" . get_permalink($post) . "' />\n";
1387
1388         return apply_filters( "parent_post_rel_link", $link );
1389 }
1390
1391 /**
1392  * Display relational link for parent item
1393  *
1394  * @since 2.8.0
1395  */
1396 function parent_post_rel_link($title = '%title') {
1397         echo get_parent_post_rel_link($title);
1398 }
1399
1400 /**
1401  * Display previous post link that is adjacent to the current post.
1402  *
1403  * @since 1.5.0
1404  *
1405  * @param string $format Optional. Link anchor format.
1406  * @param string $link Optional. Link permalink format.
1407  * @param bool $in_same_cat Optional. Whether link should be in same category.
1408  * @param string $excluded_categories Optional. Excluded categories IDs.
1409  */
1410 function previous_post_link($format='&laquo; %link', $link='%title', $in_same_cat = false, $excluded_categories = '') {
1411         adjacent_post_link($format, $link, $in_same_cat, $excluded_categories, true);
1412 }
1413
1414 /**
1415  * Display next post link that is adjacent to the current post.
1416  *
1417  * @since 1.5.0
1418  *
1419  * @param string $format Optional. Link anchor format.
1420  * @param string $link Optional. Link permalink format.
1421  * @param bool $in_same_cat Optional. Whether link should be in same category.
1422  * @param string $excluded_categories Optional. Excluded categories IDs.
1423  */
1424 function next_post_link($format='%link &raquo;', $link='%title', $in_same_cat = false, $excluded_categories = '') {
1425         adjacent_post_link($format, $link, $in_same_cat, $excluded_categories, false);
1426 }
1427
1428 /**
1429  * Display adjacent post link.
1430  *
1431  * Can be either next post link or previous.
1432  *
1433  * @since 2.5.0
1434  *
1435  * @param string $format Link anchor format.
1436  * @param string $link Link permalink format.
1437  * @param bool $in_same_cat Optional. Whether link should be in same category.
1438  * @param string $excluded_categories Optional. Excluded categories IDs.
1439  * @param bool $previous Optional, default is true. Whether display link to previous post.
1440  */
1441 function adjacent_post_link($format, $link, $in_same_cat = false, $excluded_categories = '', $previous = true) {
1442         if ( $previous && is_attachment() )
1443                 $post = & get_post($GLOBALS['post']->post_parent);
1444         else
1445                 $post = get_adjacent_post($in_same_cat, $excluded_categories, $previous);
1446
1447         if ( !$post )
1448                 return;
1449
1450         $title = $post->post_title;
1451
1452         if ( empty($post->post_title) )
1453                 $title = $previous ? __('Previous Post') : __('Next Post');
1454
1455         $title = apply_filters('the_title', $title, $post->ID);
1456         $date = mysql2date(get_option('date_format'), $post->post_date);
1457         $rel = $previous ? 'prev' : 'next';
1458
1459         $string = '<a href="'.get_permalink($post).'" rel="'.$rel.'">';
1460         $link = str_replace('%title', $title, $link);
1461         $link = str_replace('%date', $date, $link);
1462         $link = $string . $link . '</a>';
1463
1464         $format = str_replace('%link', $link, $format);
1465
1466         $adjacent = $previous ? 'previous' : 'next';
1467         echo apply_filters( "{$adjacent}_post_link", $format, $link );
1468 }
1469
1470 /**
1471  * Retrieve get links for page numbers.
1472  *
1473  * @since 1.5.0
1474  *
1475  * @param int $pagenum Optional. Page ID.
1476  * @return string
1477  */
1478 function get_pagenum_link($pagenum = 1) {
1479         global $wp_rewrite;
1480
1481         $pagenum = (int) $pagenum;
1482
1483         $request = remove_query_arg( 'paged' );
1484
1485         $home_root = parse_url(home_url());
1486         $home_root = ( isset($home_root['path']) ) ? $home_root['path'] : '';
1487         $home_root = preg_quote( trailingslashit( $home_root ), '|' );
1488
1489         $request = preg_replace('|^'. $home_root . '|', '', $request);
1490         $request = preg_replace('|^/+|', '', $request);
1491
1492         if ( !$wp_rewrite->using_permalinks() || is_admin() ) {
1493                 $base = trailingslashit( get_bloginfo( 'url' ) );
1494
1495                 if ( $pagenum > 1 ) {
1496                         $result = add_query_arg( 'paged', $pagenum, $base . $request );
1497                 } else {
1498                         $result = $base . $request;
1499                 }
1500         } else {
1501                 $qs_regex = '|\?.*?$|';
1502                 preg_match( $qs_regex, $request, $qs_match );
1503
1504                 if ( !empty( $qs_match[0] ) ) {
1505                         $query_string = $qs_match[0];
1506                         $request = preg_replace( $qs_regex, '', $request );
1507                 } else {
1508                         $query_string = '';
1509                 }
1510
1511                 $request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request);
1512                 $request = preg_replace( '|^index\.php|', '', $request);
1513                 $request = ltrim($request, '/');
1514
1515                 $base = trailingslashit( get_bloginfo( 'url' ) );
1516
1517                 if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' != $request ) )
1518                         $base .= 'index.php/';
1519
1520                 if ( $pagenum > 1 ) {
1521                         $request = ( ( !empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( $wp_rewrite->pagination_base . "/" . $pagenum, 'paged' );
1522                 }
1523
1524                 $result = $base . $request . $query_string;
1525         }
1526
1527         $result = apply_filters('get_pagenum_link', $result);
1528
1529         return $result;
1530 }
1531
1532 /**
1533  * Retrieve next posts pages link.
1534  *
1535  * Backported from 2.1.3 to 2.0.10.
1536  *
1537  * @since 2.0.10
1538  *
1539  * @param int $max_page Optional. Max pages.
1540  * @return string
1541  */
1542 function get_next_posts_page_link($max_page = 0) {
1543         global $paged;
1544
1545         if ( !is_single() ) {
1546                 if ( !$paged )
1547                         $paged = 1;
1548                 $nextpage = intval($paged) + 1;
1549                 if ( !$max_page || $max_page >= $nextpage )
1550                         return get_pagenum_link($nextpage);
1551         }
1552 }
1553
1554 /**
1555  * Display or return the next posts pages link.
1556  *
1557  * @since 0.71
1558  *
1559  * @param int $max_page Optional. Max pages.
1560  * @param boolean $echo Optional. Echo or return;
1561  */
1562 function next_posts( $max_page = 0, $echo = true ) {
1563         $output = esc_url( get_next_posts_page_link( $max_page ) );
1564
1565         if ( $echo )
1566                 echo $output;
1567         else
1568                 return $output;
1569 }
1570
1571 /**
1572  * Return the next posts pages link.
1573  *
1574  * @since 2.7.0
1575  *
1576  * @param string $label Content for link text.
1577  * @param int $max_page Optional. Max pages.
1578  * @return string|null
1579  */
1580 function get_next_posts_link( $label = 'Next Page &raquo;', $max_page = 0 ) {
1581         global $paged, $wp_query;
1582
1583         if ( !$max_page )
1584                 $max_page = $wp_query->max_num_pages;
1585
1586         if ( !$paged )
1587                 $paged = 1;
1588
1589         $nextpage = intval($paged) + 1;
1590
1591         if ( !is_single() && ( $nextpage <= $max_page ) ) {
1592                 $attr = apply_filters( 'next_posts_link_attributes', '' );
1593                 return '<a href="' . next_posts( $max_page, false ) . "\" $attr>" . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label) . '</a>';
1594         }
1595 }
1596
1597 /**
1598  * Display the next posts pages link.
1599  *
1600  * @since 0.71
1601  * @uses get_next_posts_link()
1602  *
1603  * @param string $label Content for link text.
1604  * @param int $max_page Optional. Max pages.
1605  */
1606 function next_posts_link( $label = 'Next Page &raquo;', $max_page = 0 ) {
1607         echo get_next_posts_link( $label, $max_page );
1608 }
1609
1610 /**
1611  * Retrieve previous post pages link.
1612  *
1613  * Will only return string, if not on a single page or post.
1614  *
1615  * Backported to 2.0.10 from 2.1.3.
1616  *
1617  * @since 2.0.10
1618  *
1619  * @return string|null
1620  */
1621 function get_previous_posts_page_link() {
1622         global $paged;
1623
1624         if ( !is_single() ) {
1625                 $nextpage = intval($paged) - 1;
1626                 if ( $nextpage < 1 )
1627                         $nextpage = 1;
1628                 return get_pagenum_link($nextpage);
1629         }
1630 }
1631
1632 /**
1633  * Display or return the previous posts pages link.
1634  *
1635  * @since 0.71
1636  *
1637  * @param boolean $echo Optional. Echo or return;
1638  */
1639 function previous_posts( $echo = true ) {
1640         $output = esc_url( get_previous_posts_page_link() );
1641
1642         if ( $echo )
1643                 echo $output;
1644         else
1645                 return $output;
1646 }
1647
1648 /**
1649  * Return the previous posts pages link.
1650  *
1651  * @since 2.7.0
1652  *
1653  * @param string $label Optional. Previous page link text.
1654  * @return string|null
1655  */
1656 function get_previous_posts_link( $label = '&laquo; Previous Page' ) {
1657         global $paged;
1658
1659         if ( !is_single() && $paged > 1 ) {
1660                 $attr = apply_filters( 'previous_posts_link_attributes', '' );
1661                 return '<a href="' . previous_posts( false ) . "\" $attr>". preg_replace( '/&([^#])(?![a-z]{1,8};)/', '&#038;$1', $label ) .'</a>';
1662         }
1663 }
1664
1665 /**
1666  * Display the previous posts page link.
1667  *
1668  * @since 0.71
1669  * @uses get_previous_posts_link()
1670  *
1671  * @param string $label Optional. Previous page link text.
1672  */
1673 function previous_posts_link( $label = '&laquo; Previous Page' ) {
1674         echo get_previous_posts_link( $label );
1675 }
1676
1677 /**
1678  * Return post pages link navigation for previous and next pages.
1679  *
1680  * @since 2.8
1681  *
1682  * @param string|array $args Optional args.
1683  * @return string The posts link navigation.
1684  */
1685 function get_posts_nav_link( $args = array() ) {
1686         global $wp_query;
1687
1688         $return = '';
1689
1690         if ( !is_singular() ) {
1691                 $defaults = array(
1692                         'sep' => ' &#8212; ',
1693                         'prelabel' => __('&laquo; Previous Page'),
1694                         'nxtlabel' => __('Next Page &raquo;'),
1695                 );
1696                 $args = wp_parse_args( $args, $defaults );
1697
1698                 $max_num_pages = $wp_query->max_num_pages;
1699                 $paged = get_query_var('paged');
1700
1701                 //only have sep if there's both prev and next results
1702                 if ($paged < 2 || $paged >= $max_num_pages) {
1703                         $args['sep'] = '';
1704                 }
1705
1706                 if ( $max_num_pages > 1 ) {
1707                         $return = get_previous_posts_link($args['prelabel']);
1708                         $return .= preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $args['sep']);
1709                         $return .= get_next_posts_link($args['nxtlabel']);
1710                 }
1711         }
1712         return $return;
1713
1714 }
1715
1716 /**
1717  * Display post pages link navigation for previous and next pages.
1718  *
1719  * @since 0.71
1720  *
1721  * @param string $sep Optional. Separator for posts navigation links.
1722  * @param string $prelabel Optional. Label for previous pages.
1723  * @param string $nxtlabel Optional Label for next pages.
1724  */
1725 function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) {
1726         $args = array_filter( compact('sep', 'prelabel', 'nxtlabel') );
1727         echo get_posts_nav_link($args);
1728 }
1729
1730 /**
1731  * Retrieve page numbers links.
1732  *
1733  * @since 2.7.0
1734  *
1735  * @param int $pagenum Optional. Page number.
1736  * @return string
1737  */
1738 function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
1739         global $post, $wp_rewrite;
1740
1741         $pagenum = (int) $pagenum;
1742
1743         $result = get_permalink( $post->ID );
1744
1745         if ( 'newest' == get_option('default_comments_page') ) {
1746                 if ( $pagenum != $max_page ) {
1747                         if ( $wp_rewrite->using_permalinks() )
1748                                 $result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
1749                         else
1750                                 $result = add_query_arg( 'cpage', $pagenum, $result );
1751                 }
1752         } elseif ( $pagenum > 1 ) {
1753                 if ( $wp_rewrite->using_permalinks() )
1754                         $result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
1755                 else
1756                         $result = add_query_arg( 'cpage', $pagenum, $result );
1757         }
1758
1759         $result .= '#comments';
1760
1761         $result = apply_filters('get_comments_pagenum_link', $result);
1762
1763         return $result;
1764 }
1765
1766 /**
1767  * Return the link to next comments pages.
1768  *
1769  * @since 2.7.1
1770  *
1771  * @param string $label Optional. Label for link text.
1772  * @param int $max_page Optional. Max page.
1773  * @return string|null
1774  */
1775 function get_next_comments_link( $label = '', $max_page = 0 ) {
1776         global $wp_query;
1777
1778         if ( !is_singular() || !get_option('page_comments') )
1779                 return;
1780
1781         $page = get_query_var('cpage');
1782
1783         $nextpage = intval($page) + 1;
1784
1785         if ( empty($max_page) )
1786                 $max_page = $wp_query->max_num_comment_pages;
1787
1788         if ( empty($max_page) )
1789                 $max_page = get_comment_pages_count();
1790
1791         if ( $nextpage > $max_page )
1792                 return;
1793
1794         if ( empty($label) )
1795                 $label = __('Newer Comments &raquo;');
1796
1797         return '<a href="' . esc_url( get_comments_pagenum_link( $nextpage, $max_page ) ) . '" ' . apply_filters( 'next_comments_link_attributes', '' ) . '>'. preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label) .'</a>';
1798 }
1799
1800 /**
1801  * Display the link to next comments pages.
1802  *
1803  * @since 2.7.0
1804  *
1805  * @param string $label Optional. Label for link text.
1806  * @param int $max_page Optional. Max page.
1807  */
1808 function next_comments_link( $label = '', $max_page = 0 ) {
1809         echo get_next_comments_link( $label, $max_page );
1810 }
1811
1812 /**
1813  * Return the previous comments page link.
1814  *
1815  * @since 2.7.1
1816  *
1817  * @param string $label Optional. Label for comments link text.
1818  * @return string|null
1819  */
1820 function get_previous_comments_link( $label = '' ) {
1821         if ( !is_singular() || !get_option('page_comments') )
1822                 return;
1823
1824         $page = get_query_var('cpage');
1825
1826         if ( intval($page) <= 1 )
1827                 return;
1828
1829         $prevpage = intval($page) - 1;
1830
1831         if ( empty($label) )
1832                 $label = __('&laquo; Older Comments');
1833
1834         return '<a href="' . esc_url( get_comments_pagenum_link( $prevpage ) ) . '" ' . apply_filters( 'previous_comments_link_attributes', '' ) . '>' . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label) .'</a>';
1835 }
1836
1837 /**
1838  * Display the previous comments page link.
1839  *
1840  * @since 2.7.0
1841  *
1842  * @param string $label Optional. Label for comments link text.
1843  */
1844 function previous_comments_link( $label = '' ) {
1845         echo get_previous_comments_link( $label );
1846 }
1847
1848 /**
1849  * Create pagination links for the comments on the current post.
1850  *
1851  * @see paginate_links()
1852  * @since 2.7.0
1853  *
1854  * @param string|array $args Optional args. See paginate_links.
1855  * @return string Markup for pagination links.
1856 */
1857 function paginate_comments_links($args = array()) {
1858         global $wp_rewrite;
1859
1860         if ( !is_singular() || !get_option('page_comments') )
1861                 return;
1862
1863         $page = get_query_var('cpage');
1864         if ( !$page )
1865                 $page = 1;
1866         $max_page = get_comment_pages_count();
1867         $defaults = array(
1868                 'base' => add_query_arg( 'cpage', '%#%' ),
1869                 'format' => '',
1870                 'total' => $max_page,
1871                 'current' => $page,
1872                 'echo' => true,
1873                 'add_fragment' => '#comments'
1874         );
1875         if ( $wp_rewrite->using_permalinks() )
1876                 $defaults['base'] = user_trailingslashit(trailingslashit(get_permalink()) . 'comment-page-%#%', 'commentpaged');
1877
1878         $args = wp_parse_args( $args, $defaults );
1879         $page_links = paginate_links( $args );
1880
1881         if ( $args['echo'] )
1882                 echo $page_links;
1883         else
1884                 return $page_links;
1885 }
1886
1887 /**
1888  * Retrieve shortcut link.
1889  *
1890  * Use this in 'a' element 'href' attribute.
1891  *
1892  * @since 2.6.0
1893  *
1894  * @return string
1895  */
1896 function get_shortcut_link() {
1897         $link = "javascript:
1898                         var d=document,
1899                         w=window,
1900                         e=w.getSelection,
1901                         k=d.getSelection,
1902                         x=d.selection,
1903                         s=(e?e():(k)?k():(x?x.createRange().text:0)),
1904                         f='" . admin_url('press-this.php') . "',
1905                         l=d.location,
1906                         e=encodeURIComponent,
1907                         u=f+'?u='+e(l.href)+'&t='+e(d.title)+'&s='+e(s)+'&v=4';
1908                         a=function(){if(!w.open(u,'t','toolbar=0,resizable=1,scrollbars=1,status=1,width=720,height=570'))l.href=u;};
1909                         if (/Firefox/.test(navigator.userAgent)) setTimeout(a, 0); else a();
1910                         void(0)";
1911
1912         $link = str_replace(array("\r", "\n", "\t"),  '', $link);
1913
1914         return apply_filters('shortcut_link', $link);
1915 }
1916
1917 /**
1918  * Retrieve the home url for the current site.
1919  *
1920  * Returns the 'home' option with the appropriate protocol,  'https' if
1921  * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
1922  * overridden.
1923  *
1924  * @package WordPress
1925  * @since 3.0.0
1926  *
1927  * @uses get_home_url()
1928  *
1929  * @param  string $path   (optional) Path relative to the home url.
1930  * @param  string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
1931  * @return string Home url link with optional path appended.
1932 */
1933 function home_url( $path = '', $scheme = null ) {
1934         return get_home_url(null, $path, $scheme);
1935 }
1936
1937 /**
1938  * Retrieve the home url for a given site.
1939  *
1940  * Returns the 'home' option with the appropriate protocol,  'https' if
1941  * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
1942  * overridden.
1943  *
1944  * @package WordPress
1945  * @since 3.0.0
1946  *
1947  * @param  int $blog_id   (optional) Blog ID. Defaults to current blog.
1948  * @param  string $path   (optional) Path relative to the home url.
1949  * @param  string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
1950  * @return string Home url link with optional path appended.
1951 */
1952 function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
1953         $orig_scheme = $scheme;
1954
1955         if ( !in_array( $scheme, array( 'http', 'https' ) ) )
1956                 $scheme = is_ssl() && !is_admin() ? 'https' : 'http';
1957
1958         if ( empty( $blog_id ) || !is_multisite() )
1959                 $url = get_option( 'home' );
1960         else
1961                 $url = get_blog_option( $blog_id, 'home' );
1962
1963         if ( 'http' != $scheme )
1964                 $url = str_replace( 'http://', "$scheme://", $url );
1965
1966         if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
1967                 $url .= '/' . ltrim( $path, '/' );
1968
1969         return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
1970 }
1971
1972 /**
1973  * Retrieve the site url for the current site.
1974  *
1975  * Returns the 'site_url' option with the appropriate protocol,  'https' if
1976  * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
1977  * overridden.
1978  *
1979  * @package WordPress
1980  * @since 2.6.0
1981  *
1982  * @uses get_site_url()
1983  *
1984  * @param string $path Optional. Path relative to the site url.
1985  * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
1986  * @return string Site url link with optional path appended.
1987 */
1988 function site_url( $path = '', $scheme = null ) {
1989         return get_site_url(null, $path, $scheme);
1990 }
1991
1992 /**
1993  * Retrieve the site url for a given site.
1994  *
1995  * Returns the 'site_url' option with the appropriate protocol,  'https' if
1996  * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
1997  * overridden.
1998  *
1999  * @package WordPress
2000  * @since 3.0.0
2001  *
2002  * @param int $blog_id (optional) Blog ID. Defaults to current blog.
2003  * @param string $path Optional. Path relative to the site url.
2004  * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
2005  * @return string Site url link with optional path appended.
2006 */
2007 function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
2008         // should the list of allowed schemes be maintained elsewhere?
2009         $orig_scheme = $scheme;
2010         if ( !in_array( $scheme, array( 'http', 'https' ) ) ) {
2011                 if ( ( 'login_post' == $scheme || 'rpc' == $scheme ) && ( force_ssl_login() || force_ssl_admin() ) )
2012                         $scheme = 'https';
2013                 elseif ( ( 'login' == $scheme ) && force_ssl_admin() )
2014                         $scheme = 'https';
2015                 elseif ( ( 'admin' == $scheme ) && force_ssl_admin() )
2016                         $scheme = 'https';
2017                 else
2018                         $scheme = ( is_ssl() ? 'https' : 'http' );
2019         }
2020
2021         if ( empty( $blog_id ) || !is_multisite() )
2022                 $url = get_option( 'siteurl' );
2023         else
2024                 $url = get_blog_option( $blog_id, 'siteurl' );
2025
2026         if ( 'http' != $scheme )
2027                 $url = str_replace( 'http://', "{$scheme}://", $url );
2028
2029         if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
2030                 $url .= '/' . ltrim( $path, '/' );
2031
2032         return apply_filters( 'site_url', $url, $path, $orig_scheme, $blog_id );
2033 }
2034
2035 /**
2036  * Retrieve the url to the admin area for the current site.
2037  *
2038  * @package WordPress
2039  * @since 2.6.0
2040  *
2041  * @param string $path Optional path relative to the admin url
2042  * @param 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.
2043  * @return string Admin url link with optional path appended
2044 */
2045 function admin_url( $path = '', $scheme = 'admin' ) {
2046         return get_admin_url(null, $path, $scheme);
2047 }
2048
2049 /**
2050  * Retrieve the url to the admin area for a given site.
2051  *
2052  * @package WordPress
2053  * @since 3.0.0
2054  *
2055  * @param int $blog_id (optional) Blog ID. Defaults to current blog.
2056  * @param string $path Optional path relative to the admin url
2057  * @param 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.
2058  * @return string Admin url link with optional path appended
2059 */
2060 function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
2061         $url = get_site_url($blog_id, 'wp-admin/', $scheme);
2062
2063         if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
2064                 $url .= ltrim($path, '/');
2065
2066         return apply_filters('admin_url', $url, $path, $blog_id);
2067 }
2068
2069 /**
2070  * Retrieve the url to the includes directory.
2071  *
2072  * @package WordPress
2073  * @since 2.6.0
2074  *
2075  * @param string $path Optional. Path relative to the includes url.
2076  * @return string Includes url link with optional path appended.
2077 */
2078 function includes_url($path = '') {
2079         $url = site_url() . '/' . WPINC . '/';
2080
2081         if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
2082                 $url .= ltrim($path, '/');
2083
2084         return apply_filters('includes_url', $url, $path);
2085 }
2086
2087 /**
2088  * Retrieve the url to the content directory.
2089  *
2090  * @package WordPress
2091  * @since 2.6.0
2092  *
2093  * @param string $path Optional. Path relative to the content url.
2094  * @return string Content url link with optional path appended.
2095 */
2096 function content_url($path = '') {
2097         $url = WP_CONTENT_URL;
2098         if ( 0 === strpos($url, 'http') && is_ssl() )
2099                 $url = str_replace( 'http://', 'https://', $url );
2100
2101         if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
2102                 $url .= '/' . ltrim($path, '/');
2103
2104         return apply_filters('content_url', $url, $path);
2105 }
2106
2107 /**
2108  * Retrieve the url to the plugins directory or to a specific file within that directory.
2109  * You can hardcode the plugin slug in $path or pass __FILE__ as a second argument to get the correct folder name.
2110  *
2111  * @package WordPress
2112  * @since 2.6.0
2113  *
2114  * @param string $path Optional. Path relative to the plugins url.
2115  * @param string $plugin Optional. The plugin file that you want to be relative to - i.e. pass in __FILE__
2116  * @return string Plugins url link with optional path appended.
2117 */
2118 function plugins_url($path = '', $plugin = '') {
2119
2120         $mu_plugin_dir = WPMU_PLUGIN_DIR;
2121         foreach ( array('path', 'plugin', 'mu_plugin_dir') as $var ) {
2122                 $$var = str_replace('\\' ,'/', $$var); // sanitize for Win32 installs
2123                 $$var = preg_replace('|/+|', '/', $$var);
2124         }
2125
2126         if ( !empty($plugin) && 0 === strpos($plugin, $mu_plugin_dir) )
2127                 $url = WPMU_PLUGIN_URL;
2128         else
2129                 $url = WP_PLUGIN_URL;
2130
2131         if ( 0 === strpos($url, 'http') && is_ssl() )
2132                 $url = str_replace( 'http://', 'https://', $url );
2133
2134         if ( !empty($plugin) && is_string($plugin) ) {
2135                 $folder = dirname(plugin_basename($plugin));
2136                 if ( '.' != $folder )
2137                         $url .= '/' . ltrim($folder, '/');
2138         }
2139
2140         if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
2141                 $url .= '/' . ltrim($path, '/');
2142
2143         return apply_filters('plugins_url', $url, $path, $plugin);
2144 }
2145
2146 /**
2147  * Retrieve the site url for the current network.
2148  *
2149  * Returns the site url with the appropriate protocol,  'https' if
2150  * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2151  * overridden.
2152  *
2153  * @package WordPress
2154  * @since 3.0.0
2155  *
2156  * @param string $path Optional. Path relative to the site url.
2157  * @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
2158  * @return string Site url link with optional path appended.
2159 */
2160 function network_site_url( $path = '', $scheme = null ) {
2161         global $current_site;
2162
2163         if ( !is_multisite() )
2164                 return site_url($path, $scheme);
2165
2166         $orig_scheme = $scheme;
2167         if ( !in_array($scheme, array('http', 'https')) ) {
2168                 if ( ( 'login_post' == $scheme || 'rpc' == $scheme ) && ( force_ssl_login() || force_ssl_admin() ) )
2169                         $scheme = 'https';
2170                 elseif ( ('login' == $scheme) && ( force_ssl_admin() ) )
2171                         $scheme = 'https';
2172                 elseif ( ('admin' == $scheme) && force_ssl_admin() )
2173                         $scheme = 'https';
2174                 else
2175                         $scheme = ( is_ssl() ? 'https' : 'http' );
2176         }
2177
2178         $url = $scheme . '://' . $current_site->domain . $current_site->path;
2179
2180         if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
2181                 $url .= ltrim($path, '/');
2182
2183         return apply_filters('network_site_url', $url, $path, $orig_scheme);
2184 }
2185
2186 /**
2187  * Retrieve the home url for the current network.
2188  *
2189  * Returns the home url with the appropriate protocol,  'https' if
2190  * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2191  * overridden.
2192  *
2193  * @package WordPress
2194  * @since 3.0.0
2195  *
2196  * @param  string $path   (optional) Path relative to the home url.
2197  * @param  string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
2198  * @return string Home url link with optional path appended.
2199 */
2200 function network_home_url( $path = '', $scheme = null ) {
2201         global $current_site;
2202
2203         if ( !is_multisite() )
2204                 return home_url($path, $scheme);
2205
2206         $orig_scheme = $scheme;
2207
2208         if ( !in_array($scheme, array('http', 'https')) )
2209                 $scheme = is_ssl() && !is_admin() ? 'https' : 'http';
2210
2211         $url = $scheme . '://' . $current_site->domain . $current_site->path;
2212
2213         if ( !empty( $path ) && is_string( $path ) && strpos( $path, '..' ) === false )
2214                 $url .= ltrim( $path, '/' );
2215
2216         return apply_filters( 'network_home_url', $url, $path, $orig_scheme);
2217 }
2218
2219 /**
2220  * Retrieve the url to the admin area for the network.
2221  *
2222  * @package WordPress
2223  * @since 3.0.0
2224  *
2225  * @param string $path Optional path relative to the admin url
2226  * @param 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.
2227  * @return string Admin url link with optional path appended
2228 */
2229 function network_admin_url( $path = '', $scheme = 'admin' ) {
2230         if ( ! is_multisite() )
2231                 return admin_url( $path, $scheme );
2232
2233         $url = network_site_url('wp-admin/network/', $scheme);
2234
2235         if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
2236                 $url .= ltrim($path, '/');
2237
2238         return apply_filters('network_admin_url', $url, $path);
2239 }
2240
2241 /**
2242  * Retrieve the url to the admin area for the current user.
2243  *
2244  * @package WordPress
2245  * @since 3.0.0
2246  *
2247  * @param string $path Optional path relative to the admin url
2248  * @param 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.
2249  * @return string Admin url link with optional path appended
2250 */
2251 function user_admin_url( $path = '', $scheme = 'admin' ) {
2252         $url = network_site_url('wp-admin/user/', $scheme);
2253
2254         if ( !empty($path) && is_string($path) && strpos($path, '..') === false )
2255                 $url .= ltrim($path, '/');
2256
2257         return apply_filters('user_admin_url', $url, $path);
2258 }
2259
2260 /**
2261  * Retrieve the url to the admin area for either the current blog or the network depending on context.
2262  *
2263  * @package WordPress
2264  * @since 3.1.0
2265  *
2266  * @param string $path Optional path relative to the admin url
2267  * @param 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.
2268  * @return string Admin url link with optional path appended
2269 */
2270 function self_admin_url($path = '', $scheme = 'admin') {
2271         if ( is_network_admin() )
2272                 return network_admin_url($path, $scheme);
2273         elseif ( is_user_admin() )
2274                 return user_admin_url($path, $scheme);
2275         else
2276                 return admin_url($path, $scheme);
2277 }
2278
2279 /**
2280  * Get the URL to the user's dashboard.
2281  *
2282  * If a user does not belong to any sites, the global user dashboard is used.  If the user belongs to the current site,
2283  * the dashboard for the current site is returned.  If the user cannot edit the current site, the dashboard to the user's
2284  * primary blog is returned.
2285  *
2286  * @since 3.1.0
2287  *
2288  * @param int $user_id User ID
2289  * @param string $path Optional path relative to the dashboard.  Use only paths known to both blog and user admins.
2290  * @param 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.
2291  * @return string Dashboard url link with optional path appended
2292  */
2293 function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) {
2294         $user_id = (int) $user_id;
2295
2296         $blogs = get_blogs_of_user( $user_id );
2297         if ( empty($blogs) ) {
2298                 $url = user_admin_url( $path, $scheme );
2299         } elseif ( ! is_multisite() ) {
2300                 $url = admin_url( $path, $scheme );
2301         } else {
2302                 $current_blog = get_current_blog_id();
2303                 if ( $current_blog  && in_array($current_blog, array_keys($blogs)) ) {
2304                         $url = admin_url( $path, $scheme );
2305                 } else {
2306                         $active = get_active_blog_for_user( $user_id );
2307                         if ( $active )
2308                                 $url = get_admin_url( $active->blog_id, $path, $scheme );
2309                         else
2310                                 $url = user_admin_url( $path, $scheme );
2311                 }
2312         }
2313
2314         return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme);
2315 }
2316
2317 /**
2318  * Get the URL to the user's profile editor.
2319  *
2320  * @since 3.1.0
2321  *
2322  * @param int $user User ID
2323  * @param 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.
2324  * @return string Dashboard url link with optional path appended
2325  */
2326 function get_edit_profile_url( $user, $scheme = 'admin' ) {
2327         $user = (int) $user;
2328
2329         if ( is_user_admin() )
2330                 $url = user_admin_url( 'profile.php', $scheme );
2331         elseif ( is_network_admin() )
2332                 $url = network_admin_url( 'profile.php', $scheme );
2333         else
2334                 $url = get_dashboard_url( $user, 'profile.php', $scheme );
2335
2336         return apply_filters( 'edit_profile_url', $url, $user, $scheme);
2337 }
2338
2339 /**
2340  * Output rel=canonical for singular queries
2341  *
2342  * @package WordPress
2343  * @since 2.9.0
2344 */
2345 function rel_canonical() {
2346         if ( !is_singular() )
2347                 return;
2348
2349         global $wp_the_query;
2350         if ( !$id = $wp_the_query->get_queried_object_id() )
2351                 return;
2352
2353         $link = get_permalink( $id );
2354         echo "<link rel='canonical' href='$link' />\n";
2355 }
2356
2357 /**
2358  * Return a shortlink for a post, page, attachment, or blog.
2359  *
2360  * This function exists to provide a shortlink tag that all themes and plugins can target.  A plugin must hook in to
2361  * provide the actual shortlinks.  Default shortlink support is limited to providing ?p= style links for posts.
2362  * Plugins can short circuit this function via the pre_get_shortlink filter or filter the output
2363  * via the get_shortlink filter.
2364  *
2365  * @since 3.0.0.
2366  *
2367  * @param int $id A post or blog id.  Default is 0, which means the current post or blog.
2368  * @param 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'.
2369  * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
2370  * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
2371  */
2372 function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
2373         // Allow plugins to short-circuit this function.
2374         $shortlink = apply_filters('pre_get_shortlink', false, $id, $context, $allow_slugs);
2375         if ( false !== $shortlink )
2376                 return $shortlink;
2377
2378         global $wp_query;
2379         $post_id = 0;
2380         if ( 'query' == $context && is_single() ) {
2381                 $post_id = $wp_query->get_queried_object_id();
2382         } elseif ( 'post' == $context ) {
2383                 $post = get_post($id);
2384                 $post_id = $post->ID;
2385         }
2386
2387         $shortlink = '';
2388
2389         // Return p= link for posts.
2390         if ( !empty($post_id) && '' != get_option('permalink_structure') ) {
2391                 $post = get_post($post_id);
2392                 if ( isset($post->post_type) && 'post' == $post->post_type )
2393                         $shortlink = home_url('?p=' . $post->ID);
2394         }
2395
2396         return apply_filters('get_shortlink', $shortlink, $id, $context, $allow_slugs);
2397 }
2398
2399 /**
2400  *  Inject rel=sortlink into head if a shortlink is defined for the current page.
2401  *
2402  *  Attached to the wp_head action.
2403  *
2404  * @since 3.0.0
2405  *
2406  * @uses wp_get_shortlink()
2407  */
2408 function wp_shortlink_wp_head() {
2409         $shortlink = wp_get_shortlink( 0, 'query' );
2410
2411         if ( empty( $shortlink ) )
2412                 return;
2413
2414         echo "<link rel='shortlink' href='" . esc_url_raw( $shortlink ) . "' />\n";
2415 }
2416
2417 /**
2418  * Send a Link: rel=shortlink header if a shortlink is defined for the current page.
2419  *
2420  * Attached to the wp action.
2421  *
2422  * @since 3.0.0
2423  *
2424  * @uses wp_get_shortlink()
2425  */
2426 function wp_shortlink_header() {
2427         if ( headers_sent() )
2428                 return;
2429
2430         $shortlink = wp_get_shortlink(0, 'query');
2431
2432         if ( empty($shortlink) )
2433                 return;
2434
2435         header('Link: <' . $shortlink . '>; rel=shortlink', false);
2436 }
2437
2438 /**
2439  * Display the Short Link for a Post
2440  *
2441  * Must be called from inside "The Loop"
2442  *
2443  * Call like the_shortlink(__('Shortlinkage FTW'))
2444  *
2445  * @since 3.0.0
2446  *
2447  * @param string $text Optional The link text or HTML to be displayed.  Defaults to 'This is the short link.'
2448  * @param string $title Optional The tooltip for the link.  Must be sanitized.  Defaults to the sanitized post title.
2449  * @param string $before Optional HTML to display before the link.
2450  * @param string $before Optional HTML to display after the link.
2451  */
2452 function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
2453         global $post;
2454
2455         if ( empty( $text ) )
2456                 $text = __('This is the short link.');
2457
2458         if ( empty( $title ) )
2459                 $title = the_title_attribute( array( 'echo' => FALSE ) );
2460
2461         $shortlink = wp_get_shortlink( $post->ID );
2462
2463         if ( !empty( $shortlink ) ) {
2464                 $link = '<a rel="shortlink" href="' . esc_url( $shortlink ) . '" title="' . $title . '">' . $text . '</a>';
2465                 $link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title );
2466                 echo $before, $link, $after;
2467         }
2468 }
2469
2470 ?>