WordPress.org
Get WordPress

Make WordPress Core

Ticket #29050: link-template.php

File link-template.php, 93.3 KB (added by crantron, 12 years ago)

The altered link-template.php file

Line 
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 */
14function the_permalink() {
15 /**
16 * Filter the display of the permalink for the current post.
17 *
18 * @since 1.5.0
19 *
20 * @param string $permalink The permalink for the current post.
21 */
22 echo esc_url( apply_filters( 'the_permalink', get_permalink() ) );
23}
24
25/**
26 * Retrieve trailing slash string, if blog set for adding trailing slashes.
27 *
28 * Conditionally adds a trailing slash if the permalink structure has a trailing
29 * slash, strips the trailing slash if not. The string is passed through the
30 * 'user_trailingslashit' filter. Will remove trailing slash from string, if
31 * blog is not set to have them.
32 *
33 * @since 2.2.0
34 * @uses $wp_rewrite
35 *
36 * @param string $string URL with or without a trailing slash.
37 * @param string $type_of_url The type of URL being considered (e.g. single, category, etc) for use in the filter.
38 * @return string
39 */
40function user_trailingslashit($string, $type_of_url = '') {
41 global $wp_rewrite;
42 if ( $wp_rewrite->use_trailing_slashes )
43 $string = trailingslashit($string);
44 else
45 $string = untrailingslashit($string);
46
47 /**
48 * Filter the trailing slashed string, depending on whether the site is set
49 * to use training slashes.
50 *
51 * @since 2.2.0
52 *
53 * @param string $string URL with or without a trailing slash.
54 * @param string $type_of_url The type of URL being considered. Accepts 'single', 'single_trackback',
55 * 'single_feed', 'single_paged', 'feed', 'category', 'page', 'year',
56 * 'month', 'day', 'paged', 'post_type_archive'.
57 */
58 $string = apply_filters( 'user_trailingslashit', $string, $type_of_url );
59 return $string;
60}
61
62/**
63 * Display permalink anchor for current post.
64 *
65 * The permalink mode title will use the post title for the 'a' element 'id'
66 * attribute. The id mode uses 'post-' with the post ID for the 'id' attribute.
67 *
68 * @since 0.71
69 *
70 * @param string $mode Permalink mode can be either 'title', 'id', or default, which is 'id'.
71 */
72function permalink_anchor( $mode = 'id' ) {
73 $post = get_post();
74 switch ( strtolower( $mode ) ) {
75 case 'title':
76 $title = sanitize_title( $post->post_title ) . '-' . $post->ID;
77 echo '<a id="'.$title.'"></a>';
78 break;
79 case 'id':
80 default:
81 echo '<a id="post-' . $post->ID . '"></a>';
82 break;
83 }
84}
85
86/**
87 * Retrieve full permalink for current post or post ID.
88 *
89 * This function is an alias for get_permalink().
90 *
91 * @since 3.9.0
92 *
93 * @see get_permalink()
94 *
95 * @param int|WP_Post $id Optional. Post ID or post object. Default is the current post.
96 * @param bool $leavename Optional. Whether to keep post name or page name. Default false.
97 * @return string|bool The permalink URL or false if post does not exist.
98 */
99function get_the_permalink( $id = 0, $leavename = false ) {
100 return get_permalink( $id, $leavename );
101}
102
103/**
104 * Retrieve full permalink for current post or post ID.
105 *
106 * @since 1.0.0
107 *
108 * @param int|WP_Post $id Optional. Post ID or post object. Default current post.
109 * @param bool $leavename Optional. Whether to keep post name or page name. Default false.
110 * @return string|bool The permalink URL or false if post does not exist.
111 */
112function get_permalink( $id = 0, $leavename = false ) {
113 $rewritecode = array(
114 '%year%',
115 '%monthnum%',
116 '%day%',
117 '%hour%',
118 '%minute%',
119 '%second%',
120 $leavename? '' : '%postname%',
121 '%post_id%',
122 '%category%',
123 '%author%',
124 $leavename? '' : '%pagename%',
125 );
126
127 if ( is_object($id) && isset($id->filter) && 'sample' == $id->filter ) {
128 $post = $id;
129 $sample = true;
130 } else {
131 $post = get_post($id);
132 $sample = false;
133 }
134
135 if ( empty($post->ID) )
136 return false;
137
138 if ( $post->post_type == 'page' )
139 return get_page_link($post->ID, $leavename, $sample);
140 elseif ( $post->post_type == 'attachment' )
141 return get_attachment_link( $post->ID, $leavename );
142 elseif ( in_array($post->post_type, get_post_types( array('_builtin' => false) ) ) )
143 return get_post_permalink($post->ID, $leavename, $sample);
144
145 $permalink = get_option('permalink_structure');
146
147 /**
148 * Filter the permalink structure for a post before token replacement occurs.
149 *
150 * Only applies to posts with post_type of 'post'.
151 *
152 * @since 3.0.0
153 *
154 * @param string $permalink The site's permalink structure.
155 * @param WP_Post $post The post in question.
156 * @param bool $leavename Whether to keep the post name.
157 */
158 $permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename );
159
160 if ( '' != $permalink && !in_array($post->post_status, array('draft', 'pending', 'auto-draft')) ) {
161 $unixtime = strtotime($post->post_date);
162
163 $category = '';
164 if ( strpos($permalink, '%category%') !== false ) {
165 $cats = get_the_category($post->ID);
166 if ( $cats ) {
167 usort($cats, '_usort_terms_by_ID'); // order by ID
168
169 /**
170 * Filter the category that gets used in the %category% permalink token.
171 *
172 * @since 3.5.0
173 *
174 * @param stdClass $cat The category to use in the permalink.
175 * @param array $cats Array of all categories associated with the post.
176 * @param WP_Post $post The post in question.
177 */
178 $category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post );
179
180 $category_object = get_term( $category_object, 'category' );
181 $category = $category_object->slug;
182 if ( $parent = $category_object->parent )
183 $category = get_category_parents($parent, false, '/', true) . $category;
184 }
185 // show default category in permalinks, without
186 // having to assign it explicitly
187 if ( empty($category) ) {
188 $default_category = get_term( get_option( 'default_category' ), 'category' );
189 $category = is_wp_error( $default_category ) ? '' : $default_category->slug;
190 }
191 }
192
193 $author = '';
194 if ( strpos($permalink, '%author%') !== false ) {
195 $authordata = get_userdata($post->post_author);
196 $author = $authordata->user_nicename;
197 }
198
199 $date = explode(" ",date('Y m d H i s', $unixtime));
200 $rewritereplace =
201 array(
202 $date[0],
203 $date[1],
204 $date[2],
205 $date[3],
206 $date[4],
207 $date[5],
208 $post->post_name,
209 $post->ID,
210 $category,
211 $author,
212 $post->post_name,
213 );
214 $permalink = home_url( str_replace($rewritecode, $rewritereplace, $permalink) );
215 $permalink = user_trailingslashit($permalink, 'single');
216 } else { // if they're not using the fancy permalink option
217 $permalink = home_url('?p=' . $post->ID);
218 }
219
220 /**
221 * Filter the permalink for a post.
222 *
223 * Only applies to posts with post_type of 'post'.
224 *
225 * @since 1.5.0
226 *
227 * @param string $permalink The post's permalink.
228 * @param WP_Post $post The post in question.
229 * @param bool $leavename Whether to keep the post name.
230 */
231 return apply_filters( 'post_link', $permalink, $post, $leavename );
232}
233
234/**
235 * Retrieve the permalink for a post with a custom post type.
236 *
237 * @since 3.0.0
238 *
239 * @param int $id Optional. Post ID.
240 * @param bool $leavename Optional, defaults to false. Whether to keep post name.
241 * @param bool $sample Optional, defaults to false. Is it a sample permalink.
242 * @return string
243 */
244function get_post_permalink( $id = 0, $leavename = false, $sample = false ) {
245 global $wp_rewrite;
246
247 $post = get_post($id);
248
249 if ( is_wp_error( $post ) )
250 return $post;
251
252 $post_link = $wp_rewrite->get_extra_permastruct($post->post_type);
253
254 $slug = $post->post_name;
255
256 $draft_or_pending = isset($post->post_status) && in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
257
258 $post_type = get_post_type_object($post->post_type);
259
260 if ( !empty($post_link) && ( !$draft_or_pending || $sample ) ) {
261 if ( ! $leavename ) {
262 if ( $post_type->hierarchical )
263 $slug = get_page_uri($id);
264 $post_link = str_replace("%$post->post_type%", $slug, $post_link);
265 }
266 $post_link = home_url( user_trailingslashit($post_link) );
267 } else {
268 if ( $post_type->query_var && ( isset($post->post_status) && !$draft_or_pending ) )
269 $post_link = add_query_arg($post_type->query_var, $slug, '');
270 else
271 $post_link = add_query_arg(array('post_type' => $post->post_type, 'p' => $post->ID), '');
272 $post_link = home_url($post_link);
273 }
274
275 /**
276 * Filter the permalink for a post with a custom post type.
277 *
278 * @since 3.0.0
279 *
280 * @param string $post_link The post's permalink.
281 * @param WP_Post $post The post in question.
282 * @param bool $leavename Whether to keep the post name.
283 * @param bool $sample Is it a sample permalink.
284 */
285 return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample );
286}
287
288/**
289 * Retrieve permalink from post ID.
290 *
291 * @since 1.0.0
292 *
293 * @param int $post_id Optional. Post ID.
294 * @param mixed $deprecated Not used.
295 * @return string
296 */
297function post_permalink( $post_id = 0, $deprecated = '' ) {
298 if ( !empty( $deprecated ) )
299 _deprecated_argument( __FUNCTION__, '1.3' );
300
301 return get_permalink($post_id);
302}
303
304/**
305 * Retrieve the permalink for current page or page ID.
306 *
307 * Respects page_on_front. Use this one.
308 *
309 * @since 1.5.0
310 *
311 * @param int|object $post Optional. Post ID or object.
312 * @param bool $leavename Optional, defaults to false. Whether to keep page name.
313 * @param bool $sample Optional, defaults to false. Is it a sample permalink.
314 * @return string
315 */
316function get_page_link( $post = false, $leavename = false, $sample = false ) {
317 $post = get_post( $post );
318
319 if ( 'page' == get_option( 'show_on_front' ) && $post->ID == get_option( 'page_on_front' ) )
320 $link = home_url('/');
321 else
322 $link = _get_page_link( $post, $leavename, $sample );
323
324 /**
325 * Filter the permalink for a page.
326 *
327 * @since 1.5.0
328 *
329 * @param string $link The page's permalink.
330 * @param int $post_id The ID of the page.
331 * @param bool $sample Is it a sample permalink.
332 */
333 return apply_filters( 'page_link', $link, $post->ID, $sample );
334}
335
336/**
337 * Retrieve the page permalink.
338 *
339 * Ignores page_on_front. Internal use only.
340 *
341 * @since 2.1.0
342 * @access private
343 *
344 * @param int|object $post Optional. Post ID or object.
345 * @param bool $leavename Optional. Leave name.
346 * @param bool $sample Optional. Sample permalink.
347 * @return string
348 */
349function _get_page_link( $post = false, $leavename = false, $sample = false ) {
350 global $wp_rewrite;
351
352 $post = get_post( $post );
353
354 $draft_or_pending = in_array( $post->post_status, array( 'draft', 'pending', 'auto-draft' ) );
355
356 $link = $wp_rewrite->get_page_permastruct();
357
358 if ( !empty($link) && ( ( isset($post->post_status) && !$draft_or_pending ) || $sample ) ) {
359 if ( ! $leavename ) {
360 $link = str_replace('%pagename%', get_page_uri( $post ), $link);
361 }
362
363 $link = home_url($link);
364 $link = user_trailingslashit($link, 'page');
365 } else {
366 $link = home_url( '?page_id=' . $post->ID );
367 }
368
369 /**
370 * Filter the permalink for a non-page_on_front page.
371 *
372 * @since 2.1.0
373 *
374 * @param string $link The page's permalink.
375 * @param int $post_id The ID of the page.
376 */
377 return apply_filters( '_get_page_link', $link, $post->ID );
378}
379
380/**
381 * Retrieve permalink for attachment.
382 *
383 * This can be used in the WordPress Loop or outside of it.
384 *
385 * @since 2.0.0
386 *
387 * @param int|object $post Optional. Post ID or object.
388 * @param bool $leavename Optional. Leave name.
389 * @return string
390 */
391function get_attachment_link( $post = null, $leavename = false ) {
392 global $wp_rewrite;
393
394 $link = false;
395
396 $post = get_post( $post );
397 $parent = ( $post->post_parent > 0 && $post->post_parent != $post->ID ) ? get_post( $post->post_parent ) : false;
398
399 if ( $wp_rewrite->using_permalinks() && $parent ) {
400 if ( 'page' == $parent->post_type )
401 $parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front
402 else
403 $parentlink = get_permalink( $post->post_parent );
404
405 if ( is_numeric($post->post_name) || false !== strpos(get_option('permalink_structure'), '%category%') )
406 $name = 'attachment/' . $post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker
407 else
408 $name = $post->post_name;
409
410 if ( strpos($parentlink, '?') === false )
411 $link = user_trailingslashit( trailingslashit($parentlink) . '%postname%' );
412
413 if ( ! $leavename )
414 $link = str_replace( '%postname%', $name, $link );
415 }
416
417 if ( ! $link )
418 $link = home_url( '/?attachment_id=' . $post->ID );
419
420 /**
421 * Filter the permalink for an attachment.
422 *
423 * @since 2.0.0
424 *
425 * @param string $link The attachment's permalink.
426 * @param int $post_id Attachment ID.
427 */
428 return apply_filters( 'attachment_link', $link, $post->ID );
429}
430
431/**
432 * Retrieve the permalink for the year archives.
433 *
434 * @since 1.5.0
435 *
436 * @param int|bool $year False for current year or year for permalink.
437 * @return string
438 */
439function get_year_link($year) {
440 global $wp_rewrite;
441 if ( !$year )
442 $year = gmdate('Y', current_time('timestamp'));
443 $yearlink = $wp_rewrite->get_year_permastruct();
444 if ( !empty($yearlink) ) {
445 $yearlink = str_replace('%year%', $year, $yearlink);
446 $yearlink = home_url( user_trailingslashit( $yearlink, 'year' ) );
447 } else {
448 $yearlink = home_url( '?m=' . $year );
449 }
450
451 /**
452 * Filter the year archive permalink.
453 *
454 * @since 1.5.0
455 *
456 * @param string $yearlink Permalink for the year archive.
457 * @param int $year Year for the archive.
458 */
459 return apply_filters( 'year_link', $yearlink, $year );
460}
461
462/**
463 * Retrieve the permalink for the month archives with year.
464 *
465 * @since 1.0.0
466 *
467 * @param bool|int $year False for current year. Integer of year.
468 * @param bool|int $month False for current month. Integer of month.
469 * @return string
470 */
471function get_month_link($year, $month) {
472 global $wp_rewrite;
473 if ( !$year )
474 $year = gmdate('Y', current_time('timestamp'));
475 if ( !$month )
476 $month = gmdate('m', current_time('timestamp'));
477 $monthlink = $wp_rewrite->get_month_permastruct();
478 if ( !empty($monthlink) ) {
479 $monthlink = str_replace('%year%', $year, $monthlink);
480 $monthlink = str_replace('%monthnum%', zeroise(intval($month), 2), $monthlink);
481 $monthlink = home_url( user_trailingslashit( $monthlink, 'month' ) );
482 } else {
483 $monthlink = home_url( '?m=' . $year . zeroise( $month, 2 ) );
484 }
485
486 /**
487 * Filter the month archive permalink.
488 *
489 * @since 1.5.0
490 *
491 * @param string $monthlink Permalink for the month archive.
492 * @param int $year Year for the archive.
493 * @param int $month The month for the archive.
494 */
495 return apply_filters( 'month_link', $monthlink, $year, $month );
496}
497
498/**
499 * Retrieve the permalink for the day archives with year and month.
500 *
501 * @since 1.0.0
502 *
503 * @param bool|int $year False for current year. Integer of year.
504 * @param bool|int $month False for current month. Integer of month.
505 * @param bool|int $day False for current day. Integer of day.
506 * @return string
507 */
508function get_day_link($year, $month, $day) {
509 global $wp_rewrite;
510 if ( !$year )
511 $year = gmdate('Y', current_time('timestamp'));
512 if ( !$month )
513 $month = gmdate('m', current_time('timestamp'));
514 if ( !$day )
515 $day = gmdate('j', current_time('timestamp'));
516
517 $daylink = $wp_rewrite->get_day_permastruct();
518 if ( !empty($daylink) ) {
519 $daylink = str_replace('%year%', $year, $daylink);
520 $daylink = str_replace('%monthnum%', zeroise(intval($month), 2), $daylink);
521 $daylink = str_replace('%day%', zeroise(intval($day), 2), $daylink);
522 $daylink = home_url( user_trailingslashit( $daylink, 'day' ) );
523 } else {
524 $daylink = home_url( '?m=' . $year . zeroise( $month, 2 ) . zeroise( $day, 2 ) );
525 }
526
527 /**
528 * Filter the day archive permalink.
529 *
530 * @since 1.5.0
531 *
532 * @param string $daylink Permalink for the day archive.
533 * @param int $year Year for the archive.
534 * @param int $month Month for the archive.
535 * @param int $day The day for the archive.
536 */
537 return apply_filters( 'day_link', $daylink, $year, $month, $day );
538}
539
540/**
541 * Display the permalink for the feed type.
542 *
543 * @since 3.0.0
544 *
545 * @param string $anchor The link's anchor text.
546 * @param string $feed Optional, defaults to default feed. Feed type.
547 */
548function the_feed_link( $anchor, $feed = '' ) {
549 $link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>';
550
551 /**
552 * Filter the feed link anchor tag.
553 *
554 * @since 3.0.0
555 *
556 * @param string $link The complete anchor tag for a feed link.
557 * @param string $feed The feed type, or an empty string for the
558 * default feed type.
559 */
560 echo apply_filters( 'the_feed_link', $link, $feed );
561}
562
563/**
564 * Retrieve the permalink for the feed type.
565 *
566 * @since 1.5.0
567 *
568 * @param string $feed Optional, defaults to default feed. Feed type.
569 * @return string
570 */
571function get_feed_link($feed = '') {
572 global $wp_rewrite;
573
574 $permalink = $wp_rewrite->get_feed_permastruct();
575 if ( '' != $permalink ) {
576 if ( false !== strpos($feed, 'comments_') ) {
577 $feed = str_replace('comments_', '', $feed);
578 $permalink = $wp_rewrite->get_comment_feed_permastruct();
579 }
580
581 if ( get_default_feed() == $feed )
582 $feed = '';
583
584 $permalink = str_replace('%feed%', $feed, $permalink);
585 $permalink = preg_replace('#/+#', '/', "/$permalink");
586 $output = home_url( user_trailingslashit($permalink, 'feed') );
587 } else {
588 if ( empty($feed) )
589 $feed = get_default_feed();
590
591 if ( false !== strpos($feed, 'comments_') )
592 $feed = str_replace('comments_', 'comments-', $feed);
593
594 $output = home_url("?feed={$feed}");
595 }
596
597 /**
598 * Filter the feed type permalink.
599 *
600 * @since 1.5.0
601 *
602 * @param string $output The feed permalink.
603 * @param string $feed Feed type.
604 */
605 return apply_filters( 'feed_link', $output, $feed );
606}
607
608/**
609 * Retrieve the permalink for the post comments feed.
610 *
611 * @since 2.2.0
612 *
613 * @param int $post_id Optional. Post ID.
614 * @param string $feed Optional. Feed type.
615 * @return string
616 */
617function get_post_comments_feed_link($post_id = 0, $feed = '') {
618 $post_id = absint( $post_id );
619
620 if ( ! $post_id )
621 $post_id = get_the_ID();
622
623 if ( empty( $feed ) )
624 $feed = get_default_feed();
625
626 if ( '' != get_option('permalink_structure') ) {
627 if ( 'page' == get_option('show_on_front') && $post_id == get_option('page_on_front') )
628 $url = _get_page_link( $post_id );
629 else
630 $url = get_permalink($post_id);
631
632 $url = trailingslashit($url) . 'feed';
633 if ( $feed != get_default_feed() )
634 $url .= "/$feed";
635 $url = user_trailingslashit($url, 'single_feed');
636 } else {
637 $type = get_post_field('post_type', $post_id);
638 if ( 'page' == $type )
639 $url = add_query_arg( array( 'feed' => $feed, 'page_id' => $post_id ), home_url( '/' ) );
640 else
641 $url = add_query_arg( array( 'feed' => $feed, 'p' => $post_id ), home_url( '/' ) );
642 }
643
644 /**
645 * Filter the post comments feed permalink.
646 *
647 * @since 1.5.1
648 *
649 * @param string $url Post comments feed permalink.
650 */
651 return apply_filters( 'post_comments_feed_link', $url );
652}
653
654/**
655 * Display the comment feed link for a post.
656 *
657 * Prints out the comment feed link for a post. Link text is placed in the
658 * anchor. If no link text is specified, default text is used. If no post ID is
659 * specified, the current post is used.
660 *
661 * @since 2.5.0
662 *
663 * @param string $link_text Descriptive text.
664 * @param int $post_id Optional post ID. Default to current post.
665 * @param string $feed Optional. Feed format.
666 * @return string Link to the comment feed for the current post.
667*/
668function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) {
669 $url = esc_url( get_post_comments_feed_link( $post_id, $feed ) );
670 if ( empty($link_text) )
671 $link_text = __('Comments Feed');
672
673 /**
674 * Filter the post comment feed link anchor tag.
675 *
676 * @since 2.8.0
677 *
678 * @param string $link The complete anchor tag for the comment feed link.
679 * @param int $post_id Post ID.
680 * @param string $feed The feed type, or an empty string for the default feed type.
681 */
682 echo apply_filters( 'post_comments_feed_link_html', "<a href='$url'>$link_text</a>", $post_id, $feed );
683}
684
685/**
686 * Retrieve the feed link for a given author.
687 *
688 * Returns a link to the feed for all posts by a given author. A specific feed
689 * can be requested or left blank to get the default feed.
690 *
691 * @since 2.5.0
692 *
693 * @param int $author_id ID of an author.
694 * @param string $feed Optional. Feed type.
695 * @return string Link to the feed for the author specified by $author_id.
696*/
697function get_author_feed_link( $author_id, $feed = '' ) {
698 $author_id = (int) $author_id;
699 $permalink_structure = get_option('permalink_structure');
700
701 if ( empty($feed) )
702 $feed = get_default_feed();
703
704 if ( '' == $permalink_structure ) {
705 $link = home_url("?feed=$feed&amp;author=" . $author_id);
706 } else {
707 $link = get_author_posts_url($author_id);
708 if ( $feed == get_default_feed() )
709 $feed_link = 'feed';
710 else
711 $feed_link = "feed/$feed";
712
713 $link = trailingslashit($link) . user_trailingslashit($feed_link, 'feed');
714 }
715
716 /**
717 * Filter the feed link for a given author.
718 *
719 * @since 1.5.1
720 *
721 * @param string $link The author feed link.
722 * @param string $feed Feed type.
723 */
724 $link = apply_filters( 'author_feed_link', $link, $feed );
725
726 return $link;
727}
728
729/**
730 * Retrieve the feed link for a category.
731 *
732 * Returns a link to the feed for all posts in a given category. A specific feed
733 * can be requested or left blank to get the default feed.
734 *
735 * @since 2.5.0
736 *
737 * @param int $cat_id ID of a category.
738 * @param string $feed Optional. Feed type.
739 * @return string Link to the feed for the category specified by $cat_id.
740*/
741function get_category_feed_link($cat_id, $feed = '') {
742 return get_term_feed_link($cat_id, 'category', $feed);
743}
744
745/**
746 * Retrieve the feed link for a term.
747 *
748 * Returns a link to the feed for all posts in a given term. A specific feed
749 * can be requested or left blank to get the default feed.
750 *
751 * @since 3.0.0
752 *
753 * @param int $term_id ID of a category.
754 * @param string $taxonomy Optional. Taxonomy of $term_id
755 * @param string $feed Optional. Feed type.
756 * @return string Link to the feed for the term specified by $term_id and $taxonomy.
757*/
758function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
759 $term_id = ( int ) $term_id;
760
761 $term = get_term( $term_id, $taxonomy );
762
763 if ( empty( $term ) || is_wp_error( $term ) )
764 return false;
765
766 if ( empty( $feed ) )
767 $feed = get_default_feed();
768
769 $permalink_structure = get_option( 'permalink_structure' );
770
771 if ( '' == $permalink_structure ) {
772 if ( 'category' == $taxonomy ) {
773 $link = home_url("?feed=$feed&amp;cat=$term_id");
774 }
775 elseif ( 'post_tag' == $taxonomy ) {
776 $link = home_url("?feed=$feed&amp;tag=$term->slug");
777 } else {
778 $t = get_taxonomy( $taxonomy );
779 $link = home_url("?feed=$feed&amp;$t->query_var=$term->slug");
780 }
781 } else {
782 $link = get_term_link( $term_id, $term->taxonomy );
783 if ( $feed == get_default_feed() )
784 $feed_link = 'feed';
785 else
786 $feed_link = "feed/$feed";
787
788 $link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' );
789 }
790
791 if ( 'category' == $taxonomy ) {
792 /**
793 * Filter the category feed link.
794 *
795 * @since 1.5.1
796 *
797 * @param string $link The category feed link.
798 * @param string $feed Feed type.
799 */
800 $link = apply_filters( 'category_feed_link', $link, $feed );
801 } elseif ( 'post_tag' == $taxonomy ) {
802 /**
803 * Filter the post tag feed link.
804 *
805 * @since 2.3.0
806 *
807 * @param string $link The tag feed link.
808 * @param string $feed Feed type.
809 */
810 $link = apply_filters( 'tag_feed_link', $link, $feed );
811 } else {
812 /**
813 * Filter the feed link for a taxonomy other than 'category' or 'post_tag'.
814 *
815 * @since 3.0.0
816 *
817 * @param string $link The taxonomy feed link.
818 * @param string $feed Feed type.
819 * @param string $feed The taxonomy name.
820 */
821 $link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy );
822 }
823
824 return $link;
825}
826
827/**
828 * Retrieve permalink for feed of tag.
829 *
830 * @since 2.3.0
831 *
832 * @param int $tag_id Tag ID.
833 * @param string $feed Optional. Feed type.
834 * @return string
835 */
836function get_tag_feed_link($tag_id, $feed = '') {
837 return get_term_feed_link($tag_id, 'post_tag', $feed);
838}
839
840/**
841 * Retrieve edit tag link.
842 *
843 * @since 2.7.0
844 *
845 * @param int $tag_id Tag ID
846 * @param string $taxonomy Taxonomy
847 * @return string
848 */
849function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
850 /**
851 * Filter the edit link for a tag (or term in another taxonomy).
852 *
853 * @since 2.7.0
854 *
855 * @param string $link The term edit link.
856 */
857 return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag_id, $taxonomy ) );
858}
859
860/**
861 * Display or retrieve edit tag link with formatting.
862 *
863 * @since 2.7.0
864 *
865 * @param string $link Optional. Anchor text.
866 * @param string $before Optional. Display before edit link.
867 * @param string $after Optional. Display after edit link.
868 * @param object $tag Tag object.
869 * @return string HTML content.
870 */
871function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) {
872 $link = edit_term_link( $link, '', '', $tag, false );
873
874 /**
875 * Filter the anchor tag for the edit link for a tag (or term in another taxonomy).
876 *
877 * @since 2.7.0
878 *
879 * @param string $link The anchor tag for the edit link.
880 */
881 echo $before . apply_filters( 'edit_tag_link', $link ) . $after;
882}
883
884/**
885 * Retrieve edit term url.
886 *
887 * @since 3.1.0
888 *
889 * @param int $term_id Term ID
890 * @param string $taxonomy Taxonomy
891 * @param string $object_type The object type
892 * @return string
893 */
894function get_edit_term_link( $term_id, $taxonomy, $object_type = '' ) {
895 $tax = get_taxonomy( $taxonomy );
896 if ( !current_user_can( $tax->cap->edit_terms ) )
897 return;
898
899 $term = get_term( $term_id, $taxonomy );
900
901 $args = array(
902 'action' => 'edit',
903 'taxonomy' => $taxonomy,
904 'tag_ID' => $term->term_id,
905 );
906
907 if ( $object_type )
908 $args['post_type'] = $object_type;
909
910 $location = add_query_arg( $args, admin_url( 'edit-tags.php' ) );
911
912 /**
913 * Filter the edit link for a term.
914 *
915 * @since 3.1.0
916 *
917 * @param string $location The edit link.
918 * @param int $term_id Term ID.
919 * @param string $taxonomy Taxonomy name.
920 * @param string $object_type The object type (eg. the post type).
921 */
922 return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type );
923}
924
925/**
926 * Display or retrieve edit term link with formatting.
927 *
928 * @since 3.1.0
929 *
930 * @param string $link Optional. Anchor text.
931 * @param string $before Optional. Display before edit link.
932 * @param string $after Optional. Display after edit link.
933 * @param object $term Term object.
934 * @return string HTML content.
935 */
936function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
937 if ( is_null( $term ) )
938 $term = get_queried_object();
939
940 if ( ! $term )
941 return;
942
943 $tax = get_taxonomy( $term->taxonomy );
944 if ( ! current_user_can( $tax->cap->edit_terms ) )
945 return;
946
947 if ( empty( $link ) )
948 $link = __('Edit This');
949
950 $link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '">' . $link . '</a>';
951
952 /**
953 * Filter the anchor tag for the edit link of a term.
954 *
955 * @since 3.1.0
956 *
957 * @param string $link The anchor tag for the edit link.
958 * @param int $term_id Term ID.
959 */
960 $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after;
961
962 if ( $echo )
963 echo $link;
964 else
965 return $link;
966}
967
968/**
969 * Retrieve permalink for search.
970 *
971 * @since 3.0.0
972 *
973 * @param string $query Optional. The query string to use. If empty the current query is used.
974 * @return string
975 */
976function get_search_link( $query = '' ) {
977 global $wp_rewrite;
978
979 if ( empty($query) )
980 $search = get_search_query( false );
981 else
982 $search = stripslashes($query);
983
984 $permastruct = $wp_rewrite->get_search_permastruct();
985
986 if ( empty( $permastruct ) ) {
987 $link = home_url('?s=' . urlencode($search) );
988 } else {
989 $search = urlencode($search);
990 $search = str_replace('%2F', '/', $search); // %2F(/) is not valid within a URL, send it unencoded.
991 $link = str_replace( '%search%', $search, $permastruct );
992 $link = home_url( user_trailingslashit( $link, 'search' ) );
993 }
994
995 /**
996 * Filter the search permalink.
997 *
998 * @since 3.0.0
999 *
1000 * @param string $link Search permalink.
1001 * @param string $search The URL-encoded search term.
1002 */
1003 return apply_filters( 'search_link', $link, $search );
1004}
1005
1006/**
1007 * Retrieve the permalink for the feed of the search results.
1008 *
1009 * @since 2.5.0
1010 *
1011 * @param string $search_query Optional. Search query.
1012 * @param string $feed Optional. Feed type.
1013 * @return string
1014 */
1015function get_search_feed_link($search_query = '', $feed = '') {
1016 global $wp_rewrite;
1017 $link = get_search_link($search_query);
1018
1019 if ( empty($feed) )
1020 $feed = get_default_feed();
1021
1022 $permastruct = $wp_rewrite->get_search_permastruct();
1023
1024 if ( empty($permastruct) ) {
1025 $link = add_query_arg('feed', $feed, $link);
1026 } else {
1027 $link = trailingslashit($link);
1028 $link .= "feed/$feed/";
1029 }
1030
1031 /**
1032 * Filter the search feed link.
1033 *
1034 * @since 2.5.0
1035 *
1036 * @param string $link Search feed link.
1037 * @param string $feed Feed type.
1038 * @param string $type The search type. One of 'posts' or 'comments'.
1039 */
1040 $link = apply_filters( 'search_feed_link', $link, $feed, 'posts' );
1041
1042 return $link;
1043}
1044
1045/**
1046 * Retrieve the permalink for the comments feed of the search results.
1047 *
1048 * @since 2.5.0
1049 *
1050 * @param string $search_query Optional. Search query.
1051 * @param string $feed Optional. Feed type.
1052 * @return string
1053 */
1054function get_search_comments_feed_link($search_query = '', $feed = '') {
1055 global $wp_rewrite;
1056
1057 if ( empty($feed) )
1058 $feed = get_default_feed();
1059
1060 $link = get_search_feed_link($search_query, $feed);
1061
1062 $permastruct = $wp_rewrite->get_search_permastruct();
1063
1064 if ( empty($permastruct) )
1065 $link = add_query_arg('feed', 'comments-' . $feed, $link);
1066 else
1067 $link = add_query_arg('withcomments', 1, $link);
1068
1069 /** This filter is documented in wp-includes/link-template.php */
1070 $link = apply_filters('search_feed_link', $link, $feed, 'comments');
1071
1072 return $link;
1073}
1074
1075/**
1076 * Retrieve the permalink for a post type archive.
1077 *
1078 * @since 3.1.0
1079 *
1080 * @param string $post_type Post type
1081 * @return string
1082 */
1083function get_post_type_archive_link( $post_type ) {
1084 global $wp_rewrite;
1085 if ( ! $post_type_obj = get_post_type_object( $post_type ) )
1086 return false;
1087
1088 if ( ! $post_type_obj->has_archive )
1089 return false;
1090
1091 if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) ) {
1092 $struct = ( true === $post_type_obj->has_archive ) ? $post_type_obj->rewrite['slug'] : $post_type_obj->has_archive;
1093 if ( $post_type_obj->rewrite['with_front'] )
1094 $struct = $wp_rewrite->front . $struct;
1095 else
1096 $struct = $wp_rewrite->root . $struct;
1097 $link = home_url( user_trailingslashit( $struct, 'post_type_archive' ) );
1098 } else {
1099 $link = home_url( '?post_type=' . $post_type );
1100 }
1101
1102 /**
1103 * Filter the post type archive permalink.
1104 *
1105 * @since 3.1.0
1106 *
1107 * @param string $link The post type archive permalink.
1108 * @param string $post_type Post type name.
1109 */
1110 return apply_filters( 'post_type_archive_link', $link, $post_type );
1111}
1112
1113/**
1114 * Retrieve the permalink for a post type archive feed.
1115 *
1116 * @since 3.1.0
1117 *
1118 * @param string $post_type Post type
1119 * @param string $feed Optional. Feed type
1120 * @return string
1121 */
1122function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
1123 $default_feed = get_default_feed();
1124 if ( empty( $feed ) )
1125 $feed = $default_feed;
1126
1127 if ( ! $link = get_post_type_archive_link( $post_type ) )
1128 return false;
1129
1130 $post_type_obj = get_post_type_object( $post_type );
1131 if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) && $post_type_obj->rewrite['feeds'] ) {
1132 $link = trailingslashit( $link );
1133 $link .= 'feed/';
1134 if ( $feed != $default_feed )
1135 $link .= "$feed/";
1136 } else {
1137 $link = add_query_arg( 'feed', $feed, $link );
1138 }
1139
1140 /**
1141 * Filter the post type archive feed link.
1142 *
1143 * @since 3.1.0
1144 *
1145 * @param string $link The post type archive feed link.
1146 * @param string $feed Feed type.
1147 */
1148 return apply_filters( 'post_type_archive_feed_link', $link, $feed );
1149}
1150
1151/**
1152 * Retrieve edit posts link for post.
1153 *
1154 * Can be used within the WordPress loop or outside of it. Can be used with
1155 * pages, posts, attachments, and revisions.
1156 *
1157 * @since 2.3.0
1158 *
1159 * @param int $id Optional. Post ID.
1160 * @param string $context Optional, defaults to display. How to write the '&', defaults to '&amp;'.
1161 * @return string
1162 */
1163function get_edit_post_link( $id = 0, $context = 'display' ) {
1164 if ( ! $post = get_post( $id ) )
1165 return;
1166
1167 if ( 'revision' === $post->post_type )
1168 $action = '';
1169 elseif ( 'display' == $context )
1170 $action = '&amp;action=edit';
1171 else
1172 $action = '&action=edit';
1173
1174 $post_type_object = get_post_type_object( $post->post_type );
1175 if ( !$post_type_object )
1176 return;
1177
1178 if ( !current_user_can( 'edit_post', $post->ID ) )
1179 return;
1180
1181 /**
1182 * Filter the post edit link.
1183 *
1184 * @since 2.3.0
1185 *
1186 * @param string $link The edit link.
1187 * @param int $post_id Post ID.
1188 * @param string $context The link context. If set to 'display' then ampersands
1189 * are encoded.
1190 */
1191 return apply_filters( 'get_edit_post_link', admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) ), $post->ID, $context );
1192}
1193
1194/**
1195 * Display edit post link for post.
1196 *
1197 * @since 1.0.0
1198 *
1199 * @param string $link Optional. Anchor text.
1200 * @param string $before Optional. Display before edit link.
1201 * @param string $after Optional. Display after edit link.
1202 * @param int $id Optional. Post ID.
1203 */
1204function edit_post_link( $link = null, $before = '', $after = '', $id = 0 ) {
1205 if ( !$post = get_post( $id ) )
1206 return;
1207
1208 if ( !$url = get_edit_post_link( $post->ID ) )
1209 return;
1210
1211 if ( null === $link )
1212 $link = __('Edit This');
1213
1214 $post_type_obj = get_post_type_object( $post->post_type );
1215 $link = '<a class="post-edit-link" href="' . $url . '">' . $link . '</a>';
1216
1217 /**
1218 * Filter the post edit link anchor tag.
1219 *
1220 * @since 2.3.0
1221 *
1222 * @param string $link Anchor tag for the edit link.
1223 * @param int $post_id Post ID.
1224 */
1225 echo $before . apply_filters( 'edit_post_link', $link, $post->ID ) . $after;
1226}
1227
1228/**
1229 * Retrieve delete posts link for post.
1230 *
1231 * Can be used within the WordPress loop or outside of it, with any post type.
1232 *
1233 * @since 2.9.0
1234 *
1235 * @param int $id Optional. Post ID.
1236 * @param string $deprecated Not used.
1237 * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
1238 * @return string
1239 */
1240function get_delete_post_link( $id = 0, $deprecated = '', $force_delete = false ) {
1241 if ( ! empty( $deprecated ) )
1242 _deprecated_argument( __FUNCTION__, '3.0' );
1243
1244 if ( !$post = get_post( $id ) )
1245 return;
1246
1247 $post_type_object = get_post_type_object( $post->post_type );
1248 if ( !$post_type_object )
1249 return;
1250
1251 if ( !current_user_can( 'delete_post', $post->ID ) )
1252 return;
1253
1254 $action = ( $force_delete || !EMPTY_TRASH_DAYS ) ? 'delete' : 'trash';
1255
1256 $delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) );
1257
1258 /**
1259 * Filter the post delete link.
1260 *
1261 * @since 2.9.0
1262 *
1263 * @param string $link The delete link.
1264 * @param int $post_id Post ID.
1265 * @param bool $force_delete Whether to bypass the trash and force deletion. Default false.
1266 */
1267 return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-post_{$post->ID}" ), $post->ID, $force_delete );
1268}
1269
1270/**
1271 * Retrieve edit comment link.
1272 *
1273 * @since 2.3.0
1274 *
1275 * @param int $comment_id Optional. Comment ID.
1276 * @return string
1277 */
1278function get_edit_comment_link( $comment_id = 0 ) {
1279 $comment = get_comment( $comment_id );
1280
1281 if ( !current_user_can( 'edit_comment', $comment->comment_ID ) )
1282 return;
1283
1284 $location = admin_url('comment.php?action=editcomment&amp;c=') . $comment->comment_ID;
1285
1286 /**
1287 * Filter the comment edit link.
1288 *
1289 * @since 2.3.0
1290 *
1291 * @param string $location The edit link.
1292 */
1293 return apply_filters( 'get_edit_comment_link', $location );
1294}
1295
1296/**
1297 * Display edit comment link with formatting.
1298 *
1299 * @since 1.0.0
1300 *
1301 * @param string $link Optional. Anchor text.
1302 * @param string $before Optional. Display before edit link.
1303 * @param string $after Optional. Display after edit link.
1304 */
1305function edit_comment_link( $link = null, $before = '', $after = '' ) {
1306 global $comment;
1307
1308 if ( !current_user_can( 'edit_comment', $comment->comment_ID ) )
1309 return;
1310
1311 if ( null === $link )
1312 $link = __('Edit This');
1313
1314 $link = '<a class="comment-edit-link" href="' . get_edit_comment_link( $comment->comment_ID ) . '">' . $link . '</a>';
1315
1316 /**
1317 * Filter the comment edit link anchor tag.
1318 *
1319 * @since 2.3.0
1320 *
1321 * @param string $link Anchor tag for the edit link.
1322 * @param int $comment_id Comment ID.
1323 */
1324 echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID ) . $after;
1325}
1326
1327/**
1328 * Display edit bookmark (literally a URL external to blog) link.
1329 *
1330 * @since 2.7.0
1331 *
1332 * @param int $link Optional. Bookmark ID.
1333 * @return string
1334 */
1335function get_edit_bookmark_link( $link = 0 ) {
1336 $link = get_bookmark( $link );
1337
1338 if ( !current_user_can('manage_links') )
1339 return;
1340
1341 $location = admin_url('link.php?action=edit&amp;link_id=') . $link->link_id;
1342
1343 /**
1344 * Filter the bookmark (link) edit link.
1345 *
1346 * @since 2.7.0
1347 *
1348 * @param string $location The edit link.
1349 * @param int $link_id Bookmark ID.
1350 */
1351 return apply_filters( 'get_edit_bookmark_link', $location, $link->link_id );
1352}
1353
1354/**
1355 * Display edit bookmark (literally a URL external to blog) link anchor content.
1356 *
1357 * @since 2.7.0
1358 *
1359 * @param string $link Optional. Anchor text.
1360 * @param string $before Optional. Display before edit link.
1361 * @param string $after Optional. Display after edit link.
1362 * @param int $bookmark Optional. Bookmark ID.
1363 */
1364function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) {
1365 $bookmark = get_bookmark($bookmark);
1366
1367 if ( !current_user_can('manage_links') )
1368 return;
1369
1370 if ( empty($link) )
1371 $link = __('Edit This');
1372
1373 $link = '<a href="' . get_edit_bookmark_link( $bookmark ) . '">' . $link . '</a>';
1374
1375 /**
1376 * Filter the bookmark edit link anchor tag.
1377 *
1378 * @since 2.7.0
1379 *
1380 * @param string $link Anchor tag for the edit link.
1381 * @param int $link_id Bookmark ID.
1382 */
1383 echo $before . apply_filters( 'edit_bookmark_link', $link, $bookmark->link_id ) . $after;
1384}
1385
1386/**
1387 * Retrieve edit user link
1388 *
1389 * @since 3.5.0
1390 *
1391 * @param int $user_id Optional. User ID. Defaults to the current user.
1392 * @return string URL to edit user page or empty string.
1393 */
1394function get_edit_user_link( $user_id = null ) {
1395 if ( ! $user_id )
1396 $user_id = get_current_user_id();
1397
1398 if ( empty( $user_id ) || ! current_user_can( 'edit_user', $user_id ) )
1399 return '';
1400
1401 $user = get_userdata( $user_id );
1402
1403 if ( ! $user )
1404 return '';
1405
1406 if ( get_current_user_id() == $user->ID )
1407 $link = get_edit_profile_url( $user->ID );
1408 else
1409 $link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) );
1410
1411 /**
1412 * Filter the user edit link.
1413 *
1414 * @since 3.5.0
1415 *
1416 * @param string $link The edit link.
1417 * @param int $user_id User ID.
1418 */
1419 return apply_filters( 'get_edit_user_link', $link, $user->ID );
1420}
1421
1422// Navigation links
1423
1424/**
1425 * Retrieve previous post that is adjacent to current post.
1426 *
1427 * @since 1.5.0
1428 *
1429 * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term.
1430 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1431 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1432 * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
1433 */
1434function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
1435 return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy );
1436}
1437
1438/**
1439 * Retrieve next post that is adjacent to current post.
1440 *
1441 * @since 1.5.0
1442 *
1443 * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term.
1444 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1445 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1446 * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
1447 */
1448function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
1449 return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy );
1450}
1451
1452/**
1453 * Retrieve adjacent post.
1454 *
1455 * Can either be next or previous post.
1456 *
1457 * @since 2.5.0
1458 *
1459 * @param bool $in_same_term Optional. Whether post should be in a same taxonomy term.
1460 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1461 * @param bool $previous Optional. Whether to retrieve previous post.
1462 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1463 * @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
1464 */
1465function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
1466 global $wpdb;
1467
1468 if ( ( ! $post = get_post() ) || ! taxonomy_exists( $taxonomy ) )
1469 return null;
1470
1471 $current_post_date = $post->post_date;
1472
1473 $join = '';
1474 $posts_in_ex_terms_sql = '';
1475 if ( $in_same_term || ! empty( $excluded_terms ) ) {
1476 $join = "
1477 INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id
1478 INNER JOIN $wpdb->term_taxonomy tt ON tr.term_taxonomy_id = tt.term_taxonomy_id
1479 ";
1480
1481 if ( $in_same_term ) {
1482 if ( ! is_object_in_taxonomy( $post->post_type, $taxonomy ) )
1483 return '';
1484 $term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) );
1485 if ( ! $term_array || is_wp_error( $term_array ) )
1486 return '';
1487 $join .= $wpdb->prepare( " AND tt.taxonomy = %s AND tt.term_id IN (" . implode( ',', array_map( 'intval', $term_array ) ) . ")", $taxonomy );
1488 }
1489
1490 $posts_in_ex_terms_sql = $wpdb->prepare( "AND tt.taxonomy = %s", $taxonomy );
1491 if ( ! empty( $excluded_terms ) ) {
1492 if ( ! is_array( $excluded_terms ) ) {
1493 // back-compat, $excluded_terms used to be $excluded_terms with IDs separated by " and "
1494 if ( false !== strpos( $excluded_terms, ' and ' ) ) {
1495 _deprecated_argument( __FUNCTION__, '3.3', sprintf( __( 'Use commas instead of %s to separate excluded terms.' ), "'and'" ) );
1496 $excluded_terms = explode( ' and ', $excluded_terms );
1497 } else {
1498 $excluded_terms = explode( ',', $excluded_terms );
1499 }
1500 }
1501
1502 $excluded_terms = array_map( 'intval', $excluded_terms );
1503
1504 if ( ! empty( $term_array ) ) {
1505 $excluded_terms = array_diff( $excluded_terms, $term_array );
1506 $posts_in_ex_terms_sql = '';
1507 }
1508
1509 if ( ! empty( $excluded_terms ) ) {
1510 $posts_in_ex_terms_sql = $wpdb->prepare( " AND tt.taxonomy = %s AND tt.term_id NOT IN (" . implode( $excluded_terms, ',' ) . ')', $taxonomy );
1511 }
1512 }
1513 }
1514
1515 $adjacent = $previous ? 'previous' : 'next';
1516 $op = $previous ? '<' : '>';
1517 $order = $previous ? 'DESC' : 'ASC';
1518
1519 /**
1520 * Filter the JOIN clause in the SQL for an adjacent post query.
1521 *
1522 * The dynamic portion of the hook name, $adjacent, refers to the type
1523 * of adjacency, 'next' or 'previous'.
1524 *
1525 * @since 2.5.0
1526 *
1527 * @param string $join The JOIN clause in the SQL.
1528 * @param bool $in_same_term Whether post should be in a same taxonomy term.
1529 * @param array $excluded_terms Array of excluded term IDs.
1530 */
1531 $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms );
1532
1533 /**
1534 * Filter the WHERE clause in the SQL for an adjacent post query.
1535 *
1536 * The dynamic portion of the hook name, $adjacent, refers to the type
1537 * of adjacency, 'next' or 'previous'.
1538 *
1539 * @since 2.5.0
1540 *
1541 * @param string $where The WHERE clause in the SQL.
1542 * @param bool $in_same_term Whether post should be in a same taxonomy term.
1543 * @param array $excluded_terms Array of excluded term IDs.
1544 */
1545 $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_terms_sql", $current_post_date, $post->post_type), $in_same_term, $excluded_terms );
1546
1547 /**
1548 * Filter the ORDER BY clause in the SQL for an adjacent post query.
1549 *
1550 * The dynamic portion of the hook name, $adjacent, refers to the type
1551 * of adjacency, 'next' or 'previous'.
1552 *
1553 * @since 2.5.0
1554 *
1555 * @param string $order_by The ORDER BY clause in the SQL.
1556 */
1557 $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order " );
1558
1559 $query = "SELECT * FROM $wpdb->posts AS p $join $where $sort LIMIT 1";
1560
1561 $query_key = 'adjacent_post_' . md5( $query );
1562 $result = wp_cache_get( $query_key, 'counts' );
1563
1564
1565
1566 if ( false !== $result ) {
1567 if ( $result )
1568 $result = get_post( $result );
1569 return $result;
1570 }
1571
1572 $result = $wpdb->get_var( $query );
1573 if ( null === $result )
1574 $result = '';
1575
1576 wp_cache_set( $query_key, $result, 'counts' );
1577
1578 if ( $result )
1579 $result = get_post( $result );
1580
1581
1582 return $result;
1583}
1584
1585/**
1586 * Get adjacent post relational link.
1587 *
1588 * Can either be next or previous post relational link.
1589 *
1590 * @since 2.8.0
1591 *
1592 * @param string $title Optional. Link title format.
1593 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1594 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1595 * @param bool $previous Optional. Whether to display link to previous or next post. Default true.
1596 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1597 * @return string
1598 */
1599function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
1600 if ( $previous && is_attachment() && $post = get_post() )
1601 $post = get_post( $post->post_parent );
1602 else
1603 $post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy );
1604
1605 if ( empty( $post ) )
1606 return;
1607
1608 $post_title = the_title_attribute( array( 'echo' => false, 'post' => $post ) );
1609
1610 if ( empty( $post_title ) )
1611 $post_title = $previous ? __( 'Previous Post' ) : __( 'Next Post' );
1612
1613 $date = mysql2date( get_option( 'date_format' ), $post->post_date );
1614
1615 $title = str_replace( '%title', $post_title, $title );
1616 $title = str_replace( '%date', $date, $title );
1617
1618 $link = $previous ? "<link rel='prev' title='" : "<link rel='next' title='";
1619 $link .= esc_attr( $title );
1620 $link .= "' href='" . get_permalink( $post ) . "' />\n";
1621
1622 $adjacent = $previous ? 'previous' : 'next';
1623
1624 /**
1625 * Filter the adjacent post relational link.
1626 *
1627 * The dynamic portion of the hook name, $adjacent, refers to the type
1628 * of adjacency, 'next' or 'previous'.
1629 *
1630 * @since 2.8.0
1631 *
1632 * @param string $link The relational link.
1633 */
1634 return apply_filters( "{$adjacent}_post_rel_link", $link );
1635}
1636
1637/**
1638 * Display relational links for the posts adjacent to the current post.
1639 *
1640 * @since 2.8.0
1641 *
1642 * @param string $title Optional. Link title format.
1643 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1644 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1645 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1646 */
1647function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
1648 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy );
1649 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy );
1650}
1651
1652/**
1653 * Display relational links for the posts adjacent to the current post for single post pages.
1654 *
1655 * This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.
1656 * @since 3.0.0
1657 *
1658 */
1659function adjacent_posts_rel_link_wp_head() {
1660 if ( !is_singular() || is_attachment() )
1661 return;
1662 adjacent_posts_rel_link();
1663}
1664
1665/**
1666 * Display relational link for the next post adjacent to the current post.
1667 *
1668 * @since 2.8.0
1669 *
1670 * @param string $title Optional. Link title format.
1671 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1672 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1673 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1674 */
1675function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
1676 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy );
1677}
1678
1679/**
1680 * Display relational link for the previous post adjacent to the current post.
1681 *
1682 * @since 2.8.0
1683 *
1684 * @param string $title Optional. Link title format.
1685 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1686 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default true.
1687 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1688 */
1689function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
1690 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy );
1691}
1692
1693/**
1694 * Retrieve boundary post.
1695 *
1696 * Boundary being either the first or last post by publish date within the constraints specified
1697 * by $in_same_term or $excluded_terms.
1698 *
1699 * @since 2.8.0
1700 *
1701 * @param bool $in_same_term Optional. Whether returned post should be in a same taxonomy term.
1702 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1703 * @param bool $start Optional. Whether to retrieve first or last post.
1704 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1705 * @return mixed Array containing the boundary post object if successful, null otherwise.
1706 */
1707function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) {
1708 $post = get_post();
1709 if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) )
1710 return null;
1711
1712 $query_args = array(
1713 'posts_per_page' => 1,
1714 'order' => $start ? 'ASC' : 'DESC',
1715 'update_post_term_cache' => false,
1716 'update_post_meta_cache' => false
1717 );
1718
1719 $term_array = array();
1720
1721 if ( ! is_array( $excluded_terms ) ) {
1722 if ( ! empty( $excluded_terms ) )
1723 $excluded_terms = explode( ',', $excluded_terms );
1724 else
1725 $excluded_terms = array();
1726 }
1727
1728 if ( $in_same_term || ! empty( $excluded_terms ) ) {
1729 if ( $in_same_term )
1730 $term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) );
1731
1732 if ( ! empty( $excluded_terms ) ) {
1733 $excluded_terms = array_map( 'intval', $excluded_terms );
1734 $excluded_terms = array_diff( $excluded_terms, $term_array );
1735
1736 $inverse_terms = array();
1737 foreach ( $excluded_terms as $excluded_term )
1738 $inverse_terms[] = $excluded_term * -1;
1739 $excluded_terms = $inverse_terms;
1740 }
1741
1742 $query_args[ 'tax_query' ] = array( array(
1743 'taxonomy' => $taxonomy,
1744 'terms' => array_merge( $term_array, $excluded_terms )
1745 ) );
1746 }
1747
1748 return get_posts( $query_args );
1749}
1750
1751/*
1752 * Get previous post link that is adjacent to the current post.
1753 *
1754 * @since 3.7.0
1755 *
1756 * @param string $format Optional. Link anchor format.
1757 * @param string $link Optional. Link permalink format.
1758 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1759 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1760 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1761 * @return string
1762 */
1763function get_previous_post_link( $format = '&laquo; %link', $link = '%title', $in_same_cat = false, $excluded_terms = '', $taxonomy = 'category' ) {
1764 return get_adjacent_post_link( $format, $link, $in_same_cat, $excluded_terms, true, $taxonomy );
1765}
1766
1767/**
1768 * Display previous post link that is adjacent to the current post.
1769 *
1770 * @since 1.5.0
1771 * @see get_previous_post_link()
1772 *
1773 * @param string $format Optional. Link anchor format.
1774 * @param string $link Optional. Link permalink format.
1775 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1776 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1777 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1778 */
1779function previous_post_link( $format = '&laquo; %link', $link = '%title', $in_same_cat = false, $excluded_terms = '', $taxonomy = 'category' ) {
1780 echo get_previous_post_link( $format, $link, $in_same_cat, $excluded_terms, $taxonomy );
1781}
1782
1783/**
1784 * Get next post link that is adjacent to the current post.
1785 *
1786 * @since 3.7.0
1787 *
1788 * @param string $format Optional. Link anchor format.
1789 * @param string $link Optional. Link permalink format.
1790 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1791 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1792 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1793 * @return string
1794 */
1795function get_next_post_link( $format = '%link &raquo;', $link = '%title', $in_same_cat = false, $excluded_terms = '', $taxonomy = 'category' ) {
1796 return get_adjacent_post_link( $format, $link, $in_same_cat, $excluded_terms, false, $taxonomy );
1797}
1798
1799/**
1800 * Display next post link that is adjacent to the current post.
1801 *
1802 * @since 1.5.0
1803 * @see get_next_post_link()
1804 *
1805 * @param string $format Optional. Link anchor format.
1806 * @param string $link Optional. Link permalink format.
1807 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1808 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs.
1809 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1810 */
1811function next_post_link( $format = '%link &raquo;', $link = '%title', $in_same_cat = false, $excluded_terms = '', $taxonomy = 'category' ) {
1812 echo get_next_post_link( $format, $link, $in_same_cat, $excluded_terms, $taxonomy );
1813}
1814
1815/**
1816 * Get adjacent post link.
1817 *
1818 * Can be either next post link or previous.
1819 *
1820 * @since 3.7.0
1821 *
1822 * @param string $format Link anchor format.
1823 * @param string $link Link permalink format.
1824 * @param bool $in_same_term Optional. Whether link should be in a same taxonomy term.
1825 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs.
1826 * @param bool $previous Optional. Whether to display link to previous or next post. Default true.
1827 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1828 * @return string
1829 */
1830function get_adjacent_post_link( $format, $link, $in_same_cat = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
1831 if ( $previous && is_attachment() )
1832 $post = get_post( get_post()->post_parent );
1833 else
1834 $post = get_adjacent_post( $in_same_cat, $excluded_terms, $previous, $taxonomy );
1835
1836 if ( ! $post ) {
1837 $output = '';
1838 } else {
1839 $title = $post->post_title;
1840
1841 if ( empty( $post->post_title ) )
1842 $title = $previous ? __( 'Previous Post' ) : __( 'Next Post' );
1843
1844 /** This filter is documented in wp-includes/post-template.php */
1845 $title = apply_filters( 'the_title', $title, $post->ID );
1846
1847 $date = mysql2date( get_option( 'date_format' ), $post->post_date );
1848 $rel = $previous ? 'prev' : 'next';
1849
1850 $string = '<a href="' . get_permalink( $post ) . '" rel="'.$rel.'">';
1851 $inlink = str_replace( '%title', $title, $link );
1852 $inlink = str_replace( '%date', $date, $inlink );
1853 $inlink = $string . $inlink . '</a>';
1854
1855 $output = str_replace( '%link', $inlink, $format );
1856 }
1857
1858 $adjacent = $previous ? 'previous' : 'next';
1859
1860 /**
1861 * Filter the adjacent post link.
1862 *
1863 * The dynamic portion of the hook name, $adjacent, refers to the type
1864 * of adjacency, 'next' or 'previous'.
1865 *
1866 * @since 2.6.0
1867 *
1868 * @param string $output The adjacent post link.
1869 * @param string $format Link anchor format.
1870 * @param string $link Link permalink format.
1871 * @param WP_Post $post The adjacent post.
1872 */
1873 return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post );
1874}
1875
1876/**
1877 * Display adjacent post link.
1878 *
1879 * Can be either next post link or previous.
1880 *
1881 * @since 2.5.0
1882 * @uses get_adjacent_post_link()
1883 *
1884 * @param string $format Link anchor format.
1885 * @param string $link Link permalink format.
1886 * @param bool $in_same_cat Optional. Whether link should be in a same category.
1887 * @param array|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs.
1888 * @param bool $previous Optional. Whether to display link to previous or next post. Default true.
1889 * @param string $taxonomy Optional. Taxonomy, if $in_same_term is true. Default 'category'.
1890 * @return string
1891 */
1892function adjacent_post_link( $format, $link, $in_same_cat = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
1893 echo get_adjacent_post_link( $format, $link, $in_same_cat, $excluded_terms, $previous, $taxonomy );
1894}
1895
1896/**
1897 * Retrieve links for page numbers.
1898 *
1899 * @since 1.5.0
1900 *
1901 * @param int $pagenum Optional. Page ID.
1902 * @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). Defaults to true.
1903* Otherwise, prepares the URL with esc_url_raw().
1904 * @return string
1905 */
1906function get_pagenum_link($pagenum = 1, $escape = true ) {
1907 global $wp_rewrite;
1908
1909 $pagenum = (int) $pagenum;
1910
1911 $request = remove_query_arg( 'paged' );
1912
1913 $home_root = parse_url(home_url());
1914 $home_root = ( isset($home_root['path']) ) ? $home_root['path'] : '';
1915 $home_root = preg_quote( $home_root, '|' );
1916
1917 $request = preg_replace('|^'. $home_root . '|i', '', $request);
1918 $request = preg_replace('|^/+|', '', $request);
1919
1920 if ( !$wp_rewrite->using_permalinks() || is_admin() ) {
1921 $base = trailingslashit( get_bloginfo( 'url' ) );
1922
1923 if ( $pagenum > 1 ) {
1924 $result = add_query_arg( 'paged', $pagenum, $base . $request );
1925 } else {
1926 $result = $base . $request;
1927 }
1928 } else {
1929 $qs_regex = '|\?.*?$|';
1930 preg_match( $qs_regex, $request, $qs_match );
1931
1932 if ( !empty( $qs_match[0] ) ) {
1933 $query_string = $qs_match[0];
1934 $request = preg_replace( $qs_regex, '', $request );
1935 } else {
1936 $query_string = '';
1937 }
1938
1939 $request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request);
1940 $request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request);
1941 $request = ltrim($request, '/');
1942
1943 $base = trailingslashit( get_bloginfo( 'url' ) );
1944
1945 if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' != $request ) )
1946 $base .= $wp_rewrite->index . '/';
1947
1948 if ( $pagenum > 1 ) {
1949 $request = ( ( !empty( $request ) ) ? trailingslashit( $request ) : $request ) . user_trailingslashit( $wp_rewrite->pagination_base . "/" . $pagenum, 'paged' );
1950 }
1951
1952 $result = $base . $request . $query_string;
1953 }
1954
1955 /**
1956 * Filter the page number link for the current request.
1957 *
1958 * @since 2.5.0
1959 *
1960 * @param string $result The page number link.
1961 */
1962 $result = apply_filters( 'get_pagenum_link', $result );
1963
1964 if ( $escape )
1965 return esc_url( $result );
1966 else
1967 return esc_url_raw( $result );
1968}
1969
1970/**
1971 * Retrieve next posts page link.
1972 *
1973 * Backported from 2.1.3 to 2.0.10.
1974 *
1975 * @since 2.0.10
1976 *
1977 * @param int $max_page Optional. Max pages.
1978 * @return string
1979 */
1980function get_next_posts_page_link($max_page = 0) {
1981 global $paged;
1982
1983 if ( !is_single() ) {
1984 if ( !$paged )
1985 $paged = 1;
1986 $nextpage = intval($paged) + 1;
1987 if ( !$max_page || $max_page >= $nextpage )
1988 return get_pagenum_link($nextpage);
1989 }
1990}
1991
1992/**
1993 * Display or return the next posts page link.
1994 *
1995 * @since 0.71
1996 *
1997 * @param int $max_page Optional. Max pages.
1998 * @param boolean $echo Optional. Echo or return;
1999 */
2000function next_posts( $max_page = 0, $echo = true ) {
2001 $output = esc_url( get_next_posts_page_link( $max_page ) );
2002
2003 if ( $echo )
2004 echo $output;
2005 else
2006 return $output;
2007}
2008
2009/**
2010 * Return the next posts page link.
2011 *
2012 * @since 2.7.0
2013 *
2014 * @param string $label Content for link text.
2015 * @param int $max_page Optional. Max pages.
2016 * @return string|null
2017 */
2018function get_next_posts_link( $label = null, $max_page = 0 ) {
2019 global $paged, $wp_query;
2020
2021 if ( !$max_page )
2022 $max_page = $wp_query->max_num_pages;
2023
2024 if ( !$paged )
2025 $paged = 1;
2026
2027 $nextpage = intval($paged) + 1;
2028
2029 if ( null === $label )
2030 $label = __( 'Next Page &raquo;' );
2031
2032 if ( !is_single() && ( $nextpage <= $max_page ) ) {
2033 /**
2034 * Filter the anchor tag attributes for the next posts page link.
2035 *
2036 * @since 2.7.0
2037 *
2038 * @param string $attributes Attributes for the anchor tag.
2039 */
2040 $attr = apply_filters( 'next_posts_link_attributes', '' );
2041
2042 return '<a href="' . next_posts( $max_page, false ) . "\" $attr>" . preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label) . '</a>';
2043 }
2044}
2045
2046/**
2047 * Display the next posts page link.
2048 *
2049 * @since 0.71
2050 * @uses get_next_posts_link()
2051 *
2052 * @param string $label Content for link text.
2053 * @param int $max_page Optional. Max pages.
2054 */
2055function next_posts_link( $label = null, $max_page = 0 ) {
2056 echo get_next_posts_link( $label, $max_page );
2057}
2058
2059/**
2060 * Retrieve previous posts page link.
2061 *
2062 * Will only return string, if not on a single page or post.
2063 *
2064 * Backported to 2.0.10 from 2.1.3.
2065 *
2066 * @since 2.0.10
2067 *
2068 * @return string|null
2069 */
2070function get_previous_posts_page_link() {
2071 global $paged;
2072
2073 if ( !is_single() ) {
2074 $nextpage = intval($paged) - 1;
2075 if ( $nextpage < 1 )
2076 $nextpage = 1;
2077 return get_pagenum_link($nextpage);
2078 }
2079}
2080
2081/**
2082 * Display or return the previous posts page link.
2083 *
2084 * @since 0.71
2085 *
2086 * @param boolean $echo Optional. Echo or return;
2087 */
2088function previous_posts( $echo = true ) {
2089 $output = esc_url( get_previous_posts_page_link() );
2090
2091 if ( $echo )
2092 echo $output;
2093 else
2094 return $output;
2095}
2096
2097/**
2098 * Return the previous posts page link.
2099 *
2100 * @since 2.7.0
2101 *
2102 * @param string $label Optional. Previous page link text.
2103 * @return string|null
2104 */
2105function get_previous_posts_link( $label = null ) {
2106 global $paged;
2107
2108 if ( null === $label )
2109 $label = __( '&laquo; Previous Page' );
2110
2111 if ( !is_single() && $paged > 1 ) {
2112 /**
2113 * Filter the anchor tag attributes for the previous posts page link.
2114 *
2115 * @since 2.7.0
2116 *
2117 * @param string $attributes Attributes for the anchor tag.
2118 */
2119 $attr = apply_filters( 'previous_posts_link_attributes', '' );
2120 return '<a href="' . previous_posts( false ) . "\" $attr>". preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $label ) .'</a>';
2121 }
2122}
2123
2124/**
2125 * Display the previous posts page link.
2126 *
2127 * @since 0.71
2128 * @uses get_previous_posts_link()
2129 *
2130 * @param string $label Optional. Previous page link text.
2131 */
2132function previous_posts_link( $label = null ) {
2133 echo get_previous_posts_link( $label );
2134}
2135
2136/**
2137 * Return post pages link navigation for previous and next pages.
2138 *
2139 * @since 2.8.0
2140 *
2141 * @param string|array $args Optional args.
2142 * @return string The posts link navigation.
2143 */
2144function get_posts_nav_link( $args = array() ) {
2145 global $wp_query;
2146
2147 $return = '';
2148
2149 if ( !is_singular() ) {
2150 $defaults = array(
2151 'sep' => ' &#8212; ',
2152 'prelabel' => __('&laquo; Previous Page'),
2153 'nxtlabel' => __('Next Page &raquo;'),
2154 );
2155 $args = wp_parse_args( $args, $defaults );
2156
2157 $max_num_pages = $wp_query->max_num_pages;
2158 $paged = get_query_var('paged');
2159
2160 //only have sep if there's both prev and next results
2161 if ($paged < 2 || $paged >= $max_num_pages) {
2162 $args['sep'] = '';
2163 }
2164
2165 if ( $max_num_pages > 1 ) {
2166 $return = get_previous_posts_link($args['prelabel']);
2167 $return .= preg_replace('/&([^#])(?![a-z]{1,8};)/i', '&#038;$1', $args['sep']);
2168 $return .= get_next_posts_link($args['nxtlabel']);
2169 }
2170 }
2171 return $return;
2172
2173}
2174
2175/**
2176 * Display post pages link navigation for previous and next pages.
2177 *
2178 * @since 0.71
2179 *
2180 * @param string $sep Optional. Separator for posts navigation links.
2181 * @param string $prelabel Optional. Label for previous pages.
2182 * @param string $nxtlabel Optional Label for next pages.
2183 */
2184function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) {
2185 $args = array_filter( compact('sep', 'prelabel', 'nxtlabel') );
2186 echo get_posts_nav_link($args);
2187}
2188
2189/**
2190 * Retrieve comments page number link.
2191 *
2192 * @since 2.7.0
2193 *
2194 * @param int $pagenum Optional. Page number.
2195 * @return string
2196 */
2197function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
2198 global $wp_rewrite;
2199
2200 $pagenum = (int) $pagenum;
2201
2202 $result = get_permalink();
2203
2204 if ( 'newest' == get_option('default_comments_page') ) {
2205 if ( $pagenum != $max_page ) {
2206 if ( $wp_rewrite->using_permalinks() )
2207 $result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
2208 else
2209 $result = add_query_arg( 'cpage', $pagenum, $result );
2210 }
2211 } elseif ( $pagenum > 1 ) {
2212 if ( $wp_rewrite->using_permalinks() )
2213 $result = user_trailingslashit( trailingslashit($result) . 'comment-page-' . $pagenum, 'commentpaged');
2214 else
2215 $result = add_query_arg( 'cpage', $pagenum, $result );
2216 }
2217
2218 $result .= '#comments';
2219
2220 /**
2221 * Filter the comments page number link for the current request.
2222 *
2223 * @since 2.7.0
2224 *
2225 * @param string $result The comments page number link.
2226 */
2227 $result = apply_filters( 'get_comments_pagenum_link', $result );
2228
2229 return $result;
2230}
2231
2232/**
2233 * Return the link to next comments page.
2234 *
2235 * @since 2.7.1
2236 *
2237 * @param string $label Optional. Label for link text.
2238 * @param int $max_page Optional. Max page.
2239 * @return string|null
2240 */
2241function get_next_comments_link( $label = '', $max_page = 0 ) {
2242 global $wp_query;
2243
2244 if ( !is_singular() || !get_option('page_comments') )
2245 return;
2246
2247 $page = get_query_var('cpage');
2248
2249 $nextpage = intval($page) + 1;
2250
2251 if ( empty($max_page) )
2252 $max_page = $wp_query->max_num_comment_pages;
2253
2254 if ( empty($max_page) )
2255 $max_page = get_comment_pages_count();
2256
2257 if ( $nextpage > $max_page )
2258 return;
2259
2260 if ( empty($label) )
2261 $label = __('Newer Comments &raquo;');
2262
2263 /**
2264 * Filter the anchor tag attributes for the next comments page link.
2265 *
2266 * @since 2.7.0
2267 *
2268 * @param string $attributes Attributes for the anchor tag.
2269 */
2270 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>';
2271}
2272
2273/**
2274 * Display the link to next comments page.
2275 *
2276 * @since 2.7.0
2277 *
2278 * @param string $label Optional. Label for link text.
2279 * @param int $max_page Optional. Max page.
2280 */
2281function next_comments_link( $label = '', $max_page = 0 ) {
2282 echo get_next_comments_link( $label, $max_page );
2283}
2284
2285/**
2286 * Return the previous comments page link.
2287 *
2288 * @since 2.7.1
2289 *
2290 * @param string $label Optional. Label for comments link text.
2291 * @return string|null
2292 */
2293function get_previous_comments_link( $label = '' ) {
2294 if ( !is_singular() || !get_option('page_comments') )
2295 return;
2296
2297 $page = get_query_var('cpage');
2298
2299 if ( intval($page) <= 1 )
2300 return;
2301
2302 $prevpage = intval($page) - 1;
2303
2304 if ( empty($label) )
2305 $label = __('&laquo; Older Comments');
2306
2307 /**
2308 * Filter the anchor tag attributes for the previous comments page link.
2309 *
2310 * @since 2.7.0
2311 *
2312 * @param string $attributes Attributes for the anchor tag.
2313 */
2314 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>';
2315}
2316
2317/**
2318 * Display the previous comments page link.
2319 *
2320 * @since 2.7.0
2321 *
2322 * @param string $label Optional. Label for comments link text.
2323 */
2324function previous_comments_link( $label = '' ) {
2325 echo get_previous_comments_link( $label );
2326}
2327
2328/**
2329 * Create pagination links for the comments on the current post.
2330 *
2331 * @see paginate_links()
2332 * @since 2.7.0
2333 *
2334 * @param string|array $args Optional args. See paginate_links().
2335 * @return string Markup for pagination links.
2336*/
2337function paginate_comments_links($args = array()) {
2338 global $wp_rewrite;
2339
2340 if ( !is_singular() || !get_option('page_comments') )
2341 return;
2342
2343 $page = get_query_var('cpage');
2344 if ( !$page )
2345 $page = 1;
2346 $max_page = get_comment_pages_count();
2347 $defaults = array(
2348 'base' => add_query_arg( 'cpage', '%#%' ),
2349 'format' => '',
2350 'total' => $max_page,
2351 'current' => $page,
2352 'echo' => true,
2353 'add_fragment' => '#comments'
2354 );
2355 if ( $wp_rewrite->using_permalinks() )
2356 $defaults['base'] = user_trailingslashit(trailingslashit(get_permalink()) . 'comment-page-%#%', 'commentpaged');
2357
2358 $args = wp_parse_args( $args, $defaults );
2359 $page_links = paginate_links( $args );
2360
2361 if ( $args['echo'] )
2362 echo $page_links;
2363 else
2364 return $page_links;
2365}
2366
2367/**
2368 * Retrieve the Press This bookmarklet link.
2369 *
2370 * Use this in 'a' element 'href' attribute.
2371 *
2372 * @since 2.6.0
2373 *
2374 * @return string
2375 */
2376function get_shortcut_link() {
2377 // In case of breaking changes, version this. #WP20071
2378 $link = "javascript:
2379 var d=document,
2380 w=window,
2381 e=w.getSelection,
2382 k=d.getSelection,
2383 x=d.selection,
2384 s=(e?e():(k)?k():(x?x.createRange().text:0)),
2385 f='" . admin_url('press-this.php') . "',
2386 l=d.location,
2387 e=encodeURIComponent,
2388 u=f+'?u='+e(l.href)+'&t='+e(d.title)+'&s='+e(s)+'&v=4';
2389 a=function(){if(!w.open(u,'t','toolbar=0,resizable=1,scrollbars=1,status=1,width=720,height=570'))l.href=u;};
2390 if (/Firefox/.test(navigator.userAgent)) setTimeout(a, 0); else a();
2391 void(0)";
2392
2393 $link = str_replace(array("\r", "\n", "\t"), '', $link);
2394
2395 /**
2396 * Filter the Press This bookmarklet link.
2397 *
2398 * @since 2.6.0
2399 *
2400 * @param string $link The Press This bookmarklet link.
2401 */
2402 return apply_filters( 'shortcut_link', $link );
2403}
2404
2405/**
2406 * Retrieve the home url for the current site.
2407 *
2408 * Returns the 'home' option with the appropriate protocol, 'https' if
2409 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2410 * overridden.
2411 *
2412 * @since 3.0.0
2413 *
2414 * @uses get_home_url()
2415 *
2416 * @param string $path (optional) Path relative to the home url.
2417 * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
2418 * @return string Home url link with optional path appended.
2419*/
2420function home_url( $path = '', $scheme = null ) {
2421 return get_home_url( null, $path, $scheme );
2422}
2423
2424/**
2425 * Retrieve the home url for a given site.
2426 *
2427 * Returns the 'home' option with the appropriate protocol, 'https' if
2428 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2429 * overridden.
2430 *
2431 * @since 3.0.0
2432 *
2433 * @param int $blog_id (optional) Blog ID. Defaults to current blog.
2434 * @param string $path (optional) Path relative to the home url.
2435 * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
2436 * @return string Home url link with optional path appended.
2437*/
2438function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
2439 $orig_scheme = $scheme;
2440
2441 if ( empty( $blog_id ) || !is_multisite() ) {
2442 $url = get_option( 'home' );
2443 } else {
2444 switch_to_blog( $blog_id );
2445 $url = get_option( 'home' );
2446 restore_current_blog();
2447 }
2448
2449 if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
2450 if ( is_ssl() && ! is_admin() && 'wp-login.php' !== $GLOBALS['pagenow'] )
2451 $scheme = 'https';
2452 else
2453 $scheme = parse_url( $url, PHP_URL_SCHEME );
2454 }
2455
2456 $url = set_url_scheme( $url, $scheme );
2457
2458 if ( $path && is_string( $path ) )
2459 $url .= '/' . ltrim( $path, '/' );
2460
2461 /**
2462 * Filter the home URL.
2463 *
2464 * @since 3.0.0
2465 *
2466 * @param string $url The complete home URL including scheme and path.
2467 * @param string $path Path relative to the home URL. Blank string if no path is specified.
2468 * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', 'relative' or null.
2469 * @param int|null $blog_id Blog ID, or null for the current blog.
2470 */
2471 return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
2472}
2473
2474/**
2475 * Retrieve the site url for the current site.
2476 *
2477 * Returns the 'site_url' option with the appropriate protocol, 'https' if
2478 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2479 * overridden.
2480 *
2481 * @since 3.0.0
2482 *
2483 * @uses get_site_url()
2484 *
2485 * @param string $path Optional. Path relative to the site url.
2486 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
2487 * @return string Site url link with optional path appended.
2488*/
2489function site_url( $path = '', $scheme = null ) {
2490 return get_site_url( null, $path, $scheme );
2491}
2492
2493/**
2494 * Retrieve the site url for a given site.
2495 *
2496 * Returns the 'site_url' option with the appropriate protocol, 'https' if
2497 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2498 * overridden.
2499 *
2500 * @since 3.0.0
2501 *
2502 * @param int $blog_id (optional) Blog ID. Defaults to current blog.
2503 * @param string $path Optional. Path relative to the site url.
2504 * @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
2505 * @return string Site url link with optional path appended.
2506*/
2507function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
2508 if ( empty( $blog_id ) || !is_multisite() ) {
2509 $url = get_option( 'siteurl' );
2510 } else {
2511 switch_to_blog( $blog_id );
2512 $url = get_option( 'siteurl' );
2513 restore_current_blog();
2514 }
2515
2516 $url = set_url_scheme( $url, $scheme );
2517
2518 if ( $path && is_string( $path ) )
2519 $url .= '/' . ltrim( $path, '/' );
2520
2521 /**
2522 * Filter the site URL.
2523 *
2524 * @since 2.7.0
2525 *
2526 * @param string $url The complete site URL including scheme and path.
2527 * @param string $path Path relative to the site URL. Blank string if no path is specified.
2528 * @param string|null $scheme Scheme to give the site URL context. Accepts 'http', 'https', 'login',
2529 * 'login_post', 'admin', 'relative' or null.
2530 * @param int|null $blog_id Blog ID, or null for the current blog.
2531 */
2532 return apply_filters( 'site_url', $url, $path, $scheme, $blog_id );
2533}
2534
2535/**
2536 * Retrieve the url to the admin area for the current site.
2537 *
2538 * @since 2.6.0
2539 *
2540 * @param string $path Optional path relative to the admin url.
2541 * @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.
2542 * @return string Admin url link with optional path appended.
2543*/
2544function admin_url( $path = '', $scheme = 'admin' ) {
2545 return get_admin_url( null, $path, $scheme );
2546}
2547
2548/**
2549 * Retrieve the url to the admin area for a given site.
2550 *
2551 * @since 3.0.0
2552 *
2553 * @param int $blog_id (optional) Blog ID. Defaults to current blog.
2554 * @param string $path Optional path relative to the admin url.
2555 * @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.
2556 * @return string Admin url link with optional path appended.
2557*/
2558function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
2559 $url = get_site_url($blog_id, 'wp-admin/', $scheme);
2560
2561 if ( $path && is_string( $path ) )
2562 $url .= ltrim( $path, '/' );
2563
2564 /**
2565 * Filter the admin area URL.
2566 *
2567 * @since 2.8.0
2568 *
2569 * @param string $url The complete admin area URL including scheme and path.
2570 * @param string $path Path relative to the admin area URL. Blank string if no path is specified.
2571 * @param int|null $blog_id Blog ID, or null for the current blog.
2572 */
2573 return apply_filters( 'admin_url', $url, $path, $blog_id );
2574}
2575
2576/**
2577 * Retrieve the url to the includes directory.
2578 *
2579 * @since 2.6.0
2580 *
2581 * @param string $path Optional. Path relative to the includes url.
2582 * @param string $scheme Optional. Scheme to give the includes url context.
2583 * @return string Includes url link with optional path appended.
2584*/
2585function includes_url( $path = '', $scheme = null ) {
2586 $url = site_url( '/' . WPINC . '/', $scheme );
2587
2588 if ( $path && is_string( $path ) )
2589 $url .= ltrim($path, '/');
2590
2591 /**
2592 * Filter the URL to the includes directory.
2593 *
2594 * @since 2.8.0
2595 *
2596 * @param string $url The complete URL to the includes directory including scheme and path.
2597 * @param string $path Path relative to the URL to the wp-includes directory. Blank string
2598 * if no path is specified.
2599 */
2600 return apply_filters( 'includes_url', $url, $path );
2601}
2602
2603/**
2604 * Retrieve the url to the content directory.
2605 *
2606 * @since 2.6.0
2607 *
2608 * @param string $path Optional. Path relative to the content url.
2609 * @return string Content url link with optional path appended.
2610*/
2611function content_url($path = '') {
2612 $url = set_url_scheme( WP_CONTENT_URL );
2613
2614 if ( $path && is_string( $path ) )
2615 $url .= '/' . ltrim($path, '/');
2616
2617 /**
2618 * Filter the URL to the content directory.
2619 *
2620 * @since 2.8.0
2621 *
2622 * @param string $url The complete URL to the content directory including scheme and path.
2623 * @param string $path Path relative to the URL to the content directory. Blank string
2624 * if no path is specified.
2625 */
2626 return apply_filters( 'content_url', $url, $path);
2627}
2628
2629/**
2630 * Retrieve the url to the plugins directory or to a specific file within that directory.
2631 * You can hardcode the plugin slug in $path or pass __FILE__ as a second argument to get the correct folder name.
2632 *
2633 * @since 2.6.0
2634 *
2635 * @param string $path Optional. Path relative to the plugins url.
2636 * @param string $plugin Optional. The plugin file that you want to be relative to - i.e. pass in __FILE__
2637 * @return string Plugins url link with optional path appended.
2638*/
2639function plugins_url($path = '', $plugin = '') {
2640
2641 $mu_plugin_dir = WPMU_PLUGIN_DIR;
2642 foreach ( array('path', 'plugin', 'mu_plugin_dir') as $var ) {
2643 $$var = str_replace('\\' ,'/', $$var); // sanitize for Win32 installs
2644 $$var = preg_replace('|/+|', '/', $$var);
2645 }
2646
2647 if ( !empty($plugin) && 0 === strpos($plugin, $mu_plugin_dir) )
2648 $url = WPMU_PLUGIN_URL;
2649 else
2650 $url = WP_PLUGIN_URL;
2651
2652
2653 $url = set_url_scheme( $url );
2654
2655 if ( !empty($plugin) && is_string($plugin) ) {
2656 $folder = dirname(plugin_basename($plugin));
2657 if ( '.' != $folder )
2658 $url .= '/' . ltrim($folder, '/');
2659 }
2660
2661 if ( $path && is_string( $path ) )
2662 $url .= '/' . ltrim($path, '/');
2663
2664 /**
2665 * Filter the URL to the plugins directory.
2666 *
2667 * @since 2.8.0
2668 *
2669 * @param string $url The complete URL to the plugins directory including scheme and path.
2670 * @param string $path Path relative to the URL to the plugins directory. Blank string
2671 * if no path is specified.
2672 * @param string $plugin The plugin file path to be relative to. Blank string if no plugin
2673 * is specified.
2674 */
2675 return apply_filters( 'plugins_url', $url, $path, $plugin );
2676}
2677
2678/**
2679 * Retrieve the site url for the current network.
2680 *
2681 * Returns the site url with the appropriate protocol, 'https' if
2682 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2683 * overridden.
2684 *
2685 * @since 3.0.0
2686 *
2687 * @param string $path Optional. Path relative to the site url.
2688 * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
2689 * @return string Site url link with optional path appended.
2690*/
2691function network_site_url( $path = '', $scheme = null ) {
2692 if ( ! is_multisite() )
2693 return site_url($path, $scheme);
2694
2695 $current_site = get_current_site();
2696
2697 if ( 'relative' == $scheme )
2698 $url = $current_site->path;
2699 else
2700 $url = set_url_scheme( 'http://' . $current_site->domain . $current_site->path, $scheme );
2701
2702 if ( $path && is_string( $path ) )
2703 $url .= ltrim( $path, '/' );
2704
2705 /**
2706 * Filter the network site URL.
2707 *
2708 * @since 3.0.0
2709 *
2710 * @param string $url The complete network site URL including scheme and path.
2711 * @param string $path Path relative to the network site URL. Blank string if
2712 * no path is specified.
2713 * @param string|null $scheme Scheme to give the URL context. Accepts 'http', 'https',
2714 * 'relative' or null.
2715 */
2716 return apply_filters( 'network_site_url', $url, $path, $scheme );
2717}
2718
2719/**
2720 * Retrieve the home url for the current network.
2721 *
2722 * Returns the home url with the appropriate protocol, 'https' if
2723 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
2724 * overridden.
2725 *
2726 * @since 3.0.0
2727 *
2728 * @param string $path (optional) Path relative to the home url.
2729 * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
2730 * @return string Home url link with optional path appended.
2731*/
2732function network_home_url( $path = '', $scheme = null ) {
2733 if ( ! is_multisite() )
2734 return home_url($path, $scheme);
2735
2736 $current_site = get_current_site();
2737 $orig_scheme = $scheme;
2738
2739 if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) )
2740 $scheme = is_ssl() && ! is_admin() ? 'https' : 'http';
2741
2742 if ( 'relative' == $scheme )
2743 $url = $current_site->path;
2744 else
2745 $url = set_url_scheme( 'http://' . $current_site->domain . $current_site->path, $scheme );
2746
2747 if ( $path && is_string( $path ) )
2748 $url .= ltrim( $path, '/' );
2749
2750 /**
2751 * Filter the network home URL.
2752 *
2753 * @since 3.0.0
2754 *
2755 * @param string $url The complete network home URL including scheme and path.
2756 * @param string $path Path relative to the network home URL. Blank string
2757 * if no path is specified.
2758 * @param string|null $orig_scheme Scheme to give the URL context. Accepts 'http', 'https',
2759 * 'relative' or null.
2760 */
2761 return apply_filters( 'network_home_url', $url, $path, $orig_scheme);
2762}
2763
2764/**
2765 * Retrieve the url to the admin area for the network.
2766 *
2767 * @since 3.0.0
2768 *
2769 * @param string $path Optional path relative to the admin url.
2770 * @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.
2771 * @return string Admin url link with optional path appended.
2772*/
2773function network_admin_url( $path = '', $scheme = 'admin' ) {
2774 if ( ! is_multisite() )
2775 return admin_url( $path, $scheme );
2776
2777 $url = network_site_url('wp-admin/network/', $scheme);
2778
2779 if ( $path && is_string( $path ) )
2780 $url .= ltrim($path, '/');
2781
2782 /**
2783 * Filter the network admin URL.
2784 *
2785 * @since 3.0.0
2786 *
2787 * @param string $url The complete network admin URL including scheme and path.
2788 * @param string $path Path relative to the network admin URL. Blank string if
2789 * no path is specified.
2790 */
2791 return apply_filters( 'network_admin_url', $url, $path );
2792}
2793
2794/**
2795 * Retrieve the url to the admin area for the current user.
2796 *
2797 * @since 3.0.0
2798 *
2799 * @param string $path Optional path relative to the admin url.
2800 * @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.
2801 * @return string Admin url link with optional path appended.
2802*/
2803function user_admin_url( $path = '', $scheme = 'admin' ) {
2804 $url = network_site_url('wp-admin/user/', $scheme);
2805
2806 if ( $path && is_string( $path ) )
2807 $url .= ltrim($path, '/');
2808
2809 /**
2810 * Filter the user admin URL for the current user.
2811 *
2812 * @since 3.1.0
2813 *
2814 * @param string $url The complete URL including scheme and path.
2815 * @param string $path Path relative to the URL. Blank string if
2816 * no path is specified.
2817 */
2818 return apply_filters( 'user_admin_url', $url, $path );
2819}
2820
2821/**
2822 * Retrieve the url to the admin area for either the current blog or the network depending on context.
2823 *
2824 * @since 3.1.0
2825 *
2826 * @param string $path Optional path relative to the admin url.
2827 * @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.
2828 * @return string Admin url link with optional path appended.
2829*/
2830function self_admin_url($path = '', $scheme = 'admin') {
2831 if ( is_network_admin() )
2832 return network_admin_url($path, $scheme);
2833 elseif ( is_user_admin() )
2834 return user_admin_url($path, $scheme);
2835 else
2836 return admin_url($path, $scheme);
2837}
2838
2839/**
2840 * Set the scheme for a URL
2841 *
2842 * @since 3.4.0
2843 *
2844 * @param string $url Absolute url that includes a scheme
2845 * @param string $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
2846 * @return string $url URL with chosen scheme.
2847 */
2848function set_url_scheme( $url, $scheme = null ) {
2849 $orig_scheme = $scheme;
2850 if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ) ) ) {
2851 if ( ( 'login_post' == $scheme || 'rpc' == $scheme ) && ( force_ssl_login() || force_ssl_admin() ) )
2852 $scheme = 'https';
2853 elseif ( ( 'login' == $scheme ) && force_ssl_admin() )
2854 $scheme = 'https';
2855 elseif ( ( 'admin' == $scheme ) && force_ssl_admin() )
2856 $scheme = 'https';
2857 else
2858 $scheme = ( is_ssl() ? 'https' : 'http' );
2859 }
2860
2861 $url = trim( $url );
2862 if ( substr( $url, 0, 2 ) === '//' )
2863 $url = 'http:' . $url;
2864
2865 if ( 'relative' == $scheme ) {
2866 $url = ltrim( preg_replace( '#^\w+://[^/]*#', '', $url ) );
2867 if ( $url !== '' && $url[0] === '/' )
2868 $url = '/' . ltrim($url , "/ \t\n\r\0\x0B" );
2869 } else {
2870 $url = preg_replace( '#^\w+://#', $scheme . '://', $url );
2871 }
2872
2873 /**
2874 * Filter the resulting URL after setting the scheme.
2875 *
2876 * @since 3.4.0
2877 *
2878 * @param string $url The complete URL including scheme and path.
2879 * @param string $scheme Scheme applied to the URL. One of 'http', 'https', or 'relative'.
2880 * @param string $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login',
2881 * 'login_post', 'admin', 'rpc', or 'relative'.
2882 */
2883 return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme );
2884}
2885
2886/**
2887 * Get the URL to the user's dashboard.
2888 *
2889 * If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site,
2890 * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
2891 * primary blog is returned.
2892 *
2893 * @since 3.1.0
2894 *
2895 * @param int $user_id Optional. User ID. Defaults to current user.
2896 * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
2897 * @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.
2898 * @return string Dashboard url link with optional path appended.
2899 */
2900function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
2901 $user_id = $user_id ? (int) $user_id : get_current_user_id();
2902
2903 $blogs = get_blogs_of_user( $user_id );
2904 if ( ! is_super_admin() && empty($blogs) ) {
2905 $url = user_admin_url( $path, $scheme );
2906 } elseif ( ! is_multisite() ) {
2907 $url = admin_url( $path, $scheme );
2908 } else {
2909 $current_blog = get_current_blog_id();
2910 if ( $current_blog && ( is_super_admin( $user_id ) || in_array( $current_blog, array_keys( $blogs ) ) ) ) {
2911 $url = admin_url( $path, $scheme );
2912 } else {
2913 $active = get_active_blog_for_user( $user_id );
2914 if ( $active )
2915 $url = get_admin_url( $active->blog_id, $path, $scheme );
2916 else
2917 $url = user_admin_url( $path, $scheme );
2918 }
2919 }
2920
2921 /**
2922 * Filter the dashboard URL for a user.
2923 *
2924 * @since 3.1.0
2925 *
2926 * @param string $url The complete URL including scheme and path.
2927 * @param int $user_id The user ID.
2928 * @param string $path Path relative to the URL. Blank string if no path is specified.
2929 * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login',
2930 * 'login_post', 'admin', 'relative' or null.
2931 */
2932 return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme);
2933}
2934
2935/**
2936 * Get the URL to the user's profile editor.
2937 *
2938 * @since 3.1.0
2939 *
2940 * @param int $user_id Optional. User ID. Defaults to current user.
2941 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl().
2942 * 'http' or 'https' can be passed to force those schemes.
2943 * @return string Dashboard url link with optional path appended.
2944 */
2945function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
2946 $user_id = $user_id ? (int) $user_id : get_current_user_id();
2947
2948 if ( is_user_admin() )
2949 $url = user_admin_url( 'profile.php', $scheme );
2950 elseif ( is_network_admin() )
2951 $url = network_admin_url( 'profile.php', $scheme );
2952 else
2953 $url = get_dashboard_url( $user_id, 'profile.php', $scheme );
2954
2955 /**
2956 * Filter the URL for a user's profile editor.
2957 *
2958 * @since 3.1.0
2959 *
2960 * @param string $url The complete URL including scheme and path.
2961 * @param int $user_id The user ID.
2962 * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login',
2963 * 'login_post', 'admin', 'relative' or null.
2964 */
2965 return apply_filters( 'edit_profile_url', $url, $user_id, $scheme);
2966}
2967
2968/**
2969 * Output rel=canonical for singular queries.
2970 *
2971 * @since 2.9.0
2972*/
2973function rel_canonical() {
2974 if ( !is_singular() )
2975 return;
2976
2977 global $wp_the_query;
2978 if ( !$id = $wp_the_query->get_queried_object_id() )
2979 return;
2980
2981 $link = get_permalink( $id );
2982
2983 if ( $page = get_query_var('cpage') )
2984 $link = get_comments_pagenum_link( $page );
2985
2986 echo "<link rel='canonical' href='$link' />\n";
2987}
2988
2989/**
2990 * Return a shortlink for a post, page, attachment, or blog.
2991 *
2992 * This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to
2993 * provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts.
2994 * Plugins can short-circuit this function via the pre_get_shortlink filter or filter the output
2995 * via the get_shortlink filter.
2996 *
2997 * @since 3.0.0.
2998 *
2999 * @param int $id A post or blog id. Default is 0, which means the current post or blog.
3000 * @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'.
3001 * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
3002 * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
3003 */
3004function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
3005 /**
3006 * Filter whether to preempt generating a shortlink for the given post.
3007 *
3008 * Passing a truthy value to the filter will effectively short-circuit the
3009 * shortlink-generation process, returning that value instead.
3010 *
3011 * @since 3.0.0
3012 *
3013 * @param bool|string $return Short-circuit return value. Either false or a URL string.
3014 * @param int $id Post ID, or 0 for the current post.
3015 * @param string $context The context for the link. One of 'post' or 'query',
3016 * @param bool $allow_slugs Whether to allow post slugs in the shortlink.
3017 */
3018 $shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs );
3019
3020 if ( false !== $shortlink )
3021 return $shortlink;
3022
3023 global $wp_query;
3024 $post_id = 0;
3025 if ( 'query' == $context && is_singular() ) {
3026 $post_id = $wp_query->get_queried_object_id();
3027 $post = get_post( $post_id );
3028 } elseif ( 'post' == $context ) {
3029 $post = get_post( $id );
3030 if ( ! empty( $post->ID ) )
3031 $post_id = $post->ID;
3032 }
3033
3034 $shortlink = '';
3035
3036 // Return p= link for all public post types.
3037 if ( ! empty( $post_id ) ) {
3038 $post_type = get_post_type_object( $post->post_type );
3039
3040 if ( 'page' === $post->post_type && $post->ID == get_option( 'page_on_front' ) && 'page' == get_option( 'show_on_front' ) ) {
3041 $shortlink = home_url( '/' );
3042 } elseif ( $post_type->public ) {
3043 $shortlink = home_url( '?p=' . $post_id );
3044 }
3045 }
3046
3047 /**
3048 * Filter the shortlink for a post.
3049 *
3050 * @since 3.0.0
3051 *
3052 * @param string $shortlink Shortlink URL.
3053 * @param int $id Post ID, or 0 for the current post.
3054 * @param string $context The context for the link. One of 'post' or 'query',
3055 * @param bool $allow_slugs Whether to allow post slugs in the shortlink. Not used by default.
3056 */
3057 return apply_filters( 'get_shortlink', $shortlink, $id, $context, $allow_slugs );
3058}
3059
3060/**
3061 * Inject rel=shortlink into head if a shortlink is defined for the current page.
3062 *
3063 * Attached to the wp_head action.
3064 *
3065 * @since 3.0.0
3066 *
3067 * @uses wp_get_shortlink()
3068 */
3069function wp_shortlink_wp_head() {
3070 $shortlink = wp_get_shortlink( 0, 'query' );
3071
3072 if ( empty( $shortlink ) )
3073 return;
3074
3075 echo "<link rel='shortlink' href='" . esc_url( $shortlink ) . "' />\n";
3076}
3077
3078/**
3079 * Send a Link: rel=shortlink header if a shortlink is defined for the current page.
3080 *
3081 * Attached to the wp action.
3082 *
3083 * @since 3.0.0
3084 *
3085 * @uses wp_get_shortlink()
3086 */
3087function wp_shortlink_header() {
3088 if ( headers_sent() )
3089 return;
3090
3091 $shortlink = wp_get_shortlink(0, 'query');
3092
3093 if ( empty($shortlink) )
3094 return;
3095
3096 header('Link: <' . $shortlink . '>; rel=shortlink', false);
3097}
3098
3099/**
3100 * Display the Short Link for a Post
3101 *
3102 * Must be called from inside "The Loop"
3103 *
3104 * Call like the_shortlink(__('Shortlinkage FTW'))
3105 *
3106 * @since 3.0.0
3107 *
3108 * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
3109 * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
3110 * @param string $before Optional HTML to display before the link.
3111 * @param string $after Optional HTML to display after the link.
3112 */
3113function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
3114 $post = get_post();
3115
3116 if ( empty( $text ) )
3117 $text = __('This is the short link.');
3118
3119 if ( empty( $title ) )
3120 $title = the_title_attribute( array( 'echo' => false ) );
3121
3122 $shortlink = wp_get_shortlink( $post->ID );
3123
3124 if ( !empty( $shortlink ) ) {
3125 $link = '<a rel="shortlink" href="' . esc_url( $shortlink ) . '" title="' . $title . '">' . $text . '</a>';
3126
3127 /**
3128 * Filter the shortlink anchor tag for a post.
3129 *
3130 * @since 3.0.0
3131 *
3132 * @param string $link Shortlink anchor tag.
3133 * @param string $shortlink Shortlink URL.
3134 * @param string $text Shortlink's text.
3135 * @param string $title Shortlink's title attribute.
3136 */
3137 $link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title );
3138 echo $before, $link, $after;
3139 }
3140}