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