| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WordPress Link Template Functions 4 * 5 * @package WordPress 6 * @subpackage Template 7 */ 8 9 /** 10 * Displays the permalink for the current post. 11 * 12 * @since 1.2.0 13 * @since 4.4.0 Added the `$post` parameter. 14 * 15 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 16 */ 17 function the_permalink( $post = 0 ) { 18 /** 19 * Filters the display of the permalink for the current post. 20 * 21 * @since 1.5.0 22 * @since 4.4.0 Added the `$post` parameter. 23 * 24 * @param string $permalink The permalink for the current post. 25 * @param int|WP_Post $post Post ID, WP_Post object, or 0. Default 0. 26 */ 27 echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) ); 28 } 29 30 /** 31 * Retrieves a trailing-slashed string if the site is set for adding trailing slashes. 32 * 33 * Conditionally adds a trailing slash if the permalink structure has a trailing 34 * slash, strips the trailing slash if not. The string is passed through the 35 * {@see 'user_trailingslashit'} filter. Will remove trailing slash from string, if 36 * site is not set to have them. 37 * 38 * @since 2.2.0 39 * 40 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 41 * 42 * @param string $url URL with or without a trailing slash. 43 * @param string $type_of_url Optional. The type of URL being considered (e.g. single, category, etc) 44 * for use in the filter. Default empty string. 45 * @return string The URL with the trailing slash appended or stripped. 46 */ 47 function user_trailingslashit( $url, $type_of_url = '' ) { 48 global $wp_rewrite; 49 if ( $wp_rewrite->use_trailing_slashes ) { 50 $url = trailingslashit( $url ); 51 } else { 52 $url = untrailingslashit( $url ); 53 } 54 55 /** 56 * Filters the trailing-slashed string, depending on whether the site is set to use trailing slashes. 57 * 58 * @since 2.2.0 59 * 60 * @param string $url URL with or without a trailing slash. 61 * @param string $type_of_url The type of URL being considered. Accepts 'single', 'single_trackback', 62 * 'single_feed', 'single_paged', 'commentpaged', 'paged', 'home', 'feed', 63 * 'category', 'page', 'year', 'month', 'day', 'post_type_archive'. 64 */ 65 return apply_filters( 'user_trailingslashit', $url, $type_of_url ); 66 } 67 68 /** 69 * Displays the permalink anchor for the current post. 70 * 71 * The permalink mode title will use the post title for the 'a' element 'id' 72 * attribute. The id mode uses 'post-' with the post ID for the 'id' attribute. 73 * 74 * @since 0.71 75 * 76 * @param string $mode Optional. Permalink mode. Accepts 'title' or 'id'. Default 'id'. 77 */ 78 function permalink_anchor( $mode = 'id' ) { 79 $post = get_post(); 80 switch ( strtolower( $mode ) ) { 81 case 'title': 82 $title = sanitize_title( $post->post_title ) . '-' . $post->ID; 83 echo '<a id="' . $title . '"></a>'; 84 break; 85 case 'id': 86 default: 87 echo '<a id="post-' . $post->ID . '"></a>'; 88 break; 89 } 90 } 91 92 /** 93 * Determine whether post should always use a plain permalink structure. 94 * 95 * @since 5.7.0 96 * 97 * @param WP_Post|int|null $post Optional. Post ID or post object. Defaults to global $post. 98 * @param bool|null $sample Optional. Whether to force consideration based on sample links. 99 * If omitted, a sample link is generated if a post object is passed 100 * with the filter property set to 'sample'. 101 * @return bool Whether to use a plain permalink structure. 102 */ 103 function wp_force_plain_post_permalink( $post = null, $sample = null ) { 104 if ( 105 null === $sample && 106 is_object( $post ) && 107 isset( $post->filter ) && 108 'sample' === $post->filter 109 ) { 110 $sample = true; 111 } else { 112 $post = get_post( $post ); 113 $sample = null !== $sample ? $sample : false; 114 } 115 116 if ( ! $post ) { 117 return true; 118 } 119 120 $post_status_obj = get_post_status_object( get_post_status( $post ) ); 121 $post_type_obj = get_post_type_object( get_post_type( $post ) ); 122 123 if ( ! $post_status_obj || ! $post_type_obj ) { 124 return true; 125 } 126 127 if ( 128 // Publicly viewable links never have plain permalinks. 129 is_post_status_viewable( $post_status_obj ) || 130 ( 131 // Private posts don't have plain permalinks if the user can read them. 132 $post_status_obj->private && 133 current_user_can( 'read_post', $post->ID ) 134 ) || 135 // Protected posts don't have plain links if getting a sample URL. 136 ( $post_status_obj->protected && $sample ) 137 ) { 138 return false; 139 } 140 141 return true; 142 } 143 144 /** 145 * Retrieves the full permalink for the current post or post ID. 146 * 147 * This function is an alias for get_permalink(). 148 * 149 * @since 3.9.0 150 * 151 * @see get_permalink() 152 * 153 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 154 * @param bool $leavename Optional. Whether to keep post name or page name. Default false. 155 * @return string|false The permalink URL. False if the post does not exist. 156 */ 157 function get_the_permalink( $post = 0, $leavename = false ) { 158 return get_permalink( $post, $leavename ); 159 } 160 161 /** 162 * Retrieves the full permalink for the current post or post ID. 163 * 164 * @since 1.0.0 165 * 166 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 167 * @param bool $leavename Optional. Whether to keep post name or page name. Default false. 168 * @return string|false The permalink URL. False if the post does not exist. 169 */ 170 function get_permalink( $post = 0, $leavename = false ) { 171 $rewritecode = array( 172 '%year%', 173 '%monthnum%', 174 '%day%', 175 '%hour%', 176 '%minute%', 177 '%second%', 178 $leavename ? '' : '%postname%', 179 '%post_id%', 180 '%category%', 181 '%author%', 182 $leavename ? '' : '%pagename%', 183 ); 184 185 if ( is_object( $post ) && isset( $post->filter ) && 'sample' === $post->filter ) { 186 $sample = true; 187 } else { 188 $post = get_post( $post ); 189 $sample = false; 190 } 191 192 if ( empty( $post->ID ) ) { 193 return false; 194 } 195 196 if ( 'page' === $post->post_type ) { 197 return get_page_link( $post, $leavename, $sample ); 198 } elseif ( 'attachment' === $post->post_type ) { 199 return get_attachment_link( $post, $leavename ); 200 } elseif ( in_array( $post->post_type, get_post_types( array( '_builtin' => false ) ), true ) ) { 201 return get_post_permalink( $post, $leavename, $sample ); 202 } 203 204 $permalink = get_option( 'permalink_structure' ); 205 206 /** 207 * Filters the permalink structure for a post before token replacement occurs. 208 * 209 * Only applies to posts with post_type of 'post'. 210 * 211 * @since 3.0.0 212 * 213 * @param string $permalink The site's permalink structure. 214 * @param WP_Post $post The post in question. 215 * @param bool $leavename Whether to keep the post name. 216 */ 217 $permalink = apply_filters( 'pre_post_link', $permalink, $post, $leavename ); 218 219 if ( 220 $permalink && 221 ! wp_force_plain_post_permalink( $post ) 222 ) { 223 224 $category = ''; 225 if ( str_contains( $permalink, '%category%' ) ) { 226 $cats = get_the_category( $post->ID ); 227 if ( $cats ) { 228 $cats = wp_list_sort( 229 $cats, 230 array( 231 'term_id' => 'ASC', 232 ) 233 ); 234 235 /** 236 * Filters the category that gets used in the %category% permalink token. 237 * 238 * @since 3.5.0 239 * 240 * @param WP_Term $cat The category to use in the permalink. 241 * @param array $cats Array of all categories (WP_Term objects) associated with the post. 242 * @param WP_Post $post The post in question. 243 */ 244 $category_object = apply_filters( 'post_link_category', $cats[0], $cats, $post ); 245 246 $category_object = get_term( $category_object, 'category' ); 247 $category = $category_object->slug; 248 if ( $category_object->parent ) { 249 $category = get_category_parents( $category_object->parent, false, '/', true ) . $category; 250 } 251 } 252 /* 253 * Show default category in permalinks, 254 * without having to assign it explicitly. 255 */ 256 if ( empty( $category ) ) { 257 $default_category = get_term( get_option( 'default_category' ), 'category' ); 258 if ( $default_category && ! is_wp_error( $default_category ) ) { 259 $category = $default_category->slug; 260 } 261 } 262 } 263 264 $author = ''; 265 if ( str_contains( $permalink, '%author%' ) ) { 266 $authordata = get_userdata( $post->post_author ); 267 $author = $authordata->user_nicename; 268 } 269 270 /* 271 * This is not an API call because the permalink is based on the stored post_date value, 272 * which should be parsed as local time regardless of the default PHP timezone. 273 */ 274 $date = explode( ' ', str_replace( array( '-', ':' ), ' ', $post->post_date ) ); 275 276 $rewritereplace = array( 277 $date[0], 278 $date[1], 279 $date[2], 280 $date[3], 281 $date[4], 282 $date[5], 283 $post->post_name, 284 $post->ID, 285 $category, 286 $author, 287 $post->post_name, 288 ); 289 290 $permalink = home_url( str_replace( $rewritecode, $rewritereplace, $permalink ) ); 291 $permalink = user_trailingslashit( $permalink, 'single' ); 292 293 } else { // If they're not using the fancy permalink option. 294 $permalink = home_url( '?p=' . $post->ID ); 295 } 296 297 /** 298 * Filters the permalink for a post. 299 * 300 * Only applies to posts with post_type of 'post'. 301 * 302 * @since 1.5.0 303 * 304 * @param string $permalink The post's permalink. 305 * @param WP_Post $post The post in question. 306 * @param bool $leavename Whether to keep the post name. 307 */ 308 return apply_filters( 'post_link', $permalink, $post, $leavename ); 309 } 310 311 /** 312 * Retrieves the permalink for a post of a custom post type. 313 * 314 * @since 3.0.0 315 * @since 6.1.0 Returns false if the post does not exist. 316 * 317 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 318 * 319 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 320 * @param bool $leavename Optional. Whether to keep post name. Default false. 321 * @param bool $sample Optional. Is it a sample permalink. Default false. 322 * @return string|false The post permalink URL. False if the post does not exist. 323 */ 324 function get_post_permalink( $post = 0, $leavename = false, $sample = false ) { 325 global $wp_rewrite; 326 327 $post = get_post( $post ); 328 329 if ( ! $post ) { 330 return false; 331 } 332 333 $post_link = $wp_rewrite->get_extra_permastruct( $post->post_type ); 334 335 $slug = $post->post_name; 336 337 $force_plain_link = wp_force_plain_post_permalink( $post ); 338 339 $post_type = get_post_type_object( $post->post_type ); 340 341 if ( $post_type->hierarchical ) { 342 $slug = get_page_uri( $post ); 343 } 344 345 if ( ! empty( $post_link ) && ( ! $force_plain_link || $sample ) ) { 346 if ( ! $leavename ) { 347 $post_link = str_replace( "%$post->post_type%", $slug, $post_link ); 348 } 349 $post_link = home_url( user_trailingslashit( $post_link ) ); 350 } else { 351 if ( $post_type->query_var && ( isset( $post->post_status ) && ! $force_plain_link ) ) { 352 $post_link = add_query_arg( $post_type->query_var, $slug, '' ); 353 } else { 354 $post_link = add_query_arg( 355 array( 356 'post_type' => $post->post_type, 357 'p' => $post->ID, 358 ), 359 '' 360 ); 361 } 362 $post_link = home_url( $post_link ); 363 } 364 365 /** 366 * Filters the permalink for a post of a custom post type. 367 * 368 * @since 3.0.0 369 * 370 * @param string $post_link The post's permalink. 371 * @param WP_Post $post The post in question. 372 * @param bool $leavename Whether to keep the post name. 373 * @param bool $sample Is it a sample permalink. 374 */ 375 return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample ); 376 } 377 378 /** 379 * Retrieves the permalink for the current page or page ID. 380 * 381 * Respects page_on_front. Use this one. 382 * 383 * @since 1.5.0 384 * 385 * @param int|WP_Post $post Optional. Post ID or object. Default uses the global `$post`. 386 * @param bool $leavename Optional. Whether to keep the page name. Default false. 387 * @param bool $sample Optional. Whether it should be treated as a sample permalink. 388 * Default false. 389 * @return string The page permalink. 390 */ 391 function get_page_link( $post = false, $leavename = false, $sample = false ) { 392 $post = get_post( $post ); 393 394 if ( 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID ) { 395 $link = home_url( '/' ); 396 } else { 397 $link = _get_page_link( $post, $leavename, $sample ); 398 } 399 400 /** 401 * Filters the permalink for a page. 402 * 403 * @since 1.5.0 404 * 405 * @param string $link The page's permalink. 406 * @param int $post_id The ID of the page. 407 * @param bool $sample Is it a sample permalink. 408 */ 409 return apply_filters( 'page_link', $link, $post->ID, $sample ); 410 } 411 412 /** 413 * Retrieves the page permalink. 414 * 415 * Ignores page_on_front. Internal use only. 416 * 417 * @since 2.1.0 418 * @access private 419 * 420 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 421 * 422 * @param int|WP_Post $post Optional. Post ID or object. Default uses the global `$post`. 423 * @param bool $leavename Optional. Whether to keep the page name. Default false. 424 * @param bool $sample Optional. Whether it should be treated as a sample permalink. 425 * Default false. 426 * @return string The page permalink. 427 */ 428 function _get_page_link( $post = false, $leavename = false, $sample = false ) { 429 global $wp_rewrite; 430 431 $post = get_post( $post ); 432 433 $force_plain_link = wp_force_plain_post_permalink( $post ); 434 435 $link = $wp_rewrite->get_page_permastruct(); 436 437 if ( ! empty( $link ) && ( ( isset( $post->post_status ) && ! $force_plain_link ) || $sample ) ) { 438 if ( ! $leavename ) { 439 $link = str_replace( '%pagename%', get_page_uri( $post ), $link ); 440 } 441 442 $link = home_url( $link ); 443 $link = user_trailingslashit( $link, 'page' ); 444 } else { 445 $link = home_url( '?page_id=' . $post->ID ); 446 } 447 448 /** 449 * Filters the permalink for a non-page_on_front page. 450 * 451 * @since 2.1.0 452 * 453 * @param string $link The page's permalink. 454 * @param int $post_id The ID of the page. 455 */ 456 return apply_filters( '_get_page_link', $link, $post->ID ); 457 } 458 459 /** 460 * Retrieves the permalink for an attachment. 461 * 462 * This can be used in the WordPress Loop or outside of it. 463 * 464 * @since 2.0.0 465 * 466 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 467 * 468 * @param int|WP_Post $post Optional. Post ID or object. Default uses the global `$post`. 469 * @param bool $leavename Optional. Whether to keep the page name. Default false. 470 * @return string The attachment permalink. 471 */ 472 function get_attachment_link( $post = null, $leavename = false ) { 473 global $wp_rewrite; 474 475 $link = false; 476 477 $post = get_post( $post ); 478 $force_plain_link = wp_force_plain_post_permalink( $post ); 479 $parent_id = $post->post_parent; 480 $parent = $parent_id ? get_post( $parent_id ) : false; 481 $parent_valid = true; // Default for no parent. 482 if ( 483 $parent_id && 484 ( 485 $post->post_parent === $post->ID || 486 ! $parent || 487 ! is_post_type_viewable( get_post_type( $parent ) ) 488 ) 489 ) { 490 // Post is either its own parent or parent post unavailable. 491 $parent_valid = false; 492 } 493 494 if ( $force_plain_link || ! $parent_valid ) { 495 $link = false; 496 } elseif ( $wp_rewrite->using_permalinks() && $parent ) { 497 if ( 'page' === $parent->post_type ) { 498 $parentlink = _get_page_link( $post->post_parent ); // Ignores page_on_front. 499 } else { 500 $parentlink = get_permalink( $post->post_parent ); 501 } 502 503 if ( is_numeric( $post->post_name ) || str_contains( get_option( 'permalink_structure' ), '%category%' ) ) { 504 $name = 'attachment/' . $post->post_name; // <permalink>/<int>/ is paged so we use the explicit attachment marker. 505 } else { 506 $name = $post->post_name; 507 } 508 509 if ( ! str_contains( $parentlink, '?' ) ) { 510 $link = user_trailingslashit( trailingslashit( $parentlink ) . '%postname%' ); 511 } 512 513 if ( ! $leavename ) { 514 $link = str_replace( '%postname%', $name, $link ); 515 } 516 } elseif ( $wp_rewrite->using_permalinks() && ! $leavename ) { 517 $link = home_url( user_trailingslashit( $post->post_name ) ); 518 } 519 520 if ( ! $link ) { 521 $link = home_url( '/?attachment_id=' . $post->ID ); 522 } 523 524 /** 525 * Filters the permalink for an attachment. 526 * 527 * @since 2.0.0 528 * @since 5.6.0 Providing an empty string will now disable 529 * the view attachment page link on the media modal. 530 * 531 * @param string $link The attachment's permalink. 532 * @param int $post_id Attachment ID. 533 */ 534 return apply_filters( 'attachment_link', $link, $post->ID ); 535 } 536 537 /** 538 * Retrieves the permalink for the year archives. 539 * 540 * @since 1.5.0 541 * 542 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 543 * 544 * @param int|false $year Integer of year. False for current year. 545 * @return string The permalink for the specified year archive. 546 */ 547 function get_year_link( $year ) { 548 global $wp_rewrite; 549 if ( ! $year ) { 550 $year = current_time( 'Y' ); 551 } 552 $yearlink = $wp_rewrite->get_year_permastruct(); 553 if ( ! empty( $yearlink ) ) { 554 $yearlink = str_replace( '%year%', $year, $yearlink ); 555 $yearlink = home_url( user_trailingslashit( $yearlink, 'year' ) ); 556 } else { 557 $yearlink = home_url( '?m=' . $year ); 558 } 559 560 /** 561 * Filters the year archive permalink. 562 * 563 * @since 1.5.0 564 * 565 * @param string $yearlink Permalink for the year archive. 566 * @param int $year Year for the archive. 567 */ 568 return apply_filters( 'year_link', $yearlink, $year ); 569 } 570 571 /** 572 * Retrieves the permalink for the month archives with year. 573 * 574 * @since 1.0.0 575 * 576 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 577 * 578 * @param int|false $year Integer of year. False for current year. 579 * @param int|false $month Integer of month. False for current month. 580 * @return string The permalink for the specified month and year archive. 581 */ 582 function get_month_link( $year, $month ) { 583 global $wp_rewrite; 584 if ( ! $year ) { 585 $year = current_time( 'Y' ); 586 } 587 if ( ! $month ) { 588 $month = current_time( 'm' ); 589 } 590 $monthlink = $wp_rewrite->get_month_permastruct(); 591 if ( ! empty( $monthlink ) ) { 592 $monthlink = str_replace( '%year%', $year, $monthlink ); 593 $monthlink = str_replace( '%monthnum%', zeroise( (int) $month, 2 ), $monthlink ); 594 $monthlink = home_url( user_trailingslashit( $monthlink, 'month' ) ); 595 } else { 596 $monthlink = home_url( '?m=' . $year . zeroise( $month, 2 ) ); 597 } 598 599 /** 600 * Filters the month archive permalink. 601 * 602 * @since 1.5.0 603 * 604 * @param string $monthlink Permalink for the month archive. 605 * @param int $year Year for the archive. 606 * @param int $month The month for the archive. 607 */ 608 return apply_filters( 'month_link', $monthlink, $year, $month ); 609 } 610 611 /** 612 * Retrieves the permalink for the day archives with year and month. 613 * 614 * @since 1.0.0 615 * 616 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 617 * 618 * @param int|false $year Integer of year. False for current year. 619 * @param int|false $month Integer of month. False for current month. 620 * @param int|false $day Integer of day. False for current day. 621 * @return string The permalink for the specified day, month, and year archive. 622 */ 623 function get_day_link( $year, $month, $day ) { 624 global $wp_rewrite; 625 if ( ! $year ) { 626 $year = current_time( 'Y' ); 627 } 628 if ( ! $month ) { 629 $month = current_time( 'm' ); 630 } 631 if ( ! $day ) { 632 $day = current_time( 'j' ); 633 } 634 635 $daylink = $wp_rewrite->get_day_permastruct(); 636 if ( ! empty( $daylink ) ) { 637 $daylink = str_replace( '%year%', $year, $daylink ); 638 $daylink = str_replace( '%monthnum%', zeroise( (int) $month, 2 ), $daylink ); 639 $daylink = str_replace( '%day%', zeroise( (int) $day, 2 ), $daylink ); 640 $daylink = home_url( user_trailingslashit( $daylink, 'day' ) ); 641 } else { 642 $daylink = home_url( '?m=' . $year . zeroise( $month, 2 ) . zeroise( $day, 2 ) ); 643 } 644 645 /** 646 * Filters the day archive permalink. 647 * 648 * @since 1.5.0 649 * 650 * @param string $daylink Permalink for the day archive. 651 * @param int $year Year for the archive. 652 * @param int $month Month for the archive. 653 * @param int $day The day for the archive. 654 */ 655 return apply_filters( 'day_link', $daylink, $year, $month, $day ); 656 } 657 658 /** 659 * Displays the permalink for the feed type. 660 * 661 * @since 3.0.0 662 * 663 * @param string $anchor The link's anchor text. 664 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 665 * Default is the value of get_default_feed(). 666 */ 667 function the_feed_link( $anchor, $feed = '' ) { 668 $link = '<a href="' . esc_url( get_feed_link( $feed ) ) . '">' . $anchor . '</a>'; 669 670 /** 671 * Filters the feed link anchor tag. 672 * 673 * @since 3.0.0 674 * 675 * @param string $link The complete anchor tag for a feed link. 676 * @param string $feed The feed type. Possible values include 'rss2', 'atom', 677 * or an empty string for the default feed type. 678 */ 679 echo apply_filters( 'the_feed_link', $link, $feed ); 680 } 681 682 /** 683 * Retrieves the permalink for the feed type. 684 * 685 * @since 1.5.0 686 * 687 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 688 * 689 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 690 * Default is the value of get_default_feed(). 691 * @return string The feed permalink. 692 */ 693 function get_feed_link( $feed = '' ) { 694 global $wp_rewrite; 695 696 $permalink = $wp_rewrite->get_feed_permastruct(); 697 698 if ( $permalink ) { 699 if ( str_contains( $feed, 'comments_' ) ) { 700 $feed = str_replace( 'comments_', '', $feed ); 701 $permalink = $wp_rewrite->get_comment_feed_permastruct(); 702 } 703 704 if ( get_default_feed() === $feed ) { 705 $feed = ''; 706 } 707 708 $permalink = str_replace( '%feed%', $feed, $permalink ); 709 $permalink = preg_replace( '#/+#', '/', "/$permalink" ); 710 $output = home_url( user_trailingslashit( $permalink, 'feed' ) ); 711 } else { 712 if ( empty( $feed ) ) { 713 $feed = get_default_feed(); 714 } 715 716 if ( str_contains( $feed, 'comments_' ) ) { 717 $feed = str_replace( 'comments_', 'comments-', $feed ); 718 } 719 720 $output = home_url( "?feed={$feed}" ); 721 } 722 723 /** 724 * Filters the feed type permalink. 725 * 726 * @since 1.5.0 727 * 728 * @param string $output The feed permalink. 729 * @param string $feed The feed type. Possible values include 'rss2', 'atom', 730 * or an empty string for the default feed type. 731 */ 732 return apply_filters( 'feed_link', $output, $feed ); 733 } 734 735 /** 736 * Retrieves the permalink for the post comments feed. 737 * 738 * @since 2.2.0 739 * 740 * @param int $post_id Optional. Post ID. Default is the ID of the global `$post`. 741 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 742 * Default is the value of get_default_feed(). 743 * @return string The permalink for the comments feed for the given post on success, empty string on failure. 744 */ 745 function get_post_comments_feed_link( $post_id = 0, $feed = '' ) { 746 $post_id = absint( $post_id ); 747 748 if ( ! $post_id ) { 749 $post_id = get_the_ID(); 750 } 751 752 if ( empty( $feed ) ) { 753 $feed = get_default_feed(); 754 } 755 756 $post = get_post( $post_id ); 757 758 // Bail out if the post does not exist. 759 if ( ! $post instanceof WP_Post ) { 760 return ''; 761 } 762 763 $unattached = 'attachment' === $post->post_type && 0 === (int) $post->post_parent; 764 765 if ( get_option( 'permalink_structure' ) ) { 766 if ( 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post_id ) { 767 $url = _get_page_link( $post_id ); 768 } else { 769 $url = get_permalink( $post_id ); 770 } 771 772 if ( $unattached ) { 773 $url = home_url( '/feed/' ); 774 if ( get_default_feed() !== $feed ) { 775 $url .= "$feed/"; 776 } 777 $url = add_query_arg( 'attachment_id', $post_id, $url ); 778 } else { 779 $url = trailingslashit( $url ) . 'feed'; 780 if ( get_default_feed() !== $feed ) { 781 $url .= "/$feed"; 782 } 783 $url = user_trailingslashit( $url, 'single_feed' ); 784 } 785 } else { 786 if ( $unattached ) { 787 $url = add_query_arg( 788 array( 789 'feed' => $feed, 790 'attachment_id' => $post_id, 791 ), 792 home_url( '/' ) 793 ); 794 } elseif ( 'page' === $post->post_type ) { 795 $url = add_query_arg( 796 array( 797 'feed' => $feed, 798 'page_id' => $post_id, 799 ), 800 home_url( '/' ) 801 ); 802 } else { 803 $url = add_query_arg( 804 array( 805 'feed' => $feed, 806 'p' => $post_id, 807 ), 808 home_url( '/' ) 809 ); 810 } 811 } 812 813 /** 814 * Filters the post comments feed permalink. 815 * 816 * @since 1.5.1 817 * 818 * @param string $url Post comments feed permalink. 819 */ 820 return apply_filters( 'post_comments_feed_link', $url ); 821 } 822 823 /** 824 * Displays the comment feed link for a post. 825 * 826 * Prints out the comment feed link for a post. Link text is placed in the 827 * anchor. If no link text is specified, default text is used. If no post ID is 828 * specified, the current post is used. 829 * 830 * @since 2.5.0 831 * 832 * @param string $link_text Optional. Descriptive link text. Default 'Comments Feed'. 833 * @param int $post_id Optional. Post ID. Default is the ID of the global `$post`. 834 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 835 * Default is the value of get_default_feed(). 836 */ 837 function post_comments_feed_link( $link_text = '', $post_id = '', $feed = '' ) { 838 $url = get_post_comments_feed_link( $post_id, $feed ); 839 if ( empty( $link_text ) ) { 840 $link_text = __( 'Comments Feed' ); 841 } 842 843 $link = '<a href="' . esc_url( $url ) . '">' . $link_text . '</a>'; 844 /** 845 * Filters the post comment feed link anchor tag. 846 * 847 * @since 2.8.0 848 * 849 * @param string $link The complete anchor tag for the comment feed link. 850 * @param int $post_id Post ID. 851 * @param string $feed The feed type. Possible values include 'rss2', 'atom', 852 * or an empty string for the default feed type. 853 */ 854 echo apply_filters( 'post_comments_feed_link_html', $link, $post_id, $feed ); 855 } 856 857 /** 858 * Retrieves the feed link for a given author. 859 * 860 * Returns a link to the feed for all posts by a given author. A specific feed 861 * can be requested or left blank to get the default feed. 862 * 863 * @since 2.5.0 864 * 865 * @param int $author_id Author ID. 866 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 867 * Default is the value of get_default_feed(). 868 * @return string Link to the feed for the author specified by $author_id. 869 */ 870 function get_author_feed_link( $author_id, $feed = '' ) { 871 $author_id = (int) $author_id; 872 $permalink_structure = get_option( 'permalink_structure' ); 873 874 if ( empty( $feed ) ) { 875 $feed = get_default_feed(); 876 } 877 878 if ( ! $permalink_structure ) { 879 $link = home_url( "?feed=$feed&author=" . $author_id ); 880 } else { 881 $link = get_author_posts_url( $author_id ); 882 if ( get_default_feed() === $feed ) { 883 $feed_link = 'feed'; 884 } else { 885 $feed_link = "feed/$feed"; 886 } 887 888 $link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' ); 889 } 890 891 /** 892 * Filters the feed link for a given author. 893 * 894 * @since 1.5.1 895 * 896 * @param string $link The author feed link. 897 * @param string $feed Feed type. Possible values include 'rss2', 'atom'. 898 */ 899 $link = apply_filters( 'author_feed_link', $link, $feed ); 900 901 return $link; 902 } 903 904 /** 905 * Retrieves the feed link for a category. 906 * 907 * Returns a link to the feed for all posts in a given category. A specific feed 908 * can be requested or left blank to get the default feed. 909 * 910 * @since 2.5.0 911 * 912 * @param int|WP_Term|object $cat The ID or category object whose feed link will be retrieved. 913 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 914 * Default is the value of get_default_feed(). 915 * @return string Link to the feed for the category specified by `$cat`. 916 */ 917 function get_category_feed_link( $cat, $feed = '' ) { 918 return get_term_feed_link( $cat, 'category', $feed ); 919 } 920 921 /** 922 * Retrieves the feed link for a term. 923 * 924 * Returns a link to the feed for all posts in a given term. A specific feed 925 * can be requested or left blank to get the default feed. 926 * 927 * @since 3.0.0 928 * 929 * @param int|WP_Term|object $term The ID or term object whose feed link will be retrieved. 930 * @param string $taxonomy Optional. Taxonomy of `$term_id`. 931 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 932 * Default is the value of get_default_feed(). 933 * @return string|false Link to the feed for the term specified by `$term` and `$taxonomy`. 934 */ 935 function get_term_feed_link( $term, $taxonomy = '', $feed = '' ) { 936 if ( ! is_object( $term ) ) { 937 $term = (int) $term; 938 } 939 940 $term = get_term( $term, $taxonomy ); 941 942 if ( empty( $term ) || is_wp_error( $term ) ) { 943 return false; 944 } 945 946 $taxonomy = $term->taxonomy; 947 948 if ( empty( $feed ) ) { 949 $feed = get_default_feed(); 950 } 951 952 $permalink_structure = get_option( 'permalink_structure' ); 953 954 if ( ! $permalink_structure ) { 955 if ( 'category' === $taxonomy ) { 956 $link = home_url( "?feed=$feed&cat=$term->term_id" ); 957 } elseif ( 'post_tag' === $taxonomy ) { 958 $link = home_url( "?feed=$feed&tag=$term->slug" ); 959 } else { 960 $t = get_taxonomy( $taxonomy ); 961 $link = home_url( "?feed=$feed&$t->query_var=$term->slug" ); 962 } 963 } else { 964 $link = get_term_link( $term, $term->taxonomy ); 965 if ( get_default_feed() === $feed ) { 966 $feed_link = 'feed'; 967 } else { 968 $feed_link = "feed/$feed"; 969 } 970 971 $link = trailingslashit( $link ) . user_trailingslashit( $feed_link, 'feed' ); 972 } 973 974 if ( 'category' === $taxonomy ) { 975 /** 976 * Filters the category feed link. 977 * 978 * @since 1.5.1 979 * 980 * @param string $link The category feed link. 981 * @param string $feed Feed type. Possible values include 'rss2', 'atom'. 982 */ 983 $link = apply_filters( 'category_feed_link', $link, $feed ); 984 } elseif ( 'post_tag' === $taxonomy ) { 985 /** 986 * Filters the post tag feed link. 987 * 988 * @since 2.3.0 989 * 990 * @param string $link The tag feed link. 991 * @param string $feed Feed type. Possible values include 'rss2', 'atom'. 992 */ 993 $link = apply_filters( 'tag_feed_link', $link, $feed ); 994 } else { 995 /** 996 * Filters the feed link for a taxonomy other than 'category' or 'post_tag'. 997 * 998 * @since 3.0.0 999 * 1000 * @param string $link The taxonomy feed link. 1001 * @param string $feed Feed type. Possible values include 'rss2', 'atom'. 1002 * @param string $taxonomy The taxonomy name. 1003 */ 1004 $link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy ); 1005 } 1006 1007 return $link; 1008 } 1009 1010 /** 1011 * Retrieves the permalink for a tag feed. 1012 * 1013 * @since 2.3.0 1014 * 1015 * @param int|WP_Term|object $tag The ID or term object whose feed link will be retrieved. 1016 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 1017 * Default is the value of get_default_feed(). 1018 * @return string The feed permalink for the given tag. 1019 */ 1020 function get_tag_feed_link( $tag, $feed = '' ) { 1021 return get_term_feed_link( $tag, 'post_tag', $feed ); 1022 } 1023 1024 /** 1025 * Retrieves the edit link for a tag. 1026 * 1027 * @since 2.7.0 1028 * 1029 * @param int|WP_Term|object $tag The ID or term object whose edit link will be retrieved. 1030 * @param string $taxonomy Optional. Taxonomy slug. Default 'post_tag'. 1031 * @return string The edit tag link URL for the given tag. 1032 */ 1033 function get_edit_tag_link( $tag, $taxonomy = 'post_tag' ) { 1034 /** 1035 * Filters the edit link for a tag (or term in another taxonomy). 1036 * 1037 * @since 2.7.0 1038 * 1039 * @param string $link The term edit link. 1040 */ 1041 return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag, $taxonomy ) ); 1042 } 1043 1044 /** 1045 * Displays or retrieves the edit link for a tag with formatting. 1046 * 1047 * @since 2.7.0 1048 * 1049 * @param string $link Optional. Anchor text. If empty, default is 'Edit This'. Default empty. 1050 * @param string $before Optional. Display before edit link. Default empty. 1051 * @param string $after Optional. Display after edit link. Default empty. 1052 * @param WP_Term $tag Optional. Term object. If null, the queried object will be inspected. 1053 * Default null. 1054 */ 1055 function edit_tag_link( $link = '', $before = '', $after = '', $tag = null ) { 1056 $link = edit_term_link( $link, '', '', $tag, false ); 1057 1058 /** 1059 * Filters the anchor tag for the edit link for a tag (or term in another taxonomy). 1060 * 1061 * @since 2.7.0 1062 * 1063 * @param string $link The anchor tag for the edit link. 1064 */ 1065 echo $before . apply_filters( 'edit_tag_link', $link ) . $after; 1066 } 1067 1068 /** 1069 * Retrieves the URL for editing a given term. 1070 * 1071 * @since 3.1.0 1072 * @since 4.5.0 The `$taxonomy` parameter was made optional. 1073 * 1074 * @param int|WP_Term|object $term The ID or term object whose edit link will be retrieved. 1075 * @param string $taxonomy Optional. Taxonomy. Defaults to the taxonomy of the term identified 1076 * by `$term`. 1077 * @param string $object_type Optional. The object type. Used to highlight the proper post type 1078 * menu on the linked page. Defaults to the first object_type associated 1079 * with the taxonomy. 1080 * @return string|null The edit term link URL for the given term, or null on failure. 1081 */ 1082 function get_edit_term_link( $term, $taxonomy = '', $object_type = '' ) { 1083 $term = get_term( $term, $taxonomy ); 1084 if ( ! $term || is_wp_error( $term ) ) { 1085 return; 1086 } 1087 1088 $tax = get_taxonomy( $term->taxonomy ); 1089 $term_id = $term->term_id; 1090 if ( ! $tax || ! current_user_can( 'edit_term', $term_id ) ) { 1091 return; 1092 } 1093 1094 $args = array( 1095 'taxonomy' => $tax->name, 1096 'tag_ID' => $term_id, 1097 ); 1098 1099 if ( $object_type ) { 1100 $args['post_type'] = $object_type; 1101 } elseif ( ! empty( $tax->object_type ) ) { 1102 $args['post_type'] = reset( $tax->object_type ); 1103 } 1104 1105 if ( $tax->show_ui ) { 1106 $location = add_query_arg( $args, admin_url( 'term.php' ) ); 1107 } else { 1108 $location = ''; 1109 } 1110 1111 /** 1112 * Filters the edit link for a term. 1113 * 1114 * @since 3.1.0 1115 * 1116 * @param string $location The edit link. 1117 * @param int $term_id Term ID. 1118 * @param string $taxonomy Taxonomy name. 1119 * @param string $object_type The object type. 1120 */ 1121 return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type ); 1122 } 1123 1124 /** 1125 * Displays or retrieves the edit term link with formatting. 1126 * 1127 * @since 3.1.0 1128 * 1129 * @param string $link Optional. Anchor text. If empty, default is 'Edit This'. Default empty. 1130 * @param string $before Optional. Display before edit link. Default empty. 1131 * @param string $after Optional. Display after edit link. Default empty. 1132 * @param int|WP_Term|null $term Optional. Term ID or object. If null, the queried object will be inspected. Default null. 1133 * @param bool $display Optional. Whether or not to echo the return. Default true. 1134 * @return string|void HTML content. 1135 */ 1136 function edit_term_link( $link = '', $before = '', $after = '', $term = null, $display = true ) { 1137 if ( is_null( $term ) ) { 1138 $term = get_queried_object(); 1139 } else { 1140 $term = get_term( $term ); 1141 } 1142 1143 if ( ! $term ) { 1144 return; 1145 } 1146 1147 $tax = get_taxonomy( $term->taxonomy ); 1148 if ( ! current_user_can( 'edit_term', $term->term_id ) ) { 1149 return; 1150 } 1151 1152 if ( empty( $link ) ) { 1153 $link = __( 'Edit This' ); 1154 } 1155 1156 $link = '<a href="' . get_edit_term_link( $term->term_id, $term->taxonomy ) . '">' . $link . '</a>'; 1157 1158 /** 1159 * Filters the anchor tag for the edit link of a term. 1160 * 1161 * @since 3.1.0 1162 * 1163 * @param string $link The anchor tag for the edit link. 1164 * @param int $term_id Term ID. 1165 */ 1166 $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after; 1167 1168 if ( $display ) { 1169 echo $link; 1170 } else { 1171 return $link; 1172 } 1173 } 1174 1175 /** 1176 * Retrieves the permalink for a search. 1177 * 1178 * @since 3.0.0 1179 * 1180 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 1181 * 1182 * @param string $query Optional. The query string to use. If empty the current query is used. Default empty. 1183 * @return string The search permalink. 1184 */ 1185 function get_search_link( $query = '' ) { 1186 global $wp_rewrite; 1187 1188 if ( empty( $query ) ) { 1189 $search = get_search_query( false ); 1190 } else { 1191 $search = stripslashes( $query ); 1192 } 1193 1194 $permastruct = $wp_rewrite->get_search_permastruct(); 1195 1196 if ( empty( $permastruct ) ) { 1197 $link = home_url( '?s=' . urlencode( $search ) ); 1198 } else { 1199 $search = urlencode( $search ); 1200 $search = str_replace( '%2F', '/', $search ); // %2F(/) is not valid within a URL, send it un-encoded. 1201 $link = str_replace( '%search%', $search, $permastruct ); 1202 $link = home_url( user_trailingslashit( $link, 'search' ) ); 1203 } 1204 1205 /** 1206 * Filters the search permalink. 1207 * 1208 * @since 3.0.0 1209 * 1210 * @param string $link Search permalink. 1211 * @param string $search The URL-encoded search term. 1212 */ 1213 return apply_filters( 'search_link', $link, $search ); 1214 } 1215 1216 /** 1217 * Retrieves the permalink for the search results feed. 1218 * 1219 * @since 2.5.0 1220 * 1221 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 1222 * 1223 * @param string $search_query Optional. Search query. Default empty. 1224 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 1225 * Default is the value of get_default_feed(). 1226 * @return string The search results feed permalink. 1227 */ 1228 function get_search_feed_link( $search_query = '', $feed = '' ) { 1229 global $wp_rewrite; 1230 $link = get_search_link( $search_query ); 1231 1232 if ( empty( $feed ) ) { 1233 $feed = get_default_feed(); 1234 } 1235 1236 $permastruct = $wp_rewrite->get_search_permastruct(); 1237 1238 if ( empty( $permastruct ) ) { 1239 $link = add_query_arg( 'feed', $feed, $link ); 1240 } else { 1241 $link = trailingslashit( $link ); 1242 $link .= "feed/$feed/"; 1243 } 1244 1245 /** 1246 * Filters the search feed link. 1247 * 1248 * @since 2.5.0 1249 * 1250 * @param string $link Search feed link. 1251 * @param string $feed Feed type. Possible values include 'rss2', 'atom'. 1252 * @param string $type The search type. One of 'posts' or 'comments'. 1253 */ 1254 return apply_filters( 'search_feed_link', $link, $feed, 'posts' ); 1255 } 1256 1257 /** 1258 * Retrieves the permalink for the search results comments feed. 1259 * 1260 * @since 2.5.0 1261 * 1262 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 1263 * 1264 * @param string $search_query Optional. Search query. Default empty. 1265 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 1266 * Default is the value of get_default_feed(). 1267 * @return string The comments feed search results permalink. 1268 */ 1269 function get_search_comments_feed_link( $search_query = '', $feed = '' ) { 1270 global $wp_rewrite; 1271 1272 if ( empty( $feed ) ) { 1273 $feed = get_default_feed(); 1274 } 1275 1276 $link = get_search_feed_link( $search_query, $feed ); 1277 1278 $permastruct = $wp_rewrite->get_search_permastruct(); 1279 1280 if ( empty( $permastruct ) ) { 1281 $link = add_query_arg( 'feed', 'comments-' . $feed, $link ); 1282 } else { 1283 $link = add_query_arg( 'withcomments', 1, $link ); 1284 } 1285 1286 /** This filter is documented in wp-includes/link-template.php */ 1287 return apply_filters( 'search_feed_link', $link, $feed, 'comments' ); 1288 } 1289 1290 /** 1291 * Retrieves the permalink for a post type archive. 1292 * 1293 * @since 3.1.0 1294 * @since 4.5.0 Support for posts was added. 1295 * 1296 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 1297 * 1298 * @param string $post_type Post type. 1299 * @return string|false The post type archive permalink. False if the post type 1300 * does not exist or does not have an archive. 1301 */ 1302 function get_post_type_archive_link( $post_type ) { 1303 global $wp_rewrite; 1304 1305 $post_type_obj = get_post_type_object( $post_type ); 1306 1307 if ( ! $post_type_obj ) { 1308 return false; 1309 } 1310 1311 if ( 'post' === $post_type ) { 1312 $show_on_front = get_option( 'show_on_front' ); 1313 $page_for_posts = get_option( 'page_for_posts' ); 1314 1315 if ( 'page' === $show_on_front && $page_for_posts ) { 1316 $link = get_permalink( $page_for_posts ); 1317 } else { 1318 $link = get_home_url(); 1319 } 1320 /** This filter is documented in wp-includes/link-template.php */ 1321 return apply_filters( 'post_type_archive_link', $link, $post_type ); 1322 } 1323 1324 if ( ! $post_type_obj->has_archive ) { 1325 return false; 1326 } 1327 1328 if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) ) { 1329 $struct = ( true === $post_type_obj->has_archive ) ? $post_type_obj->rewrite['slug'] : $post_type_obj->has_archive; 1330 if ( $post_type_obj->rewrite['with_front'] ) { 1331 $struct = $wp_rewrite->front . $struct; 1332 } else { 1333 $struct = $wp_rewrite->root . $struct; 1334 } 1335 $link = home_url( user_trailingslashit( $struct, 'post_type_archive' ) ); 1336 } else { 1337 $link = home_url( '?post_type=' . $post_type ); 1338 } 1339 1340 /** 1341 * Filters the post type archive permalink. 1342 * 1343 * @since 3.1.0 1344 * 1345 * @param string $link The post type archive permalink. 1346 * @param string $post_type Post type name. 1347 */ 1348 return apply_filters( 'post_type_archive_link', $link, $post_type ); 1349 } 1350 1351 /** 1352 * Retrieves the permalink for a post type archive feed. 1353 * 1354 * @since 3.1.0 1355 * 1356 * @param string $post_type Post type. 1357 * @param string $feed Optional. Feed type. Possible values include 'rss2', 'atom'. 1358 * Default is the value of get_default_feed(). 1359 * @return string|false The post type feed permalink. False if the post type 1360 * does not exist or does not have an archive. 1361 */ 1362 function get_post_type_archive_feed_link( $post_type, $feed = '' ) { 1363 $default_feed = get_default_feed(); 1364 if ( empty( $feed ) ) { 1365 $feed = $default_feed; 1366 } 1367 1368 $link = get_post_type_archive_link( $post_type ); 1369 if ( ! $link ) { 1370 return false; 1371 } 1372 1373 $post_type_obj = get_post_type_object( $post_type ); 1374 if ( get_option( 'permalink_structure' ) && is_array( $post_type_obj->rewrite ) && $post_type_obj->rewrite['feeds'] ) { 1375 $link = trailingslashit( $link ); 1376 $link .= 'feed/'; 1377 if ( $feed !== $default_feed ) { 1378 $link .= "$feed/"; 1379 } 1380 } else { 1381 $link = add_query_arg( 'feed', $feed, $link ); 1382 } 1383 1384 /** 1385 * Filters the post type archive feed link. 1386 * 1387 * @since 3.1.0 1388 * 1389 * @param string $link The post type archive feed link. 1390 * @param string $feed Feed type. Possible values include 'rss2', 'atom'. 1391 */ 1392 return apply_filters( 'post_type_archive_feed_link', $link, $feed ); 1393 } 1394 1395 /** 1396 * Retrieves the URL used for the post preview. 1397 * 1398 * Allows additional query args to be appended. 1399 * 1400 * @since 4.4.0 1401 * 1402 * @param int|WP_Post $post Optional. Post ID or `WP_Post` object. Defaults to global `$post`. 1403 * @param array $query_args Optional. Array of additional query args to be appended to the link. 1404 * Default empty array. 1405 * @param string $preview_link Optional. Base preview link to be used if it should differ from the 1406 * post permalink. Default empty. 1407 * @return string|null URL used for the post preview, or null if the post does not exist. 1408 */ 1409 function get_preview_post_link( $post = null, $query_args = array(), $preview_link = '' ) { 1410 $post = get_post( $post ); 1411 1412 if ( ! $post ) { 1413 return; 1414 } 1415 1416 $post_type_object = get_post_type_object( $post->post_type ); 1417 if ( is_post_type_viewable( $post_type_object ) ) { 1418 if ( ! $preview_link ) { 1419 $preview_link = set_url_scheme( get_permalink( $post ) ); 1420 } 1421 1422 $query_args['preview'] = 'true'; 1423 $preview_link = add_query_arg( $query_args, $preview_link ); 1424 } 1425 1426 /** 1427 * Filters the URL used for a post preview. 1428 * 1429 * @since 2.0.5 1430 * @since 4.0.0 Added the `$post` parameter. 1431 * 1432 * @param string $preview_link URL used for the post preview. 1433 * @param WP_Post $post Post object. 1434 */ 1435 return apply_filters( 'preview_post_link', $preview_link, $post ); 1436 } 1437 1438 /** 1439 * Retrieves the edit post link for post. 1440 * 1441 * Can be used within the WordPress loop or outside of it. Can be used with 1442 * pages, posts, attachments, revisions, global styles, templates, and template parts. 1443 * 1444 * @since 2.3.0 1445 * @since 6.3.0 Adds custom link for wp_navigation post types. 1446 * Adds custom links for wp_template_part and wp_template post types. 1447 * 1448 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 1449 * @param string $context Optional. How to output the '&' character. Default '&'. 1450 * @return string|null The edit post link for the given post. Null if the post type does not exist 1451 * or does not allow an editing UI. 1452 */ 1453 function get_edit_post_link( $post = 0, $context = 'display' ) { 1454 $post = get_post( $post ); 1455 1456 if ( ! $post ) { 1457 return; 1458 } 1459 1460 if ( 'revision' === $post->post_type ) { 1461 $action = ''; 1462 } elseif ( 'display' === $context ) { 1463 $action = '&action=edit'; 1464 } else { 1465 $action = '&action=edit'; 1466 } 1467 1468 $post_type_object = get_post_type_object( $post->post_type ); 1469 1470 if ( ! $post_type_object ) { 1471 return; 1472 } 1473 1474 if ( ! current_user_can( 'edit_post', $post->ID ) ) { 1475 return; 1476 } 1477 1478 $link = ''; 1479 1480 if ( 'wp_template' === $post->post_type || 'wp_template_part' === $post->post_type ) { 1481 $slug = urlencode( get_stylesheet() . '//' . $post->post_name ); 1482 $link = admin_url( sprintf( $post_type_object->_edit_link, $post->post_type, $slug ) ); 1483 } elseif ( 'wp_navigation' === $post->post_type ) { 1484 $link = admin_url( sprintf( $post_type_object->_edit_link, (string) $post->ID ) ); 1485 } elseif ( $post_type_object->_edit_link ) { 1486 $link = admin_url( sprintf( $post_type_object->_edit_link . $action, $post->ID ) ); 1487 } 1488 1489 /** 1490 * Filters the post edit link. 1491 * 1492 * @since 2.3.0 1493 * 1494 * @param string $link The edit link. 1495 * @param int $post_id Post ID. 1496 * @param string $context The link context. If set to 'display' then ampersands 1497 * are encoded. 1498 */ 1499 return apply_filters( 'get_edit_post_link', $link, $post->ID, $context ); 1500 } 1501 1502 /** 1503 * Displays the edit post link for post. 1504 * 1505 * @since 1.0.0 1506 * @since 4.4.0 The `$css_class` argument was added. 1507 * 1508 * @param string $text Optional. Anchor text. If null, default is 'Edit This'. Default null. 1509 * @param string $before Optional. Display before edit link. Default empty. 1510 * @param string $after Optional. Display after edit link. Default empty. 1511 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 1512 * @param string $css_class Optional. Add custom class to link. Default 'post-edit-link'. 1513 */ 1514 function edit_post_link( $text = null, $before = '', $after = '', $post = 0, $css_class = 'post-edit-link' ) { 1515 $post = get_post( $post ); 1516 1517 if ( ! $post ) { 1518 return; 1519 } 1520 1521 $url = get_edit_post_link( $post->ID ); 1522 1523 if ( ! $url ) { 1524 return; 1525 } 1526 1527 if ( null === $text ) { 1528 $text = __( 'Edit This' ); 1529 } 1530 1531 $link = '<a class="' . esc_attr( $css_class ) . '" href="' . esc_url( $url ) . '">' . $text . '</a>'; 1532 1533 /** 1534 * Filters the post edit link anchor tag. 1535 * 1536 * @since 2.3.0 1537 * 1538 * @param string $link Anchor tag for the edit link. 1539 * @param int $post_id Post ID. 1540 * @param string $text Anchor text. 1541 */ 1542 echo $before . apply_filters( 'edit_post_link', $link, $post->ID, $text ) . $after; 1543 } 1544 1545 /** 1546 * Retrieves the delete posts link for post. 1547 * 1548 * Can be used within the WordPress loop or outside of it, with any post type. 1549 * 1550 * @since 2.9.0 1551 * 1552 * @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`. 1553 * @param string $deprecated Not used. 1554 * @param bool $force_delete Optional. Whether to bypass Trash and force deletion. Default false. 1555 * @return string|void The delete post link URL for the given post. 1556 */ 1557 function get_delete_post_link( $post = 0, $deprecated = '', $force_delete = false ) { 1558 if ( ! empty( $deprecated ) ) { 1559 _deprecated_argument( __FUNCTION__, '3.0.0' ); 1560 } 1561 1562 $post = get_post( $post ); 1563 1564 if ( ! $post ) { 1565 return; 1566 } 1567 1568 $post_type_object = get_post_type_object( $post->post_type ); 1569 1570 if ( ! $post_type_object ) { 1571 return; 1572 } 1573 1574 if ( ! current_user_can( 'delete_post', $post->ID ) ) { 1575 return; 1576 } 1577 1578 $action = ( $force_delete || ! EMPTY_TRASH_DAYS ) ? 'delete' : 'trash'; 1579 1580 $delete_link = add_query_arg( 'action', $action, admin_url( sprintf( $post_type_object->_edit_link, $post->ID ) ) ); 1581 1582 /** 1583 * Filters the post delete link. 1584 * 1585 * @since 2.9.0 1586 * 1587 * @param string $link The delete link. 1588 * @param int $post_id Post ID. 1589 * @param bool $force_delete Whether to bypass the Trash and force deletion. Default false. 1590 */ 1591 return apply_filters( 'get_delete_post_link', wp_nonce_url( $delete_link, "$action-post_{$post->ID}" ), $post->ID, $force_delete ); 1592 } 1593 1594 /** 1595 * Retrieves the edit comment link. 1596 * 1597 * @since 2.3.0 1598 * @since 6.7.0 The $context parameter was added. 1599 * 1600 * @param int|WP_Comment $comment_id Optional. Comment ID or WP_Comment object. 1601 * @param string $context Optional. Context in which the URL should be used. Either 'display', 1602 * to include HTML entities, or 'url'. Default 'display'. 1603 * @return string|void The edit comment link URL for the given comment, or void if the comment id does not exist or 1604 * the current user is not allowed to edit it. 1605 */ 1606 function get_edit_comment_link( $comment_id = 0, $context = 'display' ) { 1607 $comment = get_comment( $comment_id ); 1608 1609 if ( ! is_object( $comment ) || ! current_user_can( 'edit_comment', $comment->comment_ID ) ) { 1610 return; 1611 } 1612 1613 if ( 'display' === $context ) { 1614 $action = 'comment.php?action=editcomment&c='; 1615 } else { 1616 $action = 'comment.php?action=editcomment&c='; 1617 } 1618 1619 $location = admin_url( $action ) . $comment->comment_ID; 1620 1621 // Ensure the $comment_id variable passed to the filter is always an ID. 1622 $comment_id = (int) $comment->comment_ID; 1623 1624 /** 1625 * Filters the comment edit link. 1626 * 1627 * @since 2.3.0 1628 * @since 6.7.0 The $comment_id and $context parameters are now being passed to the filter. 1629 * 1630 * @param string $location The edit link. 1631 * @param int $comment_id Unique ID of the comment to generate an edit link. 1632 * @param string $context Context to include HTML entities in link. Default 'display'. 1633 */ 1634 return apply_filters( 'get_edit_comment_link', $location, $comment_id, $context ); 1635 } 1636 1637 /** 1638 * Displays the edit comment link with formatting. 1639 * 1640 * @since 1.0.0 1641 * 1642 * @param string $text Optional. Anchor text. If null, default is 'Edit This'. Default null. 1643 * @param string $before Optional. Display before edit link. Default empty. 1644 * @param string $after Optional. Display after edit link. Default empty. 1645 */ 1646 function edit_comment_link( $text = null, $before = '', $after = '' ) { 1647 $comment = get_comment(); 1648 1649 if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) { 1650 return; 1651 } 1652 1653 if ( null === $text ) { 1654 $text = __( 'Edit This' ); 1655 } 1656 1657 $link = '<a class="comment-edit-link" href="' . esc_url( get_edit_comment_link( $comment ) ) . '">' . $text . '</a>'; 1658 1659 /** 1660 * Filters the comment edit link anchor tag. 1661 * 1662 * @since 2.3.0 1663 * 1664 * @param string $link Anchor tag for the edit link. 1665 * @param string $comment_id Comment ID as a numeric string. 1666 * @param string $text Anchor text. 1667 */ 1668 echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after; 1669 } 1670 1671 /** 1672 * Displays the edit bookmark link. 1673 * 1674 * @since 2.7.0 1675 * 1676 * @param int|stdClass $link Optional. Bookmark ID. Default is the ID of the current bookmark. 1677 * @return string|void The edit bookmark link URL. 1678 */ 1679 function get_edit_bookmark_link( $link = 0 ) { 1680 $link = get_bookmark( $link ); 1681 1682 if ( ! current_user_can( 'manage_links' ) ) { 1683 return; 1684 } 1685 1686 $location = admin_url( 'link.php?action=edit&link_id=' ) . $link->link_id; 1687 1688 /** 1689 * Filters the bookmark edit link. 1690 * 1691 * @since 2.7.0 1692 * 1693 * @param string $location The edit link. 1694 * @param int $link_id Bookmark ID. 1695 */ 1696 return apply_filters( 'get_edit_bookmark_link', $location, $link->link_id ); 1697 } 1698 1699 /** 1700 * Displays the edit bookmark link anchor content. 1701 * 1702 * @since 2.7.0 1703 * 1704 * @param string $link Optional. Anchor text. If empty, default is 'Edit This'. Default empty. 1705 * @param string $before Optional. Display before edit link. Default empty. 1706 * @param string $after Optional. Display after edit link. Default empty. 1707 * @param int $bookmark Optional. Bookmark ID. Default is the current bookmark. 1708 */ 1709 function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark = null ) { 1710 $bookmark = get_bookmark( $bookmark ); 1711 1712 if ( ! current_user_can( 'manage_links' ) ) { 1713 return; 1714 } 1715 1716 if ( empty( $link ) ) { 1717 $link = __( 'Edit This' ); 1718 } 1719 1720 $link = '<a href="' . esc_url( get_edit_bookmark_link( $bookmark ) ) . '">' . $link . '</a>'; 1721 1722 /** 1723 * Filters the bookmark edit link anchor tag. 1724 * 1725 * @since 2.7.0 1726 * 1727 * @param string $link Anchor tag for the edit link. 1728 * @param int $link_id Bookmark ID. 1729 */ 1730 echo $before . apply_filters( 'edit_bookmark_link', $link, $bookmark->link_id ) . $after; 1731 } 1732 1733 /** 1734 * Retrieves the edit user link. 1735 * 1736 * @since 3.5.0 1737 * 1738 * @param int $user_id Optional. User ID. Defaults to the current user. 1739 * @return string URL to edit user page or empty string. 1740 */ 1741 function get_edit_user_link( $user_id = null ) { 1742 if ( ! $user_id ) { 1743 $user_id = get_current_user_id(); 1744 } 1745 1746 if ( empty( $user_id ) || ! current_user_can( 'edit_user', $user_id ) ) { 1747 return ''; 1748 } 1749 1750 $user = get_userdata( $user_id ); 1751 1752 if ( ! $user ) { 1753 return ''; 1754 } 1755 1756 if ( get_current_user_id() === $user->ID ) { 1757 $link = get_edit_profile_url( $user->ID ); 1758 } else { 1759 $link = add_query_arg( 'user_id', $user->ID, self_admin_url( 'user-edit.php' ) ); 1760 } 1761 1762 /** 1763 * Filters the user edit link. 1764 * 1765 * @since 3.5.0 1766 * 1767 * @param string $link The edit link. 1768 * @param int $user_id User ID. 1769 */ 1770 return apply_filters( 'get_edit_user_link', $link, $user->ID ); 1771 } 1772 1773 // 1774 // Navigation links. 1775 // 1776 1777 /** 1778 * Retrieves the previous post that is adjacent to the current post. 1779 * 1780 * @since 1.5.0 1781 * 1782 * @param bool $in_same_term Optional. Whether post should be in the same taxonomy term. 1783 * Default false. 1784 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 1785 * Default empty. 1786 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 1787 * @return WP_Post|null|string Post object if successful. Null if global `$post` is not set. 1788 * Empty string if no corresponding post exists. 1789 */ 1790 function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 1791 return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy ); 1792 } 1793 1794 /** 1795 * Retrieves the next post that is adjacent to the current post. 1796 * 1797 * @since 1.5.0 1798 * 1799 * @param bool $in_same_term Optional. Whether post should be in the same taxonomy term. 1800 * Default false. 1801 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 1802 * Default empty. 1803 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 1804 * @return WP_Post|null|string Post object if successful. Null if global `$post` is not set. 1805 * Empty string if no corresponding post exists. 1806 */ 1807 function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 1808 return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy ); 1809 } 1810 1811 /** 1812 * Retrieves the adjacent post. 1813 * 1814 * Can either be next or previous post. 1815 * 1816 * @since 2.5.0 1817 * 1818 * @global wpdb $wpdb WordPress database abstraction object. 1819 * 1820 * @param bool $in_same_term Optional. Whether post should be in the same taxonomy term. 1821 * Default false. 1822 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 1823 * Default empty string. 1824 * @param bool $previous Optional. Whether to retrieve previous post. 1825 * Default true. 1826 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 1827 * @return WP_Post|null|string Post object if successful. Null if global `$post` is not set. 1828 * Empty string if no corresponding post exists. 1829 */ 1830 function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { 1831 global $wpdb; 1832 1833 $post = get_post(); 1834 1835 if ( ! $post || ! taxonomy_exists( $taxonomy ) ) { 1836 return null; 1837 } 1838 1839 $current_post_date = $post->post_date; 1840 1841 $join = ''; 1842 $where = ''; 1843 $adjacent = $previous ? 'previous' : 'next'; 1844 1845 if ( ! empty( $excluded_terms ) && ! is_array( $excluded_terms ) ) { 1846 // Back-compat, $excluded_terms used to be $excluded_categories with IDs separated by " and ". 1847 if ( str_contains( $excluded_terms, ' and ' ) ) { 1848 _deprecated_argument( 1849 __FUNCTION__, 1850 '3.3.0', 1851 sprintf( 1852 /* translators: %s: The word 'and'. */ 1853 __( 'Use commas instead of %s to separate excluded terms.' ), 1854 "'and'" 1855 ) 1856 ); 1857 $excluded_terms = explode( ' and ', $excluded_terms ); 1858 } else { 1859 $excluded_terms = explode( ',', $excluded_terms ); 1860 } 1861 1862 $excluded_terms = array_map( 'intval', $excluded_terms ); 1863 } 1864 1865 /** 1866 * Filters the IDs of terms excluded from adjacent post queries. 1867 * 1868 * The dynamic portion of the hook name, `$adjacent`, refers to the type 1869 * of adjacency, 'next' or 'previous'. 1870 * 1871 * Possible hook names include: 1872 * 1873 * - `get_next_post_excluded_terms` 1874 * - `get_previous_post_excluded_terms` 1875 * 1876 * @since 4.4.0 1877 * 1878 * @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided. 1879 */ 1880 $excluded_terms = apply_filters( "get_{$adjacent}_post_excluded_terms", $excluded_terms ); 1881 1882 if ( $in_same_term || ! empty( $excluded_terms ) ) { 1883 if ( $in_same_term ) { 1884 $join .= " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id"; 1885 $where .= $wpdb->prepare( 'AND tt.taxonomy = %s', $taxonomy ); 1886 1887 if ( ! is_object_in_taxonomy( $post->post_type, $taxonomy ) ) { 1888 return ''; 1889 } 1890 $term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); 1891 1892 // Remove any exclusions from the term array to include. 1893 $term_array = array_diff( $term_array, (array) $excluded_terms ); 1894 $term_array = array_map( 'intval', $term_array ); 1895 1896 if ( ! $term_array || is_wp_error( $term_array ) ) { 1897 return ''; 1898 } 1899 1900 $where .= ' AND tt.term_id IN (' . implode( ',', $term_array ) . ')'; 1901 } 1902 1903 if ( ! empty( $excluded_terms ) ) { 1904 $where .= " AND p.ID NOT IN ( SELECT tr.object_id FROM $wpdb->term_relationships tr LEFT JOIN $wpdb->term_taxonomy tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id) WHERE tt.term_id IN (" . implode( ',', array_map( 'intval', $excluded_terms ) ) . ') )'; 1905 } 1906 } 1907 1908 // 'post_status' clause depends on the current user. 1909 if ( is_user_logged_in() ) { 1910 $user_id = get_current_user_id(); 1911 1912 $post_type_object = get_post_type_object( $post->post_type ); 1913 if ( empty( $post_type_object ) ) { 1914 $post_type_cap = $post->post_type; 1915 $read_private_cap = 'read_private_' . $post_type_cap . 's'; 1916 } else { 1917 $read_private_cap = $post_type_object->cap->read_private_posts; 1918 } 1919 1920 /* 1921 * Results should include private posts belonging to the current user, or private posts where the 1922 * current user has the 'read_private_posts' cap. 1923 */ 1924 $private_states = get_post_stati( array( 'private' => true ) ); 1925 $where .= " AND ( p.post_status = 'publish'"; 1926 foreach ( $private_states as $state ) { 1927 if ( current_user_can( $read_private_cap ) ) { 1928 $where .= $wpdb->prepare( ' OR p.post_status = %s', $state ); 1929 } else { 1930 $where .= $wpdb->prepare( ' OR (p.post_author = %d AND p.post_status = %s)', $user_id, $state ); 1931 } 1932 } 1933 $where .= ' )'; 1934 } else { 1935 $where .= " AND p.post_status = 'publish'"; 1936 } 1937 1938 $op = $previous ? '<' : '>'; 1939 $order = $previous ? 'DESC' : 'ASC'; 1940 1941 /** 1942 * Filters the JOIN clause in the SQL for an adjacent post query. 1943 * 1944 * The dynamic portion of the hook name, `$adjacent`, refers to the type 1945 * of adjacency, 'next' or 'previous'. 1946 * 1947 * Possible hook names include: 1948 * 1949 * - `get_next_post_join` 1950 * - `get_previous_post_join` 1951 * 1952 * @since 2.5.0 1953 * @since 4.4.0 Added the `$taxonomy` and `$post` parameters. 1954 * 1955 * @param string $join The JOIN clause in the SQL. 1956 * @param bool $in_same_term Whether post should be in the same taxonomy term. 1957 * @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided. 1958 * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. 1959 * @param WP_Post $post WP_Post object. 1960 */ 1961 $join = apply_filters( "get_{$adjacent}_post_join", $join, $in_same_term, $excluded_terms, $taxonomy, $post ); 1962 1963 /** 1964 * Filters the WHERE clause in the SQL for an adjacent post query. 1965 * 1966 * The dynamic portion of the hook name, `$adjacent`, refers to the type 1967 * of adjacency, 'next' or 'previous'. 1968 * 1969 * Possible hook names include: 1970 * 1971 * - `get_next_post_where` 1972 * - `get_previous_post_where` 1973 * 1974 * @since 2.5.0 1975 * @since 4.4.0 Added the `$taxonomy` and `$post` parameters. 1976 * 1977 * @param string $where The `WHERE` clause in the SQL. 1978 * @param bool $in_same_term Whether post should be in the same taxonomy term. 1979 * @param int[]|string $excluded_terms Array of excluded term IDs. Empty string if none were provided. 1980 * @param string $taxonomy Taxonomy. Used to identify the term used when `$in_same_term` is true. 1981 * @param WP_Post $post WP_Post object. 1982 */ 1983 $where = apply_filters( "get_{$adjacent}_post_where", $wpdb->prepare( "WHERE p.post_date $op %s AND p.post_type = %s $where", $current_post_date, $post->post_type ), $in_same_term, $excluded_terms, $taxonomy, $post ); 1984 1985 /** 1986 * Filters the ORDER BY clause in the SQL for an adjacent post query. 1987 * 1988 * The dynamic portion of the hook name, `$adjacent`, refers to the type 1989 * of adjacency, 'next' or 'previous'. 1990 * 1991 * Possible hook names include: 1992 * 1993 * - `get_next_post_sort` 1994 * - `get_previous_post_sort` 1995 * 1996 * @since 2.5.0 1997 * @since 4.4.0 Added the `$post` parameter. 1998 * @since 4.9.0 Added the `$order` parameter. 1999 * 2000 * @param string $order_by The `ORDER BY` clause in the SQL. 2001 * @param WP_Post $post WP_Post object. 2002 * @param string $order Sort order. 'DESC' for previous post, 'ASC' for next. 2003 */ 2004 $sort = apply_filters( "get_{$adjacent}_post_sort", "ORDER BY p.post_date $order LIMIT 1", $post, $order ); 2005 2006 $query = "SELECT p.ID FROM $wpdb->posts AS p $join $where $sort"; 2007 $key = md5( $query ); 2008 $last_changed = wp_cache_get_last_changed( 'posts' ); 2009 if ( $in_same_term || ! empty( $excluded_terms ) ) { 2010 $last_changed .= wp_cache_get_last_changed( 'terms' ); 2011 } 2012 $cache_key = "adjacent_post:$key:$last_changed"; 2013 2014 $result = wp_cache_get( $cache_key, 'post-queries' ); 2015 if ( false !== $result ) { 2016 if ( $result ) { 2017 $result = get_post( $result ); 2018 } 2019 return $result; 2020 } 2021 2022 $result = $wpdb->get_var( $query ); 2023 if ( null === $result ) { 2024 $result = ''; 2025 } 2026 2027 wp_cache_set( $cache_key, $result, 'post-queries' ); 2028 2029 if ( $result ) { 2030 $result = get_post( $result ); 2031 } 2032 2033 return $result; 2034 } 2035 2036 /** 2037 * Retrieves the adjacent post relational link. 2038 * 2039 * Can either be next or previous post relational link. 2040 * 2041 * @since 2.8.0 2042 * 2043 * @param string $title Optional. Link title format. Default '%title'. 2044 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2045 * Default false. 2046 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2047 * Default empty. 2048 * @param bool $previous Optional. Whether to display link to previous or next post. 2049 * Default true. 2050 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2051 * @return string|void The adjacent post relational link URL. 2052 */ 2053 function get_adjacent_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { 2054 $post = get_post(); 2055 if ( $previous && is_attachment() && $post ) { 2056 $post = get_post( $post->post_parent ); 2057 } else { 2058 $post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy ); 2059 } 2060 2061 if ( empty( $post ) ) { 2062 return; 2063 } 2064 2065 $post_title = the_title_attribute( 2066 array( 2067 'echo' => false, 2068 'post' => $post, 2069 ) 2070 ); 2071 2072 if ( empty( $post_title ) ) { 2073 $post_title = $previous ? __( 'Previous Post' ) : __( 'Next Post' ); 2074 } 2075 2076 $date = mysql2date( get_option( 'date_format' ), $post->post_date ); 2077 2078 $title = str_replace( '%title', $post_title, $title ); 2079 $title = str_replace( '%date', $date, $title ); 2080 2081 $link = $previous ? "<link rel='prev' title='" : "<link rel='next' title='"; 2082 $link .= esc_attr( $title ); 2083 $link .= "' href='" . get_permalink( $post ) . "' />\n"; 2084 2085 $adjacent = $previous ? 'previous' : 'next'; 2086 2087 /** 2088 * Filters the adjacent post relational link. 2089 * 2090 * The dynamic portion of the hook name, `$adjacent`, refers to the type 2091 * of adjacency, 'next' or 'previous'. 2092 * 2093 * Possible hook names include: 2094 * 2095 * - `next_post_rel_link` 2096 * - `previous_post_rel_link` 2097 * 2098 * @since 2.8.0 2099 * 2100 * @param string $link The relational link. 2101 */ 2102 return apply_filters( "{$adjacent}_post_rel_link", $link ); 2103 } 2104 2105 /** 2106 * Displays the relational links for the posts adjacent to the current post. 2107 * 2108 * @since 2.8.0 2109 * 2110 * @param string $title Optional. Link title format. Default '%title'. 2111 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2112 * Default false. 2113 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2114 * Default empty. 2115 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2116 */ 2117 function adjacent_posts_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 2118 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy ); 2119 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy ); 2120 } 2121 2122 /** 2123 * Displays relational links for the posts adjacent to the current post for single post pages. 2124 * 2125 * This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins 2126 * or theme templates. 2127 * 2128 * @since 3.0.0 2129 * @since 5.6.0 No longer used in core. 2130 * 2131 * @see adjacent_posts_rel_link() 2132 */ 2133 function adjacent_posts_rel_link_wp_head() { 2134 if ( ! is_single() || is_attachment() ) { 2135 return; 2136 } 2137 adjacent_posts_rel_link(); 2138 } 2139 2140 /** 2141 * Displays the relational link for the next post adjacent to the current post. 2142 * 2143 * @since 2.8.0 2144 * 2145 * @see get_adjacent_post_rel_link() 2146 * 2147 * @param string $title Optional. Link title format. Default '%title'. 2148 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2149 * Default false. 2150 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2151 * Default empty. 2152 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2153 */ 2154 function next_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 2155 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, false, $taxonomy ); 2156 } 2157 2158 /** 2159 * Displays the relational link for the previous post adjacent to the current post. 2160 * 2161 * @since 2.8.0 2162 * 2163 * @see get_adjacent_post_rel_link() 2164 * 2165 * @param string $title Optional. Link title format. Default '%title'. 2166 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2167 * Default false. 2168 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2169 * Default true. 2170 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2171 */ 2172 function prev_post_rel_link( $title = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 2173 echo get_adjacent_post_rel_link( $title, $in_same_term, $excluded_terms, true, $taxonomy ); 2174 } 2175 2176 /** 2177 * Retrieves the boundary post. 2178 * 2179 * Boundary being either the first or last post by publish date within the constraints specified 2180 * by `$in_same_term` or `$excluded_terms`. 2181 * 2182 * @since 2.8.0 2183 * 2184 * @param bool $in_same_term Optional. Whether returned post should be in the same taxonomy term. 2185 * Default false. 2186 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2187 * Default empty. 2188 * @param bool $start Optional. Whether to retrieve first or last post. 2189 * Default true. 2190 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2191 * @return array|null Array containing the boundary post object if successful, null otherwise. 2192 */ 2193 function get_boundary_post( $in_same_term = false, $excluded_terms = '', $start = true, $taxonomy = 'category' ) { 2194 $post = get_post(); 2195 2196 if ( ! $post || ! is_single() || is_attachment() || ! taxonomy_exists( $taxonomy ) ) { 2197 return null; 2198 } 2199 2200 $query_args = array( 2201 'posts_per_page' => 1, 2202 'order' => $start ? 'ASC' : 'DESC', 2203 'update_post_term_cache' => false, 2204 'update_post_meta_cache' => false, 2205 ); 2206 2207 $term_array = array(); 2208 2209 if ( ! is_array( $excluded_terms ) ) { 2210 if ( ! empty( $excluded_terms ) ) { 2211 $excluded_terms = explode( ',', $excluded_terms ); 2212 } else { 2213 $excluded_terms = array(); 2214 } 2215 } 2216 2217 if ( $in_same_term || ! empty( $excluded_terms ) ) { 2218 if ( $in_same_term ) { 2219 $term_array = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); 2220 } 2221 2222 if ( ! empty( $excluded_terms ) ) { 2223 $excluded_terms = array_map( 'intval', $excluded_terms ); 2224 $excluded_terms = array_diff( $excluded_terms, $term_array ); 2225 2226 $inverse_terms = array(); 2227 foreach ( $excluded_terms as $excluded_term ) { 2228 $inverse_terms[] = $excluded_term * -1; 2229 } 2230 $excluded_terms = $inverse_terms; 2231 } 2232 2233 $query_args['tax_query'] = array( 2234 array( 2235 'taxonomy' => $taxonomy, 2236 'terms' => array_merge( $term_array, $excluded_terms ), 2237 ), 2238 ); 2239 } 2240 2241 return get_posts( $query_args ); 2242 } 2243 2244 /** 2245 * Retrieves the previous post link that is adjacent to the current post. 2246 * 2247 * @since 3.7.0 2248 * 2249 * @param string $format Optional. Link anchor format. Default '« %link'. 2250 * @param string $link Optional. Link permalink format. Default '%title'. 2251 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2252 * Default false. 2253 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2254 * Default empty. 2255 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2256 * @return string The link URL of the previous post in relation to the current post. 2257 */ 2258 function get_previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 2259 return get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, true, $taxonomy ); 2260 } 2261 2262 /** 2263 * Displays the previous post link that is adjacent to the current post. 2264 * 2265 * @since 1.5.0 2266 * 2267 * @see get_previous_post_link() 2268 * 2269 * @param string $format Optional. Link anchor format. Default '« %link'. 2270 * @param string $link Optional. Link permalink format. Default '%title'. 2271 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2272 * Default false. 2273 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2274 * Default empty. 2275 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2276 */ 2277 function previous_post_link( $format = '« %link', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 2278 echo get_previous_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy ); 2279 } 2280 2281 /** 2282 * Retrieves the next post link that is adjacent to the current post. 2283 * 2284 * @since 3.7.0 2285 * 2286 * @param string $format Optional. Link anchor format. Default '« %link'. 2287 * @param string $link Optional. Link permalink format. Default '%title'. 2288 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2289 * Default false. 2290 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2291 * Default empty. 2292 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2293 * @return string The link URL of the next post in relation to the current post. 2294 */ 2295 function get_next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 2296 return get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, false, $taxonomy ); 2297 } 2298 2299 /** 2300 * Displays the next post link that is adjacent to the current post. 2301 * 2302 * @since 1.5.0 2303 * 2304 * @see get_next_post_link() 2305 * 2306 * @param string $format Optional. Link anchor format. Default '« %link'. 2307 * @param string $link Optional. Link permalink format. Default '%title'. 2308 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2309 * Default false. 2310 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. 2311 * Default empty. 2312 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2313 */ 2314 function next_post_link( $format = '%link »', $link = '%title', $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) { 2315 echo get_next_post_link( $format, $link, $in_same_term, $excluded_terms, $taxonomy ); 2316 } 2317 2318 /** 2319 * Retrieves the adjacent post link. 2320 * 2321 * Can be either next post link or previous. 2322 * 2323 * @since 3.7.0 2324 * 2325 * @param string $format Link anchor format. 2326 * @param string $link Link permalink format. 2327 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2328 * Default false. 2329 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded terms IDs. 2330 * Default empty. 2331 * @param bool $previous Optional. Whether to display link to previous or next post. 2332 * Default true. 2333 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2334 * @return string The link URL of the previous or next post in relation to the current post. 2335 */ 2336 function get_adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { 2337 if ( $previous && is_attachment() ) { 2338 $post = get_post( get_post()->post_parent ); 2339 } else { 2340 $post = get_adjacent_post( $in_same_term, $excluded_terms, $previous, $taxonomy ); 2341 } 2342 2343 if ( ! $post ) { 2344 $output = ''; 2345 } else { 2346 $title = $post->post_title; 2347 2348 if ( empty( $post->post_title ) ) { 2349 $title = $previous ? __( 'Previous Post' ) : __( 'Next Post' ); 2350 } 2351 2352 /** This filter is documented in wp-includes/post-template.php */ 2353 $title = apply_filters( 'the_title', $title, $post->ID ); 2354 2355 $date = mysql2date( get_option( 'date_format' ), $post->post_date ); 2356 $rel = $previous ? 'prev' : 'next'; 2357 2358 $string = '<a href="' . get_permalink( $post ) . '" rel="' . $rel . '">'; 2359 $inlink = str_replace( '%title', $title, $link ); 2360 $inlink = str_replace( '%date', $date, $inlink ); 2361 $inlink = $string . $inlink . '</a>'; 2362 2363 $output = str_replace( '%link', $inlink, $format ); 2364 } 2365 2366 $adjacent = $previous ? 'previous' : 'next'; 2367 2368 /** 2369 * Filters the adjacent post link. 2370 * 2371 * The dynamic portion of the hook name, `$adjacent`, refers to the type 2372 * of adjacency, 'next' or 'previous'. 2373 * 2374 * Possible hook names include: 2375 * 2376 * - `next_post_link` 2377 * - `previous_post_link` 2378 * 2379 * @since 2.6.0 2380 * @since 4.2.0 Added the `$adjacent` parameter. 2381 * 2382 * @param string $output The adjacent post link. 2383 * @param string $format Link anchor format. 2384 * @param string $link Link permalink format. 2385 * @param WP_Post|string $post The adjacent post. Empty string if no corresponding post exists. 2386 * @param string $adjacent Whether the post is previous or next. 2387 */ 2388 return apply_filters( "{$adjacent}_post_link", $output, $format, $link, $post, $adjacent ); 2389 } 2390 2391 /** 2392 * Displays the adjacent post link. 2393 * 2394 * Can be either next post link or previous. 2395 * 2396 * @since 2.5.0 2397 * 2398 * @param string $format Link anchor format. 2399 * @param string $link Link permalink format. 2400 * @param bool $in_same_term Optional. Whether link should be in the same taxonomy term. 2401 * Default false. 2402 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded category IDs. 2403 * Default empty. 2404 * @param bool $previous Optional. Whether to display link to previous or next post. 2405 * Default true. 2406 * @param string $taxonomy Optional. Taxonomy, if `$in_same_term` is true. Default 'category'. 2407 */ 2408 function adjacent_post_link( $format, $link, $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) { 2409 echo get_adjacent_post_link( $format, $link, $in_same_term, $excluded_terms, $previous, $taxonomy ); 2410 } 2411 2412 /** 2413 * Retrieves the link for a page number. 2414 * 2415 * @since 1.5.0 2416 * 2417 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 2418 * 2419 * @param int $pagenum Optional. Page number. Default 1. 2420 * @param bool $escape Optional. Whether to escape the URL for display, with esc_url(). 2421 * If set to false, prepares the URL with sanitize_url(). Default true. 2422 * @return string The link URL for the given page number. 2423 */ 2424 function get_pagenum_link( $pagenum = 1, $escape = true ) { 2425 global $wp_rewrite; 2426 2427 $pagenum = (int) $pagenum; 2428 2429 $request = remove_query_arg( 'paged' ); 2430 2431 $home_root = parse_url( home_url() ); 2432 $home_root = ( isset( $home_root['path'] ) ) ? $home_root['path'] : ''; 2433 $home_root = preg_quote( $home_root, '|' ); 2434 2435 $request = preg_replace( '|^' . $home_root . '|i', '', $request ); 2436 $request = preg_replace( '|^/+|', '', $request ); 2437 2438 if ( ! $wp_rewrite->using_permalinks() || is_admin() ) { 2439 $base = trailingslashit( get_bloginfo( 'url' ) ); 2440 2441 if ( $pagenum > 1 ) { 2442 $result = add_query_arg( 'paged', $pagenum, $base . $request ); 2443 } else { 2444 $result = $base . $request; 2445 } 2446 } else { 2447 $qs_regex = '|\?.*?$|'; 2448 preg_match( $qs_regex, $request, $qs_match ); 2449 2450 $parts = array(); 2451 $parts[] = untrailingslashit( get_bloginfo( 'url' ) ); 2452 2453 if ( ! empty( $qs_match[0] ) ) { 2454 $query_string = $qs_match[0]; 2455 $request = preg_replace( $qs_regex, '', $request ); 2456 } else { 2457 $query_string = ''; 2458 } 2459 2460 $request = preg_replace( "|$wp_rewrite->pagination_base/\d+/?$|", '', $request ); 2461 $request = preg_replace( '|^' . preg_quote( $wp_rewrite->index, '|' ) . '|i', '', $request ); 2462 $request = ltrim( $request, '/' ); 2463 2464 if ( $wp_rewrite->using_index_permalinks() && ( $pagenum > 1 || '' !== $request ) ) { 2465 $parts[] = $wp_rewrite->index; 2466 } 2467 2468 $parts[] = untrailingslashit( $request ); 2469 2470 if ( $pagenum > 1 ) { 2471 $parts[] = $wp_rewrite->pagination_base; 2472 $parts[] = $pagenum; 2473 } 2474 2475 $result = user_trailingslashit( implode( '/', array_filter( $parts ) ), 'paged' ); 2476 if ( ! empty( $query_string ) ) { 2477 $result .= $query_string; 2478 } 2479 } 2480 2481 /** 2482 * Filters the page number link for the current request. 2483 * 2484 * @since 2.5.0 2485 * @since 5.2.0 Added the `$pagenum` argument. 2486 * 2487 * @param string $result The page number link. 2488 * @param int $pagenum The page number. 2489 */ 2490 $result = apply_filters( 'get_pagenum_link', $result, $pagenum ); 2491 2492 if ( $escape ) { 2493 return esc_url( $result ); 2494 } else { 2495 return sanitize_url( $result ); 2496 } 2497 } 2498 2499 /** 2500 * Retrieves the next posts page link. 2501 * 2502 * Backported from 2.1.3 to 2.0.10. 2503 * 2504 * @since 2.0.10 2505 * 2506 * @global int $paged 2507 * 2508 * @param int $max_page Optional. Max pages. Default 0. 2509 * @return string|void The link URL for next posts page. 2510 */ 2511 function get_next_posts_page_link( $max_page = 0 ) { 2512 global $paged; 2513 2514 if ( ! is_single() ) { 2515 if ( ! $paged ) { 2516 $paged = 1; 2517 } 2518 2519 $next_page = (int) $paged + 1; 2520 2521 if ( ! $max_page || $max_page >= $next_page ) { 2522 return get_pagenum_link( $next_page ); 2523 } 2524 } 2525 } 2526 2527 /** 2528 * Displays or retrieves the next posts page link. 2529 * 2530 * @since 0.71 2531 * 2532 * @param int $max_page Optional. Max pages. Default 0. 2533 * @param bool $display Optional. Whether to echo the link. Default true. 2534 * @return string|void The link URL for next posts page if `$display = false`. 2535 */ 2536 function next_posts( $max_page = 0, $display = true ) { 2537 $link = get_next_posts_page_link( $max_page ); 2538 $output = $link ? esc_url( $link ) : ''; 2539 2540 if ( $display ) { 2541 echo $output; 2542 } else { 2543 return $output; 2544 } 2545 } 2546 2547 /** 2548 * Retrieves the next posts page link. 2549 * 2550 * @since 2.7.0 2551 * 2552 * @global int $paged 2553 * @global WP_Query $wp_query WordPress Query object. 2554 * 2555 * @param string $label Content for link text. 2556 * @param int $max_page Optional. Max pages. Default 0. 2557 * @return string|void HTML-formatted next posts page link. 2558 */ 2559 function get_next_posts_link( $label = null, $max_page = 0 ) { 2560 global $paged, $wp_query; 2561 2562 if ( ! $max_page ) { 2563 $max_page = $wp_query->max_num_pages; 2564 } 2565 2566 if ( ! $paged ) { 2567 $paged = 1; 2568 } 2569 2570 $next_page = (int) $paged + 1; 2571 2572 if ( null === $label ) { 2573 $label = __( 'Next Page »' ); 2574 } 2575 2576 if ( ! is_single() && ( $next_page <= $max_page ) ) { 2577 /** 2578 * Filters the anchor tag attributes for the next posts page link. 2579 * 2580 * @since 2.7.0 2581 * 2582 * @param string $attributes Attributes for the anchor tag. 2583 */ 2584 $attr = apply_filters( 'next_posts_link_attributes', '' ); 2585 2586 return sprintf( 2587 '<a href="%1$s" %2$s>%3$s</a>', 2588 next_posts( $max_page, false ), 2589 $attr, 2590 preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) 2591 ); 2592 } 2593 } 2594 2595 /** 2596 * Displays the next posts page link. 2597 * 2598 * @since 0.71 2599 * 2600 * @param string $label Content for link text. 2601 * @param int $max_page Optional. Max pages. Default 0. 2602 */ 2603 function next_posts_link( $label = null, $max_page = 0 ) { 2604 echo get_next_posts_link( $label, $max_page ); 2605 } 2606 2607 /** 2608 * Retrieves the previous posts page link. 2609 * 2610 * Will only return string, if not on a single page or post. 2611 * 2612 * Backported to 2.0.10 from 2.1.3. 2613 * 2614 * @since 2.0.10 2615 * 2616 * @global int $paged 2617 * 2618 * @return string|void The link for the previous posts page. 2619 */ 2620 function get_previous_posts_page_link() { 2621 global $paged; 2622 2623 if ( ! is_single() ) { 2624 $previous_page = (int) $paged - 1; 2625 2626 if ( $previous_page < 1 ) { 2627 $previous_page = 1; 2628 } 2629 2630 return get_pagenum_link( $previous_page ); 2631 } 2632 } 2633 2634 /** 2635 * Displays or retrieves the previous posts page link. 2636 * 2637 * @since 0.71 2638 * 2639 * @param bool $display Optional. Whether to echo the link. Default true. 2640 * @return string|void The previous posts page link if `$display = false`. 2641 */ 2642 function previous_posts( $display = true ) { 2643 $output = esc_url( get_previous_posts_page_link() ); 2644 2645 if ( $display ) { 2646 echo $output; 2647 } else { 2648 return $output; 2649 } 2650 } 2651 2652 /** 2653 * Retrieves the previous posts page link. 2654 * 2655 * @since 2.7.0 2656 * 2657 * @global int $paged 2658 * 2659 * @param string $label Optional. Previous page link text. 2660 * @return string|void HTML-formatted previous page link. 2661 */ 2662 function get_previous_posts_link( $label = null ) { 2663 global $paged; 2664 2665 if ( null === $label ) { 2666 $label = __( '« Previous Page' ); 2667 } 2668 2669 if ( ! is_single() && $paged > 1 ) { 2670 /** 2671 * Filters the anchor tag attributes for the previous posts page link. 2672 * 2673 * @since 2.7.0 2674 * 2675 * @param string $attributes Attributes for the anchor tag. 2676 */ 2677 $attr = apply_filters( 'previous_posts_link_attributes', '' ); 2678 2679 return sprintf( 2680 '<a href="%1$s" %2$s>%3$s</a>', 2681 previous_posts( false ), 2682 $attr, 2683 preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) 2684 ); 2685 } 2686 } 2687 2688 /** 2689 * Displays the previous posts page link. 2690 * 2691 * @since 0.71 2692 * 2693 * @param string $label Optional. Previous page link text. 2694 */ 2695 function previous_posts_link( $label = null ) { 2696 echo get_previous_posts_link( $label ); 2697 } 2698 2699 /** 2700 * Retrieves the post pages link navigation for previous and next pages. 2701 * 2702 * @since 2.8.0 2703 * 2704 * @global WP_Query $wp_query WordPress Query object. 2705 * 2706 * @param string|array $args { 2707 * Optional. Arguments to build the post pages link navigation. 2708 * 2709 * @type string $sep Separator character. Default '—'. 2710 * @type string $prelabel Link text to display for the previous page link. 2711 * Default '« Previous Page'. 2712 * @type string $nxtlabel Link text to display for the next page link. 2713 * Default 'Next Page »'. 2714 * } 2715 * @return string The posts link navigation. 2716 */ 2717 function get_posts_nav_link( $args = array() ) { 2718 global $wp_query; 2719 2720 $return = ''; 2721 2722 if ( ! is_singular() ) { 2723 $defaults = array( 2724 'sep' => ' — ', 2725 'prelabel' => __( '« Previous Page' ), 2726 'nxtlabel' => __( 'Next Page »' ), 2727 ); 2728 $args = wp_parse_args( $args, $defaults ); 2729 2730 $max_num_pages = $wp_query->max_num_pages; 2731 $paged = get_query_var( 'paged' ); 2732 2733 // Only have sep if there's both prev and next results. 2734 if ( $paged < 2 || $paged >= $max_num_pages ) { 2735 $args['sep'] = ''; 2736 } 2737 2738 if ( $max_num_pages > 1 ) { 2739 $return = get_previous_posts_link( $args['prelabel'] ); 2740 $return .= preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $args['sep'] ); 2741 $return .= get_next_posts_link( $args['nxtlabel'] ); 2742 } 2743 } 2744 return $return; 2745 } 2746 2747 /** 2748 * Displays the post pages link navigation for previous and next pages. 2749 * 2750 * @since 0.71 2751 * 2752 * @param string $sep Optional. Separator for posts navigation links. Default empty. 2753 * @param string $prelabel Optional. Label for previous pages. Default empty. 2754 * @param string $nxtlabel Optional Label for next pages. Default empty. 2755 */ 2756 function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) { 2757 $args = array_filter( compact( 'sep', 'prelabel', 'nxtlabel' ) ); 2758 echo get_posts_nav_link( $args ); 2759 } 2760 2761 /** 2762 * Retrieves the navigation to next/previous post, when applicable. 2763 * 2764 * @since 4.1.0 2765 * @since 4.4.0 Introduced the `in_same_term`, `excluded_terms`, and `taxonomy` arguments. 2766 * @since 5.3.0 Added the `aria_label` parameter. 2767 * @since 5.5.0 Added the `class` parameter. 2768 * 2769 * @param array $args { 2770 * Optional. Default post navigation arguments. Default empty array. 2771 * 2772 * @type string $prev_text Anchor text to display in the previous post link. 2773 * Default '%title'. 2774 * @type string $next_text Anchor text to display in the next post link. 2775 * Default '%title'. 2776 * @type bool $in_same_term Whether link should be in the same taxonomy term. 2777 * Default false. 2778 * @type int[]|string $excluded_terms Array or comma-separated list of excluded term IDs. 2779 * Default empty. 2780 * @type string $taxonomy Taxonomy, if `$in_same_term` is true. Default 'category'. 2781 * @type string $screen_reader_text Screen reader text for the nav element. 2782 * Default 'Post navigation'. 2783 * @type string $aria_label ARIA label text for the nav element. Default 'Posts'. 2784 * @type string $class Custom class for the nav element. Default 'post-navigation'. 2785 * } 2786 * @return string Markup for post links. 2787 */ 2788 function get_the_post_navigation( $args = array() ) { 2789 // Make sure the nav element has an aria-label attribute: fallback to the screen reader text. 2790 if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { 2791 $args['aria_label'] = $args['screen_reader_text']; 2792 } 2793 2794 $args = wp_parse_args( 2795 $args, 2796 array( 2797 'prev_text' => '%title', 2798 'next_text' => '%title', 2799 'in_same_term' => false, 2800 'excluded_terms' => '', 2801 'taxonomy' => 'category', 2802 'screen_reader_text' => __( 'Post navigation' ), 2803 'aria_label' => __( 'Posts' ), 2804 'class' => 'post-navigation', 2805 ) 2806 ); 2807 2808 $navigation = ''; 2809 2810 $previous = get_previous_post_link( 2811 '<div class="nav-previous">%link</div>', 2812 $args['prev_text'], 2813 $args['in_same_term'], 2814 $args['excluded_terms'], 2815 $args['taxonomy'] 2816 ); 2817 2818 $next = get_next_post_link( 2819 '<div class="nav-next">%link</div>', 2820 $args['next_text'], 2821 $args['in_same_term'], 2822 $args['excluded_terms'], 2823 $args['taxonomy'] 2824 ); 2825 2826 // Only add markup if there's somewhere to navigate to. 2827 if ( $previous || $next ) { 2828 $navigation = _navigation_markup( $previous . $next, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); 2829 } 2830 2831 return $navigation; 2832 } 2833 2834 /** 2835 * Displays the navigation to next/previous post, when applicable. 2836 * 2837 * @since 4.1.0 2838 * 2839 * @param array $args Optional. See get_the_post_navigation() for available arguments. 2840 * Default empty array. 2841 */ 2842 function the_post_navigation( $args = array() ) { 2843 echo get_the_post_navigation( $args ); 2844 } 2845 2846 /** 2847 * Returns the navigation to next/previous set of posts, when applicable. 2848 * 2849 * @since 4.1.0 2850 * @since 5.3.0 Added the `aria_label` parameter. 2851 * @since 5.5.0 Added the `class` parameter. 2852 * 2853 * @global WP_Query $wp_query WordPress Query object. 2854 * 2855 * @param array $args { 2856 * Optional. Default posts navigation arguments. Default empty array. 2857 * 2858 * @type string $prev_text Anchor text to display in the previous posts link. 2859 * Default 'Older posts'. 2860 * @type string $next_text Anchor text to display in the next posts link. 2861 * Default 'Newer posts'. 2862 * @type string $screen_reader_text Screen reader text for the nav element. 2863 * Default 'Posts navigation'. 2864 * @type string $aria_label ARIA label text for the nav element. Default 'Posts'. 2865 * @type string $class Custom class for the nav element. Default 'posts-navigation'. 2866 * } 2867 * @return string Markup for posts links. 2868 */ 2869 function get_the_posts_navigation( $args = array() ) { 2870 global $wp_query; 2871 2872 $navigation = ''; 2873 2874 // Don't print empty markup if there's only one page. 2875 if ( $wp_query->max_num_pages > 1 ) { 2876 // Make sure the nav element has an aria-label attribute: fallback to the screen reader text. 2877 if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { 2878 $args['aria_label'] = $args['screen_reader_text']; 2879 } 2880 2881 $args = wp_parse_args( 2882 $args, 2883 array( 2884 'prev_text' => __( 'Older posts' ), 2885 'next_text' => __( 'Newer posts' ), 2886 'screen_reader_text' => __( 'Posts navigation' ), 2887 'aria_label' => __( 'Posts' ), 2888 'class' => 'posts-navigation', 2889 ) 2890 ); 2891 2892 $next_link = get_previous_posts_link( $args['next_text'] ); 2893 $prev_link = get_next_posts_link( $args['prev_text'] ); 2894 2895 if ( $prev_link ) { 2896 $navigation .= '<div class="nav-previous">' . $prev_link . '</div>'; 2897 } 2898 2899 if ( $next_link ) { 2900 $navigation .= '<div class="nav-next">' . $next_link . '</div>'; 2901 } 2902 2903 $navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); 2904 } 2905 2906 return $navigation; 2907 } 2908 2909 /** 2910 * Displays the navigation to next/previous set of posts, when applicable. 2911 * 2912 * @since 4.1.0 2913 * 2914 * @param array $args Optional. See get_the_posts_navigation() for available arguments. 2915 * Default empty array. 2916 */ 2917 function the_posts_navigation( $args = array() ) { 2918 echo get_the_posts_navigation( $args ); 2919 } 2920 2921 /** 2922 * Retrieves a paginated navigation to next/previous set of posts, when applicable. 2923 * 2924 * @since 4.1.0 2925 * @since 5.3.0 Added the `aria_label` parameter. 2926 * @since 5.5.0 Added the `class` parameter. 2927 * 2928 * @global WP_Query $wp_query WordPress Query object. 2929 * 2930 * @param array $args { 2931 * Optional. Default pagination arguments, see paginate_links(). 2932 * 2933 * @type string $screen_reader_text Screen reader text for navigation element. 2934 * Default 'Posts pagination'. 2935 * @type string $aria_label ARIA label text for the nav element. Default 'Posts pagination'. 2936 * @type string $class Custom class for the nav element. Default 'pagination'. 2937 * } 2938 * @return string Markup for pagination links. 2939 */ 2940 function get_the_posts_pagination( $args = array() ) { 2941 global $wp_query; 2942 2943 $navigation = ''; 2944 2945 // Don't print empty markup if there's only one page. 2946 if ( $wp_query->max_num_pages > 1 ) { 2947 // Make sure the nav element has an aria-label attribute: fallback to the screen reader text. 2948 if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { 2949 $args['aria_label'] = $args['screen_reader_text']; 2950 } 2951 2952 $args = wp_parse_args( 2953 $args, 2954 array( 2955 'mid_size' => 1, 2956 'prev_text' => _x( 'Previous', 'previous set of posts' ), 2957 'next_text' => _x( 'Next', 'next set of posts' ), 2958 'screen_reader_text' => __( 'Posts pagination' ), 2959 'aria_label' => __( 'Posts pagination' ), 2960 'class' => 'pagination', 2961 ) 2962 ); 2963 2964 /** 2965 * Filters the arguments for posts pagination links. 2966 * 2967 * @since 6.1.0 2968 * 2969 * @param array $args { 2970 * Optional. Default pagination arguments, see paginate_links(). 2971 * 2972 * @type string $screen_reader_text Screen reader text for navigation element. 2973 * Default 'Posts navigation'. 2974 * @type string $aria_label ARIA label text for the nav element. Default 'Posts'. 2975 * @type string $class Custom class for the nav element. Default 'pagination'. 2976 * } 2977 */ 2978 $args = apply_filters( 'the_posts_pagination_args', $args ); 2979 2980 // Make sure we get a string back. Plain is the next best thing. 2981 if ( isset( $args['type'] ) && 'array' === $args['type'] ) { 2982 $args['type'] = 'plain'; 2983 } 2984 2985 // Set up paginated links. 2986 $links = paginate_links( $args ); 2987 2988 if ( $links ) { 2989 $navigation = _navigation_markup( $links, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); 2990 } 2991 } 2992 2993 return $navigation; 2994 } 2995 2996 /** 2997 * Displays a paginated navigation to next/previous set of posts, when applicable. 2998 * 2999 * @since 4.1.0 3000 * 3001 * @param array $args Optional. See get_the_posts_pagination() for available arguments. 3002 * Default empty array. 3003 */ 3004 function the_posts_pagination( $args = array() ) { 3005 echo get_the_posts_pagination( $args ); 3006 } 3007 3008 /** 3009 * Wraps passed links in navigational markup. 3010 * 3011 * @since 4.1.0 3012 * @since 5.3.0 Added the `aria_label` parameter. 3013 * @access private 3014 * 3015 * @param string $links Navigational links. 3016 * @param string $css_class Optional. Custom class for the nav element. 3017 * Default 'posts-navigation'. 3018 * @param string $screen_reader_text Optional. Screen reader text for the nav element. 3019 * Default 'Posts navigation'. 3020 * @param string $aria_label Optional. ARIA label for the nav element. 3021 * Defaults to the value of `$screen_reader_text`. 3022 * @return string Navigation template tag. 3023 */ 3024 function _navigation_markup( $links, $css_class = 'posts-navigation', $screen_reader_text = '', $aria_label = '' ) { 3025 if ( empty( $screen_reader_text ) ) { 3026 $screen_reader_text = /* translators: Hidden accessibility text. */ __( 'Posts navigation' ); 3027 } 3028 if ( empty( $aria_label ) ) { 3029 $aria_label = $screen_reader_text; 3030 } 3031 3032 $template = ' 3033 <nav class="navigation %1$s" aria-label="%4$s"> 3034 <h2 class="screen-reader-text">%2$s</h2> 3035 <div class="nav-links">%3$s</div> 3036 </nav>'; 3037 3038 /** 3039 * Filters the navigation markup template. 3040 * 3041 * Note: The filtered template HTML must contain specifiers for the navigation 3042 * class (%1$s), the screen-reader-text value (%2$s), placement of the navigation 3043 * links (%3$s), and ARIA label text if screen-reader-text does not fit that (%4$s): 3044 * 3045 * <nav class="navigation %1$s" aria-label="%4$s"> 3046 * <h2 class="screen-reader-text">%2$s</h2> 3047 * <div class="nav-links">%3$s</div> 3048 * </nav> 3049 * 3050 * @since 4.4.0 3051 * 3052 * @param string $template The default template. 3053 * @param string $css_class The class passed by the calling function. 3054 * @return string Navigation template. 3055 */ 3056 $template = apply_filters( 'navigation_markup_template', $template, $css_class ); 3057 3058 return sprintf( $template, sanitize_html_class( $css_class ), esc_html( $screen_reader_text ), $links, esc_attr( $aria_label ) ); 3059 } 3060 3061 /** 3062 * Retrieves the comments page number link. 3063 * 3064 * @since 2.7.0 3065 * 3066 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 3067 * 3068 * @param int $pagenum Optional. Page number. Default 1. 3069 * @param int $max_page Optional. The maximum number of comment pages. Default 0. 3070 * @return string The comments page number link URL. 3071 */ 3072 function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) { 3073 global $wp_rewrite; 3074 3075 $pagenum = (int) $pagenum; 3076 $max_page = (int) $max_page; 3077 3078 $result = get_permalink(); 3079 3080 if ( 'newest' === get_option( 'default_comments_page' ) ) { 3081 if ( $pagenum !== $max_page ) { 3082 if ( $wp_rewrite->using_permalinks() ) { 3083 $result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' ); 3084 } else { 3085 $result = add_query_arg( 'cpage', $pagenum, $result ); 3086 } 3087 } 3088 } elseif ( $pagenum > 1 ) { 3089 if ( $wp_rewrite->using_permalinks() ) { 3090 $result = user_trailingslashit( trailingslashit( $result ) . $wp_rewrite->comments_pagination_base . '-' . $pagenum, 'commentpaged' ); 3091 } else { 3092 $result = add_query_arg( 'cpage', $pagenum, $result ); 3093 } 3094 } 3095 3096 $result .= '#comments'; 3097 3098 /** 3099 * Filters the comments page number link for the current request. 3100 * 3101 * @since 2.7.0 3102 * 3103 * @param string $result The comments page number link. 3104 */ 3105 return apply_filters( 'get_comments_pagenum_link', $result ); 3106 } 3107 3108 /** 3109 * Retrieves the link to the next comments page. 3110 * 3111 * @since 2.7.1 3112 * @since 6.7.0 Added the `page` parameter. 3113 * 3114 * @global WP_Query $wp_query WordPress Query object. 3115 * 3116 * @param string $label Optional. Label for link text. Default empty. 3117 * @param int $max_page Optional. Max page. Default 0. 3118 * @param int|null $page Optional. Page number. Default null. 3119 * @return string|void HTML-formatted link for the next page of comments. 3120 */ 3121 function get_next_comments_link( $label = '', $max_page = 0, $page = null ) { 3122 global $wp_query; 3123 3124 if ( ! is_singular() ) { 3125 return; 3126 } 3127 3128 if ( is_null( $page ) ) { 3129 $page = get_query_var( 'cpage' ); 3130 } 3131 3132 if ( ! $page ) { 3133 $page = 1; 3134 } 3135 3136 $next_page = (int) $page + 1; 3137 3138 if ( empty( $max_page ) ) { 3139 $max_page = $wp_query->max_num_comment_pages; 3140 } 3141 3142 if ( empty( $max_page ) ) { 3143 $max_page = get_comment_pages_count(); 3144 } 3145 3146 if ( $next_page > $max_page ) { 3147 return; 3148 } 3149 3150 if ( empty( $label ) ) { 3151 $label = __( 'Newer Comments »' ); 3152 } 3153 3154 /** 3155 * Filters the anchor tag attributes for the next comments page link. 3156 * 3157 * @since 2.7.0 3158 * 3159 * @param string $attributes Attributes for the anchor tag. 3160 */ 3161 $attr = apply_filters( 'next_comments_link_attributes', '' ); 3162 3163 return sprintf( 3164 '<a href="%1$s" %2$s>%3$s</a>', 3165 esc_url( get_comments_pagenum_link( $next_page, $max_page ) ), 3166 $attr, 3167 preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) 3168 ); 3169 } 3170 3171 /** 3172 * Displays the link to the next comments page. 3173 * 3174 * @since 2.7.0 3175 * 3176 * @param string $label Optional. Label for link text. Default empty. 3177 * @param int $max_page Optional. Max page. Default 0. 3178 */ 3179 function next_comments_link( $label = '', $max_page = 0 ) { 3180 echo get_next_comments_link( $label, $max_page ); 3181 } 3182 3183 /** 3184 * Retrieves the link to the previous comments page. 3185 * 3186 * @since 2.7.1 3187 * @since 6.7.0 Added the `page` parameter. 3188 * 3189 * @param string $label Optional. Label for comments link text. Default empty. 3190 * @param int|null $page Optional. Page number. Default null. 3191 * @return string|void HTML-formatted link for the previous page of comments. 3192 */ 3193 function get_previous_comments_link( $label = '', $page = null ) { 3194 if ( ! is_singular() ) { 3195 return; 3196 } 3197 3198 if ( is_null( $page ) ) { 3199 $page = get_query_var( 'cpage' ); 3200 } 3201 3202 if ( (int) $page <= 1 ) { 3203 return; 3204 } 3205 3206 $previous_page = (int) $page - 1; 3207 3208 if ( empty( $label ) ) { 3209 $label = __( '« Older Comments' ); 3210 } 3211 3212 /** 3213 * Filters the anchor tag attributes for the previous comments page link. 3214 * 3215 * @since 2.7.0 3216 * 3217 * @param string $attributes Attributes for the anchor tag. 3218 */ 3219 $attr = apply_filters( 'previous_comments_link_attributes', '' ); 3220 3221 return sprintf( 3222 '<a href="%1$s" %2$s>%3$s</a>', 3223 esc_url( get_comments_pagenum_link( $previous_page ) ), 3224 $attr, 3225 preg_replace( '/&([^#])(?![a-z]{1,8};)/i', '&$1', $label ) 3226 ); 3227 } 3228 3229 /** 3230 * Displays the link to the previous comments page. 3231 * 3232 * @since 2.7.0 3233 * 3234 * @param string $label Optional. Label for comments link text. Default empty. 3235 */ 3236 function previous_comments_link( $label = '' ) { 3237 echo get_previous_comments_link( $label ); 3238 } 3239 3240 /** 3241 * Displays or retrieves pagination links for the comments on the current post. 3242 * 3243 * @see paginate_links() 3244 * @since 2.7.0 3245 * 3246 * @global WP_Rewrite $wp_rewrite WordPress rewrite component. 3247 * 3248 * @param string|array $args Optional args. See paginate_links(). Default empty array. 3249 * @return void|string|array Void if 'echo' argument is true and 'type' is not an array, 3250 * or if the query is not for an existing single post of any post type. 3251 * Otherwise, markup for comment page links or array of comment page links, 3252 * depending on 'type' argument. 3253 */ 3254 function paginate_comments_links( $args = array() ) { 3255 global $wp_rewrite; 3256 3257 if ( ! is_singular() ) { 3258 return; 3259 } 3260 3261 $page = get_query_var( 'cpage' ); 3262 if ( ! $page ) { 3263 $page = 1; 3264 } 3265 $max_page = get_comment_pages_count(); 3266 $defaults = array( 3267 'base' => add_query_arg( 'cpage', '%#%' ), 3268 'format' => '', 3269 'total' => $max_page, 3270 'current' => $page, 3271 'echo' => true, 3272 'type' => 'plain', 3273 'add_fragment' => '#comments', 3274 ); 3275 if ( $wp_rewrite->using_permalinks() ) { 3276 $defaults['base'] = user_trailingslashit( trailingslashit( get_permalink() ) . $wp_rewrite->comments_pagination_base . '-%#%', 'commentpaged' ); 3277 } 3278 3279 $args = wp_parse_args( $args, $defaults ); 3280 $page_links = paginate_links( $args ); 3281 3282 if ( $args['echo'] && 'array' !== $args['type'] ) { 3283 echo $page_links; 3284 } else { 3285 return $page_links; 3286 } 3287 } 3288 3289 /** 3290 * Retrieves navigation to next/previous set of comments, when applicable. 3291 * 3292 * @since 4.4.0 3293 * @since 5.3.0 Added the `aria_label` parameter. 3294 * @since 5.5.0 Added the `class` parameter. 3295 * 3296 * @param array $args { 3297 * Optional. Default comments navigation arguments. 3298 * 3299 * @type string $prev_text Anchor text to display in the previous comments link. 3300 * Default 'Older comments'. 3301 * @type string $next_text Anchor text to display in the next comments link. 3302 * Default 'Newer comments'. 3303 * @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments navigation'. 3304 * @type string $aria_label ARIA label text for the nav element. Default 'Comments'. 3305 * @type string $class Custom class for the nav element. Default 'comment-navigation'. 3306 * } 3307 * @return string Markup for comments links. 3308 */ 3309 function get_the_comments_navigation( $args = array() ) { 3310 $navigation = ''; 3311 3312 // Are there comments to navigate through? 3313 if ( get_comment_pages_count() > 1 ) { 3314 // Make sure the nav element has an aria-label attribute: fallback to the screen reader text. 3315 if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { 3316 $args['aria_label'] = $args['screen_reader_text']; 3317 } 3318 3319 $args = wp_parse_args( 3320 $args, 3321 array( 3322 'prev_text' => __( 'Older comments' ), 3323 'next_text' => __( 'Newer comments' ), 3324 'screen_reader_text' => __( 'Comments navigation' ), 3325 'aria_label' => __( 'Comments' ), 3326 'class' => 'comment-navigation', 3327 ) 3328 ); 3329 3330 $prev_link = get_previous_comments_link( $args['prev_text'] ); 3331 $next_link = get_next_comments_link( $args['next_text'] ); 3332 3333 if ( $prev_link ) { 3334 $navigation .= '<div class="nav-previous">' . $prev_link . '</div>'; 3335 } 3336 3337 if ( $next_link ) { 3338 $navigation .= '<div class="nav-next">' . $next_link . '</div>'; 3339 } 3340 3341 $navigation = _navigation_markup( $navigation, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); 3342 } 3343 3344 return $navigation; 3345 } 3346 3347 /** 3348 * Displays navigation to next/previous set of comments, when applicable. 3349 * 3350 * @since 4.4.0 3351 * 3352 * @param array $args See get_the_comments_navigation() for available arguments. Default empty array. 3353 */ 3354 function the_comments_navigation( $args = array() ) { 3355 echo get_the_comments_navigation( $args ); 3356 } 3357 3358 /** 3359 * Retrieves a paginated navigation to next/previous set of comments, when applicable. 3360 * 3361 * @since 4.4.0 3362 * @since 5.3.0 Added the `aria_label` parameter. 3363 * @since 5.5.0 Added the `class` parameter. 3364 * 3365 * @see paginate_comments_links() 3366 * 3367 * @param array $args { 3368 * Optional. Default pagination arguments. 3369 * 3370 * @type string $screen_reader_text Screen reader text for the nav element. Default 'Comments pagination'. 3371 * @type string $aria_label ARIA label text for the nav element. Default 'Comments pagination'. 3372 * @type string $class Custom class for the nav element. Default 'comments-pagination'. 3373 * } 3374 * @return string Markup for pagination links. 3375 */ 3376 function get_the_comments_pagination( $args = array() ) { 3377 $navigation = ''; 3378 3379 // Make sure the nav element has an aria-label attribute: fallback to the screen reader text. 3380 if ( ! empty( $args['screen_reader_text'] ) && empty( $args['aria_label'] ) ) { 3381 $args['aria_label'] = $args['screen_reader_text']; 3382 } 3383 3384 $args = wp_parse_args( 3385 $args, 3386 array( 3387 'screen_reader_text' => __( 'Comments pagination' ), 3388 'aria_label' => __( 'Comments pagination' ), 3389 'class' => 'comments-pagination', 3390 ) 3391 ); 3392 $args['echo'] = false; 3393 3394 // Make sure we get a string back. Plain is the next best thing. 3395 if ( isset( $args['type'] ) && 'array' === $args['type'] ) { 3396 $args['type'] = 'plain'; 3397 } 3398 3399 $links = paginate_comments_links( $args ); 3400 3401 if ( $links ) { 3402 $navigation = _navigation_markup( $links, $args['class'], $args['screen_reader_text'], $args['aria_label'] ); 3403 } 3404 3405 return $navigation; 3406 } 3407 3408 /** 3409 * Displays a paginated navigation to next/previous set of comments, when applicable. 3410 * 3411 * @since 4.4.0 3412 * 3413 * @param array $args See get_the_comments_pagination() for available arguments. Default empty array. 3414 */ 3415 function the_comments_pagination( $args = array() ) { 3416 echo get_the_comments_pagination( $args ); 3417 } 3418 3419 /** 3420 * Retrieves the URL for the current site where the front end is accessible. 3421 * 3422 * Returns the 'home' option with the appropriate protocol. The protocol will be 'https' 3423 * if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. 3424 * If `$scheme` is 'http' or 'https', is_ssl() is overridden. 3425 * 3426 * @since 3.0.0 3427 * 3428 * @param string $path Optional. Path relative to the home URL. Default empty. 3429 * @param string|null $scheme Optional. Scheme to give the home URL context. Accepts 3430 * 'http', 'https', 'relative', 'rest', or null. Default null. 3431 * @return string Home URL link with optional path appended. 3432 */ 3433 function home_url( $path = '', $scheme = null ) { 3434 return get_home_url( null, $path, $scheme ); 3435 } 3436 3437 /** 3438 * Retrieves the URL for a given site where the front end is accessible. 3439 * 3440 * Returns the 'home' option with the appropriate protocol. The protocol will be 'https' 3441 * if is_ssl() evaluates to true; otherwise, it will be the same as the 'home' option. 3442 * If `$scheme` is 'http' or 'https', is_ssl() is overridden. 3443 * 3444 * @since 3.0.0 3445 * 3446 * @param int|null $blog_id Optional. Site ID. Default null (current site). 3447 * @param string $path Optional. Path relative to the home URL. Default empty. 3448 * @param string|null $scheme Optional. Scheme to give the home URL context. Accepts 3449 * 'http', 'https', 'relative', 'rest', or null. Default null. 3450 * @return string Home URL link with optional path appended. 3451 */ 3452 function get_home_url( $blog_id = null, $path = '', $scheme = null ) { 3453 $orig_scheme = $scheme; 3454 3455 if ( empty( $blog_id ) || ! is_multisite() ) { 3456 $url = get_option( 'home' ); 3457 } else { 3458 switch_to_blog( $blog_id ); 3459 $url = get_option( 'home' ); 3460 restore_current_blog(); 3461 } 3462 3463 if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) { 3464 if ( is_ssl() ) { 3465 $scheme = 'https'; 3466 } else { 3467 $scheme = parse_url( $url, PHP_URL_SCHEME ); 3468 } 3469 } 3470 3471 $url = set_url_scheme( $url, $scheme ); 3472 3473 if ( $path && is_string( $path ) ) { 3474 $url .= '/' . ltrim( $path, '/' ); 3475 } 3476 3477 /** 3478 * Filters the home URL. 3479 * 3480 * @since 3.0.0 3481 * 3482 * @param string $url The complete home URL including scheme and path. 3483 * @param string $path Path relative to the home URL. Blank string if no path is specified. 3484 * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https', 3485 * 'relative', 'rest', or null. 3486 * @param int|null $blog_id Site ID, or null for the current site. 3487 */ 3488 return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id ); 3489 } 3490 3491 /** 3492 * Retrieves the URL for the current site where WordPress application files 3493 * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. 3494 * 3495 * Returns the 'site_url' option with the appropriate protocol, 'https' if 3496 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 3497 * overridden. 3498 * 3499 * @since 3.0.0 3500 * 3501 * @param string $path Optional. Path relative to the site URL. Default empty. 3502 * @param string|null $scheme Optional. Scheme to give the site URL context. See set_url_scheme(). 3503 * @return string Site URL link with optional path appended. 3504 */ 3505 function site_url( $path = '', $scheme = null ) { 3506 return get_site_url( null, $path, $scheme ); 3507 } 3508 3509 /** 3510 * Retrieves the URL for a given site where WordPress application files 3511 * (e.g. wp-blog-header.php or the wp-admin/ folder) are accessible. 3512 * 3513 * Returns the 'site_url' option with the appropriate protocol, 'https' if 3514 * is_ssl() and 'http' otherwise. If `$scheme` is 'http' or 'https', 3515 * `is_ssl()` is overridden. 3516 * 3517 * @since 3.0.0 3518 * 3519 * @param int|null $blog_id Optional. Site ID. Default null (current site). 3520 * @param string $path Optional. Path relative to the site URL. Default empty. 3521 * @param string|null $scheme Optional. Scheme to give the site URL context. Accepts 3522 * 'http', 'https', 'login', 'login_post', 'admin', or 3523 * 'relative'. Default null. 3524 * @return string Site URL link with optional path appended. 3525 */ 3526 function get_site_url( $blog_id = null, $path = '', $scheme = null ) { 3527 if ( empty( $blog_id ) || ! is_multisite() ) { 3528 $url = get_option( 'siteurl' ); 3529 } else { 3530 switch_to_blog( $blog_id ); 3531 $url = get_option( 'siteurl' ); 3532 restore_current_blog(); 3533 } 3534 3535 $url = set_url_scheme( $url, $scheme ); 3536 3537 if ( $path && is_string( $path ) ) { 3538 $url .= '/' . ltrim( $path, '/' ); 3539 } 3540 3541 /** 3542 * Filters the site URL. 3543 * 3544 * @since 2.7.0 3545 * 3546 * @param string $url The complete site URL including scheme and path. 3547 * @param string $path Path relative to the site URL. Blank string if no path is specified. 3548 * @param string|null $scheme Scheme to give the site URL context. Accepts 'http', 'https', 'login', 3549 * 'login_post', 'admin', 'relative' or null. 3550 * @param int|null $blog_id Site ID, or null for the current site. 3551 */ 3552 return apply_filters( 'site_url', $url, $path, $scheme, $blog_id ); 3553 } 3554 3555 /** 3556 * Retrieves the URL to the admin area for the current site. 3557 * 3558 * @since 2.6.0 3559 * 3560 * @param string $path Optional. Path relative to the admin URL. Default empty. 3561 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 3562 * 'http' or 'https' can be passed to force those schemes. 3563 * @return string Admin URL link with optional path appended. 3564 */ 3565 function admin_url( $path = '', $scheme = 'admin' ) { 3566 return get_admin_url( null, $path, $scheme ); 3567 } 3568 3569 /** 3570 * Retrieves the URL to the admin area for a given site. 3571 * 3572 * @since 3.0.0 3573 * 3574 * @param int|null $blog_id Optional. Site ID. Default null (current site). 3575 * @param string $path Optional. Path relative to the admin URL. Default empty. 3576 * @param string $scheme Optional. The scheme to use. Accepts 'http' or 'https', 3577 * to force those schemes. Default 'admin', which obeys 3578 * force_ssl_admin() and is_ssl(). 3579 * @return string Admin URL link with optional path appended. 3580 */ 3581 function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) { 3582 $url = get_site_url( $blog_id, 'wp-admin/', $scheme ); 3583 3584 if ( $path && is_string( $path ) ) { 3585 $url .= ltrim( $path, '/' ); 3586 } 3587 3588 /** 3589 * Filters the admin area URL. 3590 * 3591 * @since 2.8.0 3592 * @since 5.8.0 The `$scheme` parameter was added. 3593 * 3594 * @param string $url The complete admin area URL including scheme and path. 3595 * @param string $path Path relative to the admin area URL. Blank string if no path is specified. 3596 * @param int|null $blog_id Site ID, or null for the current site. 3597 * @param string|null $scheme The scheme to use. Accepts 'http', 'https', 3598 * 'admin', or null. Default 'admin', which obeys force_ssl_admin() and is_ssl(). 3599 */ 3600 return apply_filters( 'admin_url', $url, $path, $blog_id, $scheme ); 3601 } 3602 3603 /** 3604 * Retrieves the URL to the includes directory. 3605 * 3606 * @since 2.6.0 3607 * 3608 * @param string $path Optional. Path relative to the includes URL. Default empty. 3609 * @param string|null $scheme Optional. Scheme to give the includes URL context. Accepts 3610 * 'http', 'https', or 'relative'. Default null. 3611 * @return string Includes URL link with optional path appended. 3612 */ 3613 function includes_url( $path = '', $scheme = null ) { 3614 $url = site_url( '/' . WPINC . '/', $scheme ); 3615 3616 if ( $path && is_string( $path ) ) { 3617 $url .= ltrim( $path, '/' ); 3618 } 3619 3620 /** 3621 * Filters the URL to the includes directory. 3622 * 3623 * @since 2.8.0 3624 * @since 5.8.0 The `$scheme` parameter was added. 3625 * 3626 * @param string $url The complete URL to the includes directory including scheme and path. 3627 * @param string $path Path relative to the URL to the wp-includes directory. Blank string 3628 * if no path is specified. 3629 * @param string|null $scheme Scheme to give the includes URL context. Accepts 3630 * 'http', 'https', 'relative', or null. Default null. 3631 */ 3632 return apply_filters( 'includes_url', $url, $path, $scheme ); 3633 } 3634 3635 /** 3636 * Retrieves the URL to the content directory. 3637 * 3638 * @since 2.6.0 3639 * 3640 * @param string $path Optional. Path relative to the content URL. Default empty. 3641 * @return string Content URL link with optional path appended. 3642 */ 3643 function content_url( $path = '' ) { 3644 $url = set_url_scheme( WP_CONTENT_URL ); 3645 3646 if ( $path && is_string( $path ) ) { 3647 $url .= '/' . ltrim( $path, '/' ); 3648 } 3649 3650 /** 3651 * Filters the URL to the content directory. 3652 * 3653 * @since 2.8.0 3654 * 3655 * @param string $url The complete URL to the content directory including scheme and path. 3656 * @param string $path Path relative to the URL to the content directory. Blank string 3657 * if no path is specified. 3658 */ 3659 return apply_filters( 'content_url', $url, $path ); 3660 } 3661 3662 /** 3663 * Retrieves a URL within the plugins or mu-plugins directory. 3664 * 3665 * Defaults to the plugins directory URL if no arguments are supplied. 3666 * 3667 * @since 2.6.0 3668 * 3669 * @param string $path Optional. Extra path appended to the end of the URL, including 3670 * the relative directory if $plugin is supplied. Default empty. 3671 * @param string $plugin Optional. A full path to a file inside a plugin or mu-plugin. 3672 * The URL will be relative to its directory. Default empty. 3673 * Typically this is done by passing `__FILE__` as the argument. 3674 * @return string Plugins URL link with optional paths appended. 3675 */ 3676 function plugins_url( $path = '', $plugin = '' ) { 3677 3678 $path = wp_normalize_path( $path ); 3679 $plugin = wp_normalize_path( $plugin ); 3680 $mu_plugin_dir = wp_normalize_path( WPMU_PLUGIN_DIR ); 3681 3682 if ( ! empty( $plugin ) && str_starts_with( $plugin, $mu_plugin_dir ) ) { 3683 $url = WPMU_PLUGIN_URL; 3684 } else { 3685 $url = WP_PLUGIN_URL; 3686 } 3687 3688 $url = set_url_scheme( $url ); 3689 3690 if ( ! empty( $plugin ) && is_string( $plugin ) ) { 3691 $folder = dirname( plugin_basename( $plugin ) ); 3692 if ( '.' !== $folder ) { 3693 $url .= '/' . ltrim( $folder, '/' ); 3694 } 3695 } 3696 3697 if ( $path && is_string( $path ) ) { 3698 $url .= '/' . ltrim( $path, '/' ); 3699 } 3700 3701 /** 3702 * Filters the URL to the plugins directory. 3703 * 3704 * @since 2.8.0 3705 * 3706 * @param string $url The complete URL to the plugins directory including scheme and path. 3707 * @param string $path Path relative to the URL to the plugins directory. Blank string 3708 * if no path is specified. 3709 * @param string $plugin The plugin file path to be relative to. Blank string if no plugin 3710 * is specified. 3711 */ 3712 return apply_filters( 'plugins_url', $url, $path, $plugin ); 3713 } 3714 3715 /** 3716 * Retrieves the site URL for the current network. 3717 * 3718 * Returns the site URL with the appropriate protocol, 'https' if 3719 * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is 3720 * overridden. 3721 * 3722 * @since 3.0.0 3723 * 3724 * @see set_url_scheme() 3725 * 3726 * @param string $path Optional. Path relative to the site URL. Default empty. 3727 * @param string|null $scheme Optional. Scheme to give the site URL context. Accepts 3728 * 'http', 'https', or 'relative'. Default null. 3729 * @return string Site URL link with optional path appended. 3730 */ 3731 function network_site_url( $path = '', $scheme = null ) { 3732 if ( ! is_multisite() ) { 3733 return site_url( $path, $scheme ); 3734 } 3735 3736 $current_network = get_network(); 3737 3738 if ( 'relative' === $scheme ) { 3739 $url = $current_network->path; 3740 } else { 3741 $url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme ); 3742 } 3743 3744 if ( $path && is_string( $path ) ) { 3745 $url .= ltrim( $path, '/' ); 3746 } 3747 3748 /** 3749 * Filters the network site URL. 3750 * 3751 * @since 3.0.0 3752 * 3753 * @param string $url The complete network site URL including scheme and path. 3754 * @param string $path Path relative to the network site URL. Blank string if 3755 * no path is specified. 3756 * @param string|null $scheme Scheme to give the URL context. Accepts 'http', 'https', 3757 * 'relative' or null. 3758 */ 3759 return apply_filters( 'network_site_url', $url, $path, $scheme ); 3760 } 3761 3762 /** 3763 * Retrieves the home URL for the current network. 3764 * 3765 * Returns the home URL with the appropriate protocol, 'https' is_ssl() 3766 * and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is 3767 * overridden. 3768 * 3769 * @since 3.0.0 3770 * 3771 * @param string $path Optional. Path relative to the home URL. Default empty. 3772 * @param string|null $scheme Optional. Scheme to give the home URL context. Accepts 3773 * 'http', 'https', or 'relative'. Default null. 3774 * @return string Home URL link with optional path appended. 3775 */ 3776 function network_home_url( $path = '', $scheme = null ) { 3777 if ( ! is_multisite() ) { 3778 return home_url( $path, $scheme ); 3779 } 3780 3781 $current_network = get_network(); 3782 $orig_scheme = $scheme; 3783 3784 if ( ! in_array( $scheme, array( 'http', 'https', 'relative' ), true ) ) { 3785 $scheme = is_ssl() ? 'https' : 'http'; 3786 } 3787 3788 if ( 'relative' === $scheme ) { 3789 $url = $current_network->path; 3790 } else { 3791 $url = set_url_scheme( 'http://' . $current_network->domain . $current_network->path, $scheme ); 3792 } 3793 3794 if ( $path && is_string( $path ) ) { 3795 $url .= ltrim( $path, '/' ); 3796 } 3797 3798 /** 3799 * Filters the network home URL. 3800 * 3801 * @since 3.0.0 3802 * 3803 * @param string $url The complete network home URL including scheme and path. 3804 * @param string $path Path relative to the network home URL. Blank string 3805 * if no path is specified. 3806 * @param string|null $orig_scheme Scheme to give the URL context. Accepts 'http', 'https', 3807 * 'relative' or null. 3808 */ 3809 return apply_filters( 'network_home_url', $url, $path, $orig_scheme ); 3810 } 3811 3812 /** 3813 * Retrieves the URL to the admin area for the network. 3814 * 3815 * @since 3.0.0 3816 * 3817 * @param string $path Optional path relative to the admin URL. Default empty. 3818 * @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() 3819 * and is_ssl(). 'http' or 'https' can be passed to force those schemes. 3820 * @return string Admin URL link with optional path appended. 3821 */ 3822 function network_admin_url( $path = '', $scheme = 'admin' ) { 3823 if ( ! is_multisite() ) { 3824 return admin_url( $path, $scheme ); 3825 } 3826 3827 $url = network_site_url( 'wp-admin/network/', $scheme ); 3828 3829 if ( $path && is_string( $path ) ) { 3830 $url .= ltrim( $path, '/' ); 3831 } 3832 3833 /** 3834 * Filters the network admin URL. 3835 * 3836 * @since 3.0.0 3837 * @since 5.8.0 The `$scheme` parameter was added. 3838 * 3839 * @param string $url The complete network admin URL including scheme and path. 3840 * @param string $path Path relative to the network admin URL. Blank string if 3841 * no path is specified. 3842 * @param string|null $scheme The scheme to use. Accepts 'http', 'https', 3843 * 'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 3844 */ 3845 return apply_filters( 'network_admin_url', $url, $path, $scheme ); 3846 } 3847 3848 /** 3849 * Retrieves the URL to the admin area for the current user. 3850 * 3851 * @since 3.0.0 3852 * 3853 * @param string $path Optional. Path relative to the admin URL. Default empty. 3854 * @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() 3855 * and is_ssl(). 'http' or 'https' can be passed to force those schemes. 3856 * @return string Admin URL link with optional path appended. 3857 */ 3858 function user_admin_url( $path = '', $scheme = 'admin' ) { 3859 $url = network_site_url( 'wp-admin/user/', $scheme ); 3860 3861 if ( $path && is_string( $path ) ) { 3862 $url .= ltrim( $path, '/' ); 3863 } 3864 3865 /** 3866 * Filters the user admin URL for the current user. 3867 * 3868 * @since 3.1.0 3869 * @since 5.8.0 The `$scheme` parameter was added. 3870 * 3871 * @param string $url The complete URL including scheme and path. 3872 * @param string $path Path relative to the URL. Blank string if 3873 * no path is specified. 3874 * @param string|null $scheme The scheme to use. Accepts 'http', 'https', 3875 * 'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 3876 */ 3877 return apply_filters( 'user_admin_url', $url, $path, $scheme ); 3878 } 3879 3880 /** 3881 * Retrieves the URL to the admin area for either the current site or the network depending on context. 3882 * 3883 * @since 3.1.0 3884 * 3885 * @param string $path Optional. Path relative to the admin URL. Default empty. 3886 * @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() 3887 * and is_ssl(). 'http' or 'https' can be passed to force those schemes. 3888 * @return string Admin URL link with optional path appended. 3889 */ 3890 function self_admin_url( $path = '', $scheme = 'admin' ) { 3891 if ( is_network_admin() ) { 3892 $url = network_admin_url( $path, $scheme ); 3893 } elseif ( is_user_admin() ) { 3894 $url = user_admin_url( $path, $scheme ); 3895 } else { 3896 $url = admin_url( $path, $scheme ); 3897 } 3898 3899 /** 3900 * Filters the admin URL for the current site or network depending on context. 3901 * 3902 * @since 4.9.0 3903 * 3904 * @param string $url The complete URL including scheme and path. 3905 * @param string $path Path relative to the URL. Blank string if no path is specified. 3906 * @param string $scheme The scheme to use. 3907 */ 3908 return apply_filters( 'self_admin_url', $url, $path, $scheme ); 3909 } 3910 3911 /** 3912 * Sets the scheme for a URL. 3913 * 3914 * @since 3.4.0 3915 * @since 4.4.0 The 'rest' scheme was added. 3916 * 3917 * @param string $url Absolute URL that includes a scheme 3918 * @param string|null $scheme Optional. Scheme to give $url. Currently 'http', 'https', 'login', 3919 * 'login_post', 'admin', 'relative', 'rest', 'rpc', or null. Default null. 3920 * @return string URL with chosen scheme. 3921 */ 3922 function set_url_scheme( $url, $scheme = null ) { 3923 $orig_scheme = $scheme; 3924 3925 if ( ! $scheme ) { 3926 $scheme = is_ssl() ? 'https' : 'http'; 3927 } elseif ( 'admin' === $scheme || 'login' === $scheme || 'login_post' === $scheme || 'rpc' === $scheme ) { 3928 $scheme = is_ssl() || force_ssl_admin() ? 'https' : 'http'; 3929 } elseif ( 'http' !== $scheme && 'https' !== $scheme && 'relative' !== $scheme ) { 3930 $scheme = is_ssl() ? 'https' : 'http'; 3931 } 3932 3933 $url = trim( $url ); 3934 if ( str_starts_with( $url, '//' ) ) { 3935 $url = 'http:' . $url; 3936 } 3937 3938 if ( 'relative' === $scheme ) { 3939 $url = ltrim( preg_replace( '#^\w+://[^/]*#', '', $url ) ); 3940 if ( '' !== $url && '/' === $url[0] ) { 3941 $url = '/' . ltrim( $url, "/ \t\n\r\0\x0B" ); 3942 } 3943 } else { 3944 $url = preg_replace( '#^\w+://#', $scheme . '://', $url ); 3945 } 3946 3947 /** 3948 * Filters the resulting URL after setting the scheme. 3949 * 3950 * @since 3.4.0 3951 * 3952 * @param string $url The complete URL including scheme and path. 3953 * @param string $scheme Scheme applied to the URL. One of 'http', 'https', or 'relative'. 3954 * @param string|null $orig_scheme Scheme requested for the URL. One of 'http', 'https', 'login', 3955 * 'login_post', 'admin', 'relative', 'rest', 'rpc', or null. 3956 */ 3957 return apply_filters( 'set_url_scheme', $url, $scheme, $orig_scheme ); 3958 } 3959 3960 /** 3961 * Retrieves the URL to the user's dashboard. 3962 * 3963 * If a user does not belong to any site, the global user dashboard is used. If the user 3964 * belongs to the current site, the dashboard for the current site is returned. If the user 3965 * cannot edit the current site, the dashboard to the user's primary site is returned. 3966 * 3967 * @since 3.1.0 3968 * 3969 * @param int $user_id Optional. User ID. Defaults to current user. 3970 * @param string $path Optional path relative to the dashboard. Use only paths known to 3971 * both site and user admins. Default empty. 3972 * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() 3973 * and is_ssl(). 'http' or 'https' can be passed to force those schemes. 3974 * @return string Dashboard URL link with optional path appended. 3975 */ 3976 function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) { 3977 $user_id = $user_id ? (int) $user_id : get_current_user_id(); 3978 3979 $blogs = get_blogs_of_user( $user_id ); 3980 3981 if ( is_multisite() && ! user_can( $user_id, 'manage_network' ) && empty( $blogs ) ) { 3982 $url = user_admin_url( $path, $scheme ); 3983 } elseif ( ! is_multisite() ) { 3984 $url = admin_url( $path, $scheme ); 3985 } else { 3986 $current_blog = get_current_blog_id(); 3987 3988 if ( $current_blog && ( user_can( $user_id, 'manage_network' ) || in_array( $current_blog, array_keys( $blogs ), true ) ) ) { 3989 $url = admin_url( $path, $scheme ); 3990 } else { 3991 $active = get_active_blog_for_user( $user_id ); 3992 if ( $active ) { 3993 $url = get_admin_url( $active->blog_id, $path, $scheme ); 3994 } else { 3995 $url = user_admin_url( $path, $scheme ); 3996 } 3997 } 3998 } 3999 4000 /** 4001 * Filters the dashboard URL for a user. 4002 * 4003 * @since 3.1.0 4004 * 4005 * @param string $url The complete URL including scheme and path. 4006 * @param int $user_id The user ID. 4007 * @param string $path Path relative to the URL. Blank string if no path is specified. 4008 * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login', 4009 * 'login_post', 'admin', 'relative' or null. 4010 */ 4011 return apply_filters( 'user_dashboard_url', $url, $user_id, $path, $scheme ); 4012 } 4013 4014 /** 4015 * Retrieves the URL to the user's profile editor. 4016 * 4017 * @since 3.1.0 4018 * 4019 * @param int $user_id Optional. User ID. Defaults to current user. 4020 * @param string $scheme Optional. The scheme to use. Default is 'admin', which obeys force_ssl_admin() 4021 * and is_ssl(). 'http' or 'https' can be passed to force those schemes. 4022 * @return string Dashboard URL link with optional path appended. 4023 */ 4024 function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) { 4025 $user_id = $user_id ? (int) $user_id : get_current_user_id(); 4026 4027 if ( is_user_admin() ) { 4028 $url = user_admin_url( 'profile.php', $scheme ); 4029 } elseif ( is_network_admin() ) { 4030 $url = network_admin_url( 'profile.php', $scheme ); 4031 } else { 4032 $url = get_dashboard_url( $user_id, 'profile.php', $scheme ); 4033 } 4034 4035 /** 4036 * Filters the URL for a user's profile editor. 4037 * 4038 * @since 3.1.0 4039 * 4040 * @param string $url The complete URL including scheme and path. 4041 * @param int $user_id The user ID. 4042 * @param string $scheme Scheme to give the URL context. Accepts 'http', 'https', 'login', 4043 * 'login_post', 'admin', 'relative' or null. 4044 */ 4045 return apply_filters( 'edit_profile_url', $url, $user_id, $scheme ); 4046 } 4047 4048 /** 4049 * Returns the canonical URL for a post. 4050 * 4051 * When the post is the same as the current requested page the function will handle the 4052 * pagination arguments too. 4053 * 4054 * @since 4.6.0 4055 * 4056 * @param int|WP_Post $post Optional. Post ID or object. Default is global `$post`. 4057 * @return string|false The canonical URL. False if the post does not exist 4058 * or has not been published yet. 4059 */ 4060 function wp_get_canonical_url( $post = null ) { 4061 $post = get_post( $post ); 4062 4063 if ( ! $post ) { 4064 return false; 4065 } 4066 4067 if ( 'publish' !== $post->post_status ) { 4068 return false; 4069 } 4070 4071 $canonical_url = get_permalink( $post ); 4072 4073 // If a canonical is being generated for the current page, make sure it has pagination if needed. 4074 if ( get_queried_object_id() === $post->ID ) { 4075 $page = get_query_var( 'page', 0 ); 4076 if ( $page >= 2 ) { 4077 if ( ! get_option( 'permalink_structure' ) ) { 4078 $canonical_url = add_query_arg( 'page', $page, $canonical_url ); 4079 } else { 4080 $canonical_url = trailingslashit( $canonical_url ) . user_trailingslashit( $page, 'single_paged' ); 4081 } 4082 } 4083 4084 $cpage = get_query_var( 'cpage', 0 ); 4085 if ( $cpage ) { 4086 $canonical_url = get_comments_pagenum_link( $cpage ); 4087 } 4088 } 4089 4090 /** 4091 * Filters the canonical URL for a post. 4092 * 4093 * @since 4.6.0 4094 * 4095 * @param string $canonical_url The post's canonical URL. 4096 * @param WP_Post $post Post object. 4097 */ 4098 return apply_filters( 'get_canonical_url', $canonical_url, $post ); 4099 } 4100 4101 /** 4102 * Outputs rel=canonical for singular queries. 4103 * 4104 * @since 2.9.0 4105 * @since 4.6.0 Adjusted to use `wp_get_canonical_url()`. 4106 */ 4107 function rel_canonical() { 4108 if ( ! is_singular() ) { 4109 return; 4110 } 4111 4112 $id = get_queried_object_id(); 4113 4114 if ( 0 === $id ) { 4115 return; 4116 } 4117 4118 $url = wp_get_canonical_url( $id ); 4119 4120 if ( ! empty( $url ) ) { 4121 echo '<link rel="canonical" href="' . esc_url( $url ) . '" />' . "\n"; 4122 } 4123 } 4124 4125 /** 4126 * Returns a shortlink for a post, page, attachment, or site. 4127 * 4128 * This function exists to provide a shortlink tag that all themes and plugins can target. 4129 * A plugin must hook in to provide the actual shortlinks. Default shortlink support is 4130 * limited to providing ?p= style links for posts. Plugins can short-circuit this function 4131 * via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'} 4132 * filter. 4133 * 4134 * @since 3.0.0 4135 * 4136 * @param int $id Optional. A post or site ID. Default is 0, which means the current post or site. 4137 * @param string $context Optional. Whether the ID is a 'site' ID, 'post' ID, or 'media' ID. If 'post', 4138 * the post_type of the post is consulted. If 'query', the current query is consulted 4139 * to determine the ID and context. Default 'post'. 4140 * @param bool $allow_slugs Optional. Whether to allow post slugs in the shortlink. It is up to the plugin how 4141 * and whether to honor this. Default true. 4142 * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks 4143 * are not enabled. 4144 */ 4145 function wp_get_shortlink( $id = 0, $context = 'post', $allow_slugs = true ) { 4146 /** 4147 * Filters whether to preempt generating a shortlink for the given post. 4148 * 4149 * Returning a value other than false from the filter will short-circuit 4150 * the shortlink generation process, returning that value instead. 4151 * 4152 * @since 3.0.0 4153 * 4154 * @param false|string $return Short-circuit return value. Either false or a URL string. 4155 * @param int $id Post ID, or 0 for the current post. 4156 * @param string $context The context for the link. One of 'post' or 'query', 4157 * @param bool $allow_slugs Whether to allow post slugs in the shortlink. 4158 */ 4159 $shortlink = apply_filters( 'pre_get_shortlink', false, $id, $context, $allow_slugs ); 4160 4161 if ( false !== $shortlink ) { 4162 return $shortlink; 4163 } 4164 4165 $post_id = 0; 4166 if ( 'query' === $context && is_singular() ) { 4167 $post_id = get_queried_object_id(); 4168 $post = get_post( $post_id ); 4169 } elseif ( 'post' === $context ) { 4170 $post = get_post( $id ); 4171 if ( ! empty( $post->ID ) ) { 4172 $post_id = $post->ID; 4173 } 4174 } 4175 4176 $shortlink = ''; 4177 4178 // Return `?p=` link for all public post types. 4179 if ( ! empty( $post_id ) ) { 4180 $post_type = get_post_type_object( $post->post_type ); 4181 4182 if ( 'page' === $post->post_type 4183 && 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID 4184 ) { 4185 $shortlink = home_url( '/' ); 4186 } elseif ( $post_type && $post_type->public ) { 4187 $shortlink = home_url( '?p=' . $post_id ); 4188 } 4189 } 4190 4191 /** 4192 * Filters the shortlink for a post. 4193 * 4194 * @since 3.0.0 4195 * 4196 * @param string $shortlink Shortlink URL. 4197 * @param int $id Post ID, or 0 for the current post. 4198 * @param string $context The context for the link. One of 'post' or 'query', 4199 * @param bool $allow_slugs Whether to allow post slugs in the shortlink. Not used by default. 4200 */ 4201 return apply_filters( 'get_shortlink', $shortlink, $id, $context, $allow_slugs ); 4202 } 4203 4204 /** 4205 * Injects rel=shortlink into the head if a shortlink is defined for the current page. 4206 * 4207 * Attached to the {@see 'wp_head'} action. 4208 * 4209 * @since 3.0.0 4210 */ 4211 function wp_shortlink_wp_head() { 4212 $shortlink = wp_get_shortlink( 0, 'query' ); 4213 4214 if ( empty( $shortlink ) ) { 4215 return; 4216 } 4217 4218 echo "<link rel='shortlink' href='" . esc_url( $shortlink ) . "' />\n"; 4219 } 4220 4221 /** 4222 * Sends a Link: rel=shortlink header if a shortlink is defined for the current page. 4223 * 4224 * Attached to the {@see 'wp'} action. 4225 * 4226 * @since 3.0.0 4227 */ 4228 function wp_shortlink_header() { 4229 if ( headers_sent() ) { 4230 return; 4231 } 4232 4233 $shortlink = wp_get_shortlink( 0, 'query' ); 4234 4235 if ( empty( $shortlink ) ) { 4236 return; 4237 } 4238 4239 header( 'Link: <' . $shortlink . '>; rel=shortlink', false ); 4240 } 4241 4242 /** 4243 * Displays the shortlink for a post. 4244 * 4245 * Must be called from inside "The Loop" 4246 * 4247 * Call like the_shortlink( __( 'Shortlinkage FTW' ) ) 4248 * 4249 * @since 3.0.0 4250 * 4251 * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.' 4252 * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title. 4253 * @param string $before Optional HTML to display before the link. Default empty. 4254 * @param string $after Optional HTML to display after the link. Default empty. 4255 */ 4256 function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) { 4257 $post = get_post(); 4258 4259 if ( empty( $text ) ) { 4260 $text = __( 'This is the short link.' ); 4261 } 4262 4263 if ( empty( $title ) ) { 4264 $title = the_title_attribute( array( 'echo' => false ) ); 4265 } 4266 4267 $shortlink = wp_get_shortlink( $post->ID ); 4268 4269 if ( ! empty( $shortlink ) ) { 4270 $link = '<a rel="shortlink" href="' . esc_url( $shortlink ) . '" title="' . $title . '">' . $text . '</a>'; 4271 4272 /** 4273 * Filters the short link anchor tag for a post. 4274 * 4275 * @since 3.0.0 4276 * 4277 * @param string $link Shortlink anchor tag. 4278 * @param string $shortlink Shortlink URL. 4279 * @param string $text Shortlink's text. 4280 * @param string $title Shortlink's title attribute. 4281 */ 4282 $link = apply_filters( 'the_shortlink', $link, $shortlink, $text, $title ); 4283 echo $before, $link, $after; 4284 } 4285 } 4286 4287 /** 4288 * Retrieves the avatar URL. 4289 * 4290 * @since 4.2.0 4291 * 4292 * @param mixed $id_or_email The avatar to retrieve a URL for. Accepts a user ID, Gravatar MD5 hash, 4293 * user email, WP_User object, WP_Post object, or WP_Comment object. 4294 * @param array $args { 4295 * Optional. Arguments to use instead of the default arguments. 4296 * 4297 * @type int $size Height and width of the avatar in pixels. Default 96. 4298 * @type string $default URL for the default image or a default type. Accepts: 4299 * - '404' (return a 404 instead of a default image) 4300 * - 'retro' (a 8-bit arcade-style pixelated face) 4301 * - 'robohash' (a robot) 4302 * - 'monsterid' (a monster) 4303 * - 'wavatar' (a cartoon face) 4304 * - 'identicon' (the "quilt", a geometric pattern) 4305 * - 'mystery', 'mm', or 'mysteryman' (The Oyster Man) 4306 * - 'blank' (transparent GIF) 4307 * - 'gravatar_default' (the Gravatar logo) 4308 * Default is the value of the 'avatar_default' option, 4309 * with a fallback of 'mystery'. 4310 * @type bool $force_default Whether to always show the default image, never the Gravatar. 4311 * Default false. 4312 * @type string $rating What rating to display avatars up to. Accepts: 4313 * - 'G' (suitable for all audiences) 4314 * - 'PG' (possibly offensive, usually for audiences 13 and above) 4315 * - 'R' (intended for adult audiences above 17) 4316 * - 'X' (even more mature than above) 4317 * Default is the value of the 'avatar_rating' option. 4318 * @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. 4319 * Default null. 4320 * @type array $processed_args When the function returns, the value will be the processed/sanitized $args 4321 * plus a "found_avatar" guess. Pass as a reference. Default null. 4322 * } 4323 * @return string|false The URL of the avatar on success, false on failure. 4324 */ 4325 function get_avatar_url( $id_or_email, $args = null ) { 4326 $args = get_avatar_data( $id_or_email, $args ); 4327 return $args['url']; 4328 } 4329 4330 /** 4331 * Check if this comment type allows avatars to be retrieved. 4332 * 4333 * @since 5.1.0 4334 * 4335 * @param string $comment_type Comment type to check. 4336 * @return bool Whether the comment type is allowed for retrieving avatars. 4337 */ 4338 function is_avatar_comment_type( $comment_type ) { 4339 /** 4340 * Filters the list of allowed comment types for retrieving avatars. 4341 * 4342 * @since 3.0.0 4343 * 4344 * @param array $types An array of content types. Default only contains 'comment'. 4345 */ 4346 $allowed_comment_types = apply_filters( 'get_avatar_comment_types', array( 'comment' ) ); 4347 4348 return in_array( $comment_type, (array) $allowed_comment_types, true ); 4349 } 4350 4351 /** 4352 * Retrieves default data about the avatar. 4353 * 4354 * @since 4.2.0 4355 * @since 6.7.0 Gravatar URLs always use HTTPS. 4356 * 4357 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, 4358 * user email, WP_User object, WP_Post object, or WP_Comment object. 4359 * @param array $args { 4360 * Optional. Arguments to use instead of the default arguments. 4361 * 4362 * @type int $size Height and width of the avatar in pixels. Default 96. 4363 * @type int $height Display height of the avatar in pixels. Defaults to $size. 4364 * @type int $width Display width of the avatar in pixels. Defaults to $size. 4365 * @type string $default URL for the default image or a default type. Accepts: 4366 * - '404' (return a 404 instead of a default image) 4367 * - 'retro' (a 8-bit arcade-style pixelated face) 4368 * - 'robohash' (a robot) 4369 * - 'monsterid' (a monster) 4370 * - 'wavatar' (a cartoon face) 4371 * - 'identicon' (the "quilt", a geometric pattern) 4372 * - 'mystery', 'mm', or 'mysteryman' (The Oyster Man) 4373 * - 'blank' (transparent GIF) 4374 * - 'gravatar_default' (the Gravatar logo) 4375 * Default is the value of the 'avatar_default' option, 4376 * with a fallback of 'mystery'. 4377 * @type bool $force_default Whether to always show the default image, never the Gravatar. 4378 * Default false. 4379 * @type string $rating What rating to display avatars up to. Accepts: 4380 * - 'G' (suitable for all audiences) 4381 * - 'PG' (possibly offensive, usually for audiences 13 and above) 4382 * - 'R' (intended for adult audiences above 17) 4383 * - 'X' (even more mature than above) 4384 * Default is the value of the 'avatar_rating' option. 4385 * @type string $scheme URL scheme to use. See set_url_scheme() for accepted values. 4386 * For Gravatars this setting is ignored and HTTPS is used to avoid 4387 * unnecessary redirects. The setting is retained for systems using 4388 * the {@see 'pre_get_avatar_data'} filter to customize avatars. 4389 * Default null. 4390 * @type array $processed_args When the function returns, the value will be the processed/sanitized $args 4391 * plus a "found_avatar" guess. Pass as a reference. Default null. 4392 * @type string $extra_attr HTML attributes to insert in the IMG element. Is not sanitized. 4393 * Default empty. 4394 * } 4395 * @return array { 4396 * Along with the arguments passed in `$args`, this will contain a couple of extra arguments. 4397 * 4398 * @type bool $found_avatar True if an avatar was found for this user, 4399 * false or not set if none was found. 4400 * @type string|false $url The URL of the avatar that was found, or false. 4401 * } 4402 */ 4403 function get_avatar_data( $id_or_email, $args = null ) { 4404 $args = wp_parse_args( 4405 $args, 4406 array( 4407 'size' => 96, 4408 'height' => null, 4409 'width' => null, 4410 'default' => get_option( 'avatar_default', 'mystery' ), 4411 'force_default' => false, 4412 'rating' => get_option( 'avatar_rating' ), 4413 'scheme' => null, 4414 'processed_args' => null, // If used, should be a reference. 4415 'extra_attr' => '', 4416 ) 4417 ); 4418 4419 if ( is_numeric( $args['size'] ) ) { 4420 $args['size'] = absint( $args['size'] ); 4421 if ( ! $args['size'] ) { 4422 $args['size'] = 96; 4423 } 4424 } else { 4425 $args['size'] = 96; 4426 } 4427 4428 if ( is_numeric( $args['height'] ) ) { 4429 $args['height'] = absint( $args['height'] ); 4430 if ( ! $args['height'] ) { 4431 $args['height'] = $args['size']; 4432 } 4433 } else { 4434 $args['height'] = $args['size']; 4435 } 4436 4437 if ( is_numeric( $args['width'] ) ) { 4438 $args['width'] = absint( $args['width'] ); 4439 if ( ! $args['width'] ) { 4440 $args['width'] = $args['size']; 4441 } 4442 } else { 4443 $args['width'] = $args['size']; 4444 } 4445 4446 if ( empty( $args['default'] ) ) { 4447 $args['default'] = get_option( 'avatar_default', 'mystery' ); 4448 } 4449 4450 switch ( $args['default'] ) { 4451 case 'mm': 4452 case 'mystery': 4453 case 'mysteryman': 4454 $args['default'] = 'mm'; 4455 break; 4456 case 'gravatar_default': 4457 $args['default'] = false; 4458 break; 4459 } 4460 4461 $args['force_default'] = (bool) $args['force_default']; 4462 4463 $args['rating'] = strtolower( $args['rating'] ); 4464 4465 $args['found_avatar'] = false; 4466 4467 /** 4468 * Filters whether to retrieve the avatar URL early. 4469 * 4470 * Passing a non-null value in the 'url' member of the return array will 4471 * effectively short circuit get_avatar_data(), passing the value through 4472 * the {@see 'get_avatar_data'} filter and returning early. 4473 * 4474 * @since 4.2.0 4475 * 4476 * @param array $args Arguments passed to get_avatar_data(), after processing. 4477 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, 4478 * user email, WP_User object, WP_Post object, or WP_Comment object. 4479 */ 4480 $args = apply_filters( 'pre_get_avatar_data', $args, $id_or_email ); 4481 4482 if ( isset( $args['url'] ) ) { 4483 /** This filter is documented in wp-includes/link-template.php */ 4484 return apply_filters( 'get_avatar_data', $args, $id_or_email ); 4485 } 4486 4487 $email_hash = ''; 4488 $user = false; 4489 $email = false; 4490 4491 if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) { 4492 $id_or_email = get_comment( $id_or_email ); 4493 } 4494 4495 // Process the user identifier. 4496 if ( is_numeric( $id_or_email ) ) { 4497 $user = get_user_by( 'id', absint( $id_or_email ) ); 4498 } elseif ( is_string( $id_or_email ) ) { 4499 if ( str_contains( $id_or_email, '@md5.gravatar.com' ) ) { 4500 // MD5 hash. 4501 list( $email_hash ) = explode( '@', $id_or_email ); 4502 } else { 4503 // Email address. 4504 $email = $id_or_email; 4505 } 4506 } elseif ( $id_or_email instanceof WP_User ) { 4507 // User object. 4508 $user = $id_or_email; 4509 } elseif ( $id_or_email instanceof WP_Post ) { 4510 // Post object. 4511 $user = get_user_by( 'id', (int) $id_or_email->post_author ); 4512 } elseif ( $id_or_email instanceof WP_Comment ) { 4513 if ( ! is_avatar_comment_type( get_comment_type( $id_or_email ) ) ) { 4514 $args['url'] = false; 4515 /** This filter is documented in wp-includes/link-template.php */ 4516 return apply_filters( 'get_avatar_data', $args, $id_or_email ); 4517 } 4518 4519 if ( ! empty( $id_or_email->user_id ) ) { 4520 $user = get_user_by( 'id', (int) $id_or_email->user_id ); 4521 } 4522 if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) { 4523 $email = $id_or_email->comment_author_email; 4524 } 4525 } 4526 4527 if ( ! $email_hash ) { 4528 if ( $user ) { 4529 $email = $user->user_email; 4530 } 4531 4532 if ( $email ) { 4533 $email_hash = md5( strtolower( trim( $email ) ) ); 4534 } 4535 } 4536 4537 if ( $email_hash ) { 4538 $args['found_avatar'] = true; 4539 } 4540 4541 $url_args = array( 4542 's' => $args['size'], 4543 'd' => $args['default'], 4544 'f' => $args['force_default'] ? 'y' : false, 4545 'r' => $args['rating'], 4546 ); 4547 4548 /* 4549 * Gravatars are always served over HTTPS. 4550 * 4551 * The Gravatar website redirects HTTP requests to HTTPS URLs so always 4552 * use the HTTPS scheme to avoid unnecessary redirects. 4553 */ 4554 $url = 'https://secure.gravatar.com/avatar/' . $email_hash; 4555 4556 $url = add_query_arg( 4557 rawurlencode_deep( array_filter( $url_args ) ), 4558 $url 4559 ); 4560 4561 /** 4562 * Filters the avatar URL. 4563 * 4564 * @since 4.2.0 4565 * 4566 * @param string $url The URL of the avatar. 4567 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, 4568 * user email, WP_User object, WP_Post object, or WP_Comment object. 4569 * @param array $args Arguments passed to get_avatar_data(), after processing. 4570 */ 4571 $args['url'] = apply_filters( 'get_avatar_url', $url, $id_or_email, $args ); 4572 4573 /** 4574 * Filters the avatar data. 4575 * 4576 * @since 4.2.0 4577 * 4578 * @param array $args Arguments passed to get_avatar_data(), after processing. 4579 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar MD5 hash, 4580 * user email, WP_User object, WP_Post object, or WP_Comment object. 4581 */ 4582 return apply_filters( 'get_avatar_data', $args, $id_or_email ); 4583 } 4584 4585 /** 4586 * Retrieves the URL of a file in the theme. 4587 * 4588 * Searches in the stylesheet directory before the template directory so themes 4589 * which inherit from a parent theme can just override one file. 4590 * 4591 * @since 4.7.0 4592 * 4593 * @param string $file Optional. File to search for in the stylesheet directory. 4594 * @return string The URL of the file. 4595 */ 4596 function get_theme_file_uri( $file = '' ) { 4597 $file = ltrim( $file, '/' ); 4598 4599 $stylesheet_directory = get_stylesheet_directory(); 4600 4601 if ( empty( $file ) ) { 4602 $url = get_stylesheet_directory_uri(); 4603 } elseif ( get_template_directory() !== $stylesheet_directory && file_exists( $stylesheet_directory . '/' . $file ) ) { 4604 $url = get_stylesheet_directory_uri() . '/' . $file; 4605 } else { 4606 $url = get_template_directory_uri() . '/' . $file; 4607 } 4608 4609 /** 4610 * Filters the URL to a file in the theme. 4611 * 4612 * @since 4.7.0 4613 * 4614 * @param string $url The file URL. 4615 * @param string $file The requested file to search for. 4616 */ 4617 return apply_filters( 'theme_file_uri', $url, $file ); 4618 } 4619 4620 /** 4621 * Retrieves the URL of a file in the parent theme. 4622 * 4623 * @since 4.7.0 4624 * 4625 * @param string $file Optional. File to return the URL for in the template directory. 4626 * @return string The URL of the file. 4627 */ 4628 function get_parent_theme_file_uri( $file = '' ) { 4629 $file = ltrim( $file, '/' ); 4630 4631 if ( empty( $file ) ) { 4632 $url = get_template_directory_uri(); 4633 } else { 4634 $url = get_template_directory_uri() . '/' . $file; 4635 } 4636 4637 /** 4638 * Filters the URL to a file in the parent theme. 4639 * 4640 * @since 4.7.0 4641 * 4642 * @param string $url The file URL. 4643 * @param string $file The requested file to search for. 4644 */ 4645 return apply_filters( 'parent_theme_file_uri', $url, $file ); 4646 } 4647 4648 /** 4649 * Retrieves the path of a file in the theme. 4650 * 4651 * Searches in the stylesheet directory before the template directory so themes 4652 * which inherit from a parent theme can just override one file. 4653 * 4654 * @since 4.7.0 4655 * 4656 * @param string $file Optional. File to search for in the stylesheet directory. 4657 * @return string The path of the file. 4658 */ 4659 function get_theme_file_path( $file = '' ) { 4660 $file = ltrim( $file, '/' ); 4661 4662 $stylesheet_directory = get_stylesheet_directory(); 4663 $template_directory = get_template_directory(); 4664 4665 if ( empty( $file ) ) { 4666 $path = $stylesheet_directory; 4667 } elseif ( $stylesheet_directory !== $template_directory && file_exists( $stylesheet_directory . '/' . $file ) ) { 4668 $path = $stylesheet_directory . '/' . $file; 4669 } else { 4670 $path = $template_directory . '/' . $file; 4671 } 4672 4673 /** 4674 * Filters the path to a file in the theme. 4675 * 4676 * @since 4.7.0 4677 * 4678 * @param string $path The file path. 4679 * @param string $file The requested file to search for. 4680 */ 4681 return apply_filters( 'theme_file_path', $path, $file ); 4682 } 4683 4684 /** 4685 * Retrieves the path of a file in the parent theme. 4686 * 4687 * @since 4.7.0 4688 * 4689 * @param string $file Optional. File to return the path for in the template directory. 4690 * @return string The path of the file. 4691 */ 4692 function get_parent_theme_file_path( $file = '' ) { 4693 $file = ltrim( $file, '/' ); 4694 4695 if ( empty( $file ) ) { 4696 $path = get_template_directory(); 4697 } else { 4698 $path = get_template_directory() . '/' . $file; 4699 } 4700 4701 /** 4702 * Filters the path to a file in the parent theme. 4703 * 4704 * @since 4.7.0 4705 * 4706 * @param string $path The file path. 4707 * @param string $file The requested file to search for. 4708 */ 4709 return apply_filters( 'parent_theme_file_path', $path, $file ); 4710 } 4711 4712 /** 4713 * Retrieves the URL to the privacy policy page. 4714 * 4715 * @since 4.9.6 4716 * 4717 * @return string The URL to the privacy policy page. Empty string if it doesn't exist. 4718 */ 4719 function get_privacy_policy_url() { 4720 $url = ''; 4721 $policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' ); 4722 4723 if ( ! empty( $policy_page_id ) && get_post_status( $policy_page_id ) === 'publish' ) { 4724 $url = (string) get_permalink( $policy_page_id ); 4725 } 4726 4727 /** 4728 * Filters the URL of the privacy policy page. 4729 * 4730 * @since 4.9.6 4731 * 4732 * @param string $url The URL to the privacy policy page. Empty string 4733 * if it doesn't exist. 4734 * @param int $policy_page_id The ID of privacy policy page. 4735 */ 4736 return apply_filters( 'privacy_policy_url', $url, $policy_page_id ); 4737 } 4738 4739 /** 4740 * Displays the privacy policy link with formatting, when applicable. 4741 * 4742 * @since 4.9.6 4743 * 4744 * @param string $before Optional. Display before privacy policy link. Default empty. 4745 * @param string $after Optional. Display after privacy policy link. Default empty. 4746 */ 4747 function the_privacy_policy_link( $before = '', $after = '' ) { 4748 echo get_the_privacy_policy_link( $before, $after ); 4749 } 4750 4751 /** 4752 * Returns the privacy policy link with formatting, when applicable. 4753 * 4754 * @since 4.9.6 4755 * @since 6.2.0 Added 'privacy-policy' rel attribute. 4756 * 4757 * @param string $before Optional. Display before privacy policy link. Default empty. 4758 * @param string $after Optional. Display after privacy policy link. Default empty. 4759 * @return string Markup for the link and surrounding elements. Empty string if it 4760 * doesn't exist. 4761 */ 4762 function get_the_privacy_policy_link( $before = '', $after = '' ) { 4763 $link = ''; 4764 $privacy_policy_url = get_privacy_policy_url(); 4765 $policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' ); 4766 $page_title = ( $policy_page_id ) ? get_the_title( $policy_page_id ) : ''; 4767 4768 if ( $privacy_policy_url && $page_title ) { 4769 $link = sprintf( 4770 '<a class="privacy-policy-link" href="%s" rel="privacy-policy">%s</a>', 4771 esc_url( $privacy_policy_url ), 4772 esc_html( $page_title ) 4773 ); 4774 } 4775 4776 /** 4777 * Filters the privacy policy link. 4778 * 4779 * @since 4.9.6 4780 * 4781 * @param string $link The privacy policy link. Empty string if it 4782 * doesn't exist. 4783 * @param string $privacy_policy_url The URL of the privacy policy. Empty string 4784 * if it doesn't exist. 4785 */ 4786 $link = apply_filters( 'the_privacy_policy_link', $link, $privacy_policy_url ); 4787 4788 if ( $link ) { 4789 return $before . $link . $after; 4790 } 4791 4792 return ''; 4793 } 4794 4795 /** 4796 * Returns an array of URL hosts which are considered to be internal hosts. 4797 * 4798 * By default the list of internal hosts is comprised of the host name of 4799 * the site's home_url() (as parsed by wp_parse_url()). 4800 * 4801 * This list is used when determining if a specified URL is a link to a page on 4802 * the site itself or a link offsite (to an external host). This is used, for 4803 * example, when determining if the "nofollow" attribute should be applied to a 4804 * link. 4805 * 4806 * @see wp_is_internal_link 4807 * 4808 * @since 6.2.0 4809 * 4810 * @return string[] An array of URL hosts. 4811 */ 4812 function wp_internal_hosts() { 4813 static $internal_hosts; 4814 4815 if ( empty( $internal_hosts ) ) { 4816 /** 4817 * Filters the array of URL hosts which are considered internal. 4818 * 4819 * @since 6.2.0 4820 * 4821 * @param string[] $internal_hosts An array of internal URL hostnames. 4822 */ 4823 $internal_hosts = apply_filters( 4824 'wp_internal_hosts', 4825 array( 4826 wp_parse_url( home_url(), PHP_URL_HOST ), 4827 ) 4828 ); 4829 $internal_hosts = array_unique( 4830 array_map( 'strtolower', (array) $internal_hosts ) 4831 ); 4832 } 4833 4834 return $internal_hosts; 4835 } 4836 4837 /** 4838 * Determines whether or not the specified URL is of a host included in the internal hosts list. 4839 * 4840 * @see wp_internal_hosts() 4841 * 4842 * @since 6.2.0 4843 * 4844 * @param string $link The URL to test. 4845 * @return bool Returns true for internal URLs and false for all other URLs. 4846 */ 4847 function wp_is_internal_link( $link ) { 4848 $link = strtolower( $link ); 4849 if ( in_array( wp_parse_url( $link, PHP_URL_SCHEME ), wp_allowed_protocols(), true ) ) { 4850 return in_array( wp_parse_url( $link, PHP_URL_HOST ), wp_internal_hosts(), true ); 4851 } 4852 return false; 4853 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Thu Nov 21 08:20:01 2024 | Cross-referenced by PHPXref |