| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * WordPress Feed API 4 * 5 * Many of the functions used in here belong in The Loop, or The Loop for the 6 * Feeds. 7 * 8 * @package WordPress 9 * @subpackage Feed 10 * @since 2.1.0 11 */ 12 13 /** 14 * Retrieves RSS container for the bloginfo function. 15 * 16 * You can retrieve anything that you can using the get_bloginfo() function. 17 * Everything will be stripped of tags and characters converted, when the values 18 * are retrieved for use in the feeds. 19 * 20 * @since 1.5.1 21 * 22 * @see get_bloginfo() For the list of possible values to display. 23 * 24 * @param string $show See get_bloginfo() for possible values. 25 * @return string 26 */ 27 function get_bloginfo_rss( $show = '' ) { 28 $info = strip_tags( get_bloginfo( $show ) ); 29 /** 30 * Filters the bloginfo for use in RSS feeds. 31 * 32 * @since 2.2.0 33 * 34 * @see convert_chars() 35 * @see get_bloginfo() 36 * 37 * @param string $info Converted string value of the blog information. 38 * @param string $show The type of blog information to retrieve. 39 */ 40 return apply_filters( 'get_bloginfo_rss', convert_chars( $info ), $show ); 41 } 42 43 /** 44 * Displays RSS container for the bloginfo function. 45 * 46 * You can retrieve anything that you can using the get_bloginfo() function. 47 * Everything will be stripped of tags and characters converted, when the values 48 * are retrieved for use in the feeds. 49 * 50 * @since 0.71 51 * 52 * @see get_bloginfo() For the list of possible values to display. 53 * 54 * @param string $show See get_bloginfo() for possible values. 55 */ 56 function bloginfo_rss( $show = '' ) { 57 /** 58 * Filters the bloginfo for display in RSS feeds. 59 * 60 * @since 2.1.0 61 * 62 * @see get_bloginfo() 63 * 64 * @param string $rss_container RSS container for the blog information. 65 * @param string $show The type of blog information to retrieve. 66 */ 67 echo apply_filters( 'bloginfo_rss', get_bloginfo_rss( $show ), $show ); 68 } 69 70 /** 71 * Retrieves the default feed. 72 * 73 * The default feed is 'rss2', unless a plugin changes it through the 74 * {@see 'default_feed'} filter. 75 * 76 * @since 2.5.0 77 * 78 * @return string Default feed, or for example 'rss2', 'atom', etc. 79 */ 80 function get_default_feed() { 81 /** 82 * Filters the default feed type. 83 * 84 * @since 2.5.0 85 * 86 * @param string $feed_type Type of default feed. Possible values include 'rss2', 'atom'. 87 * Default 'rss2'. 88 */ 89 $default_feed = apply_filters( 'default_feed', 'rss2' ); 90 91 return ( 'rss' === $default_feed ) ? 'rss2' : $default_feed; 92 } 93 94 /** 95 * Retrieves the blog title for the feed title. 96 * 97 * @since 2.2.0 98 * @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`. 99 * 100 * @param string $deprecated Unused. 101 * @return string The document title. 102 */ 103 function get_wp_title_rss( $deprecated = '–' ) { 104 if ( '–' !== $deprecated ) { 105 /* translators: %s: 'document_title_separator' filter name. */ 106 _deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), '<code>document_title_separator</code>' ) ); 107 } 108 109 /** 110 * Filters the blog title for use as the feed title. 111 * 112 * @since 2.2.0 113 * @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`. 114 * 115 * @param string $title The current blog title. 116 * @param string $deprecated Unused. 117 */ 118 return apply_filters( 'get_wp_title_rss', wp_get_document_title(), $deprecated ); 119 } 120 121 /** 122 * Displays the blog title for display of the feed title. 123 * 124 * @since 2.2.0 125 * @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`. 126 * 127 * @param string $deprecated Unused. 128 */ 129 function wp_title_rss( $deprecated = '–' ) { 130 if ( '–' !== $deprecated ) { 131 /* translators: %s: 'document_title_separator' filter name. */ 132 _deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), '<code>document_title_separator</code>' ) ); 133 } 134 135 /** 136 * Filters the blog title for display of the feed title. 137 * 138 * @since 2.2.0 139 * @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`. 140 * 141 * @see get_wp_title_rss() 142 * 143 * @param string $wp_title_rss The current blog title. 144 * @param string $deprecated Unused. 145 */ 146 echo apply_filters( 'wp_title_rss', get_wp_title_rss(), $deprecated ); 147 } 148 149 /** 150 * Retrieves the current post title for the feed. 151 * 152 * @since 2.0.0 153 * @since 6.6.0 Added the `$post` parameter. 154 * 155 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 156 * @return string Current post title. 157 */ 158 function get_the_title_rss( $post = 0 ) { 159 $title = get_the_title( $post ); 160 161 /** 162 * Filters the post title for use in a feed. 163 * 164 * @since 1.2.0 165 * 166 * @param string $title The current post title. 167 */ 168 return apply_filters( 'the_title_rss', $title ); 169 } 170 171 /** 172 * Displays the post title in the feed. 173 * 174 * @since 0.71 175 */ 176 function the_title_rss() { 177 echo get_the_title_rss(); 178 } 179 180 /** 181 * Retrieves the post content for feeds. 182 * 183 * @since 2.9.0 184 * 185 * @see get_the_content() 186 * 187 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf 188 * @return string The filtered content. 189 */ 190 function get_the_content_feed( $feed_type = null ) { 191 if ( ! $feed_type ) { 192 $feed_type = get_default_feed(); 193 } 194 195 /** This filter is documented in wp-includes/post-template.php */ 196 $content = apply_filters( 'the_content', get_the_content() ); 197 $content = str_replace( ']]>', ']]>', $content ); 198 199 /** 200 * Filters the post content for use in feeds. 201 * 202 * @since 2.9.0 203 * 204 * @param string $content The current post content. 205 * @param string $feed_type Type of feed. Possible values include 'rss2', 'atom'. 206 * Default 'rss2'. 207 */ 208 return apply_filters( 'the_content_feed', $content, $feed_type ); 209 } 210 211 /** 212 * Displays the post content for feeds. 213 * 214 * @since 2.9.0 215 * 216 * @param string $feed_type The type of feed. rss2 | atom | rss | rdf 217 */ 218 function the_content_feed( $feed_type = null ) { 219 echo get_the_content_feed( $feed_type ); 220 } 221 222 /** 223 * Displays the post excerpt for the feed. 224 * 225 * @since 0.71 226 */ 227 function the_excerpt_rss() { 228 $output = get_the_excerpt(); 229 /** 230 * Filters the post excerpt for a feed. 231 * 232 * @since 1.2.0 233 * 234 * @param string $output The current post excerpt. 235 */ 236 echo apply_filters( 'the_excerpt_rss', $output ); 237 } 238 239 /** 240 * Displays the permalink to the post for use in feeds. 241 * 242 * @since 2.3.0 243 */ 244 function the_permalink_rss() { 245 /** 246 * Filters the permalink to the post for use in feeds. 247 * 248 * @since 2.3.0 249 * 250 * @param string $post_permalink The current post permalink. 251 */ 252 echo esc_url( apply_filters( 'the_permalink_rss', get_permalink() ) ); 253 } 254 255 /** 256 * Outputs the link to the comments for the current post in an XML safe way. 257 * 258 * @since 3.0.0 259 */ 260 function comments_link_feed() { 261 /** 262 * Filters the comments permalink for the current post. 263 * 264 * @since 3.6.0 265 * 266 * @param string $comment_permalink The current comment permalink with 267 * '#comments' appended. 268 */ 269 echo esc_url( apply_filters( 'comments_link_feed', get_comments_link() ) ); 270 } 271 272 /** 273 * Displays the feed GUID for the current comment. 274 * 275 * @since 2.5.0 276 * 277 * @param int|WP_Comment $comment_id Optional comment object or ID. Defaults to global comment object. 278 */ 279 function comment_guid( $comment_id = null ) { 280 echo esc_url( get_comment_guid( $comment_id ) ); 281 } 282 283 /** 284 * Retrieves the feed GUID for the current comment. 285 * 286 * @since 2.5.0 287 * 288 * @param int|WP_Comment $comment_id Optional comment object or ID. Defaults to global comment object. 289 * @return string|false GUID for comment on success, false on failure. 290 */ 291 function get_comment_guid( $comment_id = null ) { 292 $comment = get_comment( $comment_id ); 293 294 if ( ! is_object( $comment ) ) { 295 return false; 296 } 297 298 return get_the_guid( $comment->comment_post_ID ) . '#comment-' . $comment->comment_ID; 299 } 300 301 /** 302 * Displays the link to the comments. 303 * 304 * @since 1.5.0 305 * @since 4.4.0 Introduced the `$comment` argument. 306 * 307 * @param int|WP_Comment $comment Optional. Comment object or ID. Defaults to global comment object. 308 */ 309 function comment_link( $comment = null ) { 310 /** 311 * Filters the current comment's permalink. 312 * 313 * @since 3.6.0 314 * 315 * @see get_comment_link() 316 * 317 * @param string $comment_permalink The current comment permalink. 318 */ 319 echo esc_url( apply_filters( 'comment_link', get_comment_link( $comment ) ) ); 320 } 321 322 /** 323 * Retrieves the current comment author for use in the feeds. 324 * 325 * @since 2.0.0 326 * 327 * @return string Comment Author. 328 */ 329 function get_comment_author_rss() { 330 /** 331 * Filters the current comment author for use in a feed. 332 * 333 * @since 1.5.0 334 * 335 * @see get_comment_author() 336 * 337 * @param string $comment_author The current comment author. 338 */ 339 return apply_filters( 'comment_author_rss', get_comment_author() ); 340 } 341 342 /** 343 * Displays the current comment author in the feed. 344 * 345 * @since 1.0.0 346 */ 347 function comment_author_rss() { 348 echo get_comment_author_rss(); 349 } 350 351 /** 352 * Displays the current comment content for use in the feeds. 353 * 354 * @since 1.0.0 355 */ 356 function comment_text_rss() { 357 $comment_text = get_comment_text(); 358 /** 359 * Filters the current comment content for use in a feed. 360 * 361 * @since 1.5.0 362 * 363 * @param string $comment_text The content of the current comment. 364 */ 365 $comment_text = apply_filters( 'comment_text_rss', $comment_text ); 366 echo $comment_text; 367 } 368 369 /** 370 * Retrieves all of the post categories, formatted for use in feeds. 371 * 372 * All of the categories for the current post in the feed loop, will be 373 * retrieved and have feed markup added, so that they can easily be added to the 374 * RSS2, Atom, or RSS1 and RSS0.91 RDF feeds. 375 * 376 * @since 2.1.0 377 * 378 * @param string $type Optional, default is the type returned by get_default_feed(). 379 * @return string All of the post categories for displaying in the feed. 380 */ 381 function get_the_category_rss( $type = null ) { 382 if ( empty( $type ) ) { 383 $type = get_default_feed(); 384 } 385 $categories = get_the_category(); 386 $tags = get_the_tags(); 387 $the_list = ''; 388 $cat_names = array(); 389 390 $filter = 'rss'; 391 if ( 'atom' === $type ) { 392 $filter = 'raw'; 393 } 394 395 if ( ! empty( $categories ) ) { 396 foreach ( (array) $categories as $category ) { 397 $cat_names[] = sanitize_term_field( 'name', $category->name, $category->term_id, 'category', $filter ); 398 } 399 } 400 401 if ( ! empty( $tags ) ) { 402 foreach ( (array) $tags as $tag ) { 403 $cat_names[] = sanitize_term_field( 'name', $tag->name, $tag->term_id, 'post_tag', $filter ); 404 } 405 } 406 407 $cat_names = array_unique( $cat_names ); 408 409 foreach ( $cat_names as $cat_name ) { 410 if ( 'rdf' === $type ) { 411 $the_list .= "\t\t<dc:subject><![CDATA[$cat_name]]></dc:subject>\n"; 412 } elseif ( 'atom' === $type ) { 413 $the_list .= sprintf( '<category scheme="%1$s" term="%2$s" />', esc_attr( get_bloginfo_rss( 'url' ) ), esc_attr( $cat_name ) ); 414 } else { 415 $the_list .= "\t\t<category><![CDATA[" . html_entity_decode( $cat_name, ENT_COMPAT, get_option( 'blog_charset' ) ) . "]]></category>\n"; 416 } 417 } 418 419 /** 420 * Filters all of the post categories for display in a feed. 421 * 422 * @since 1.2.0 423 * 424 * @param string $the_list All of the RSS post categories. 425 * @param string $type Type of feed. Possible values include 'rss2', 'atom'. 426 * Default 'rss2'. 427 */ 428 return apply_filters( 'the_category_rss', $the_list, $type ); 429 } 430 431 /** 432 * Displays the post categories in the feed. 433 * 434 * @since 0.71 435 * 436 * @see get_the_category_rss() For better explanation. 437 * 438 * @param string $type Optional, default is the type returned by get_default_feed(). 439 */ 440 function the_category_rss( $type = null ) { 441 echo get_the_category_rss( $type ); 442 } 443 444 /** 445 * Displays the HTML type based on the blog setting. 446 * 447 * The two possible values are either 'xhtml' or 'html'. 448 * 449 * @since 2.2.0 450 */ 451 function html_type_rss() { 452 $type = get_bloginfo( 'html_type' ); 453 if ( str_contains( $type, 'xhtml' ) ) { 454 $type = 'xhtml'; 455 } else { 456 $type = 'html'; 457 } 458 echo $type; 459 } 460 461 /** 462 * Displays the rss enclosure for the current post. 463 * 464 * Uses the global $post to check whether the post requires a password and if 465 * the user has the password for the post. If not then it will return before 466 * displaying. 467 * 468 * Also uses the function get_post_custom() to get the post's 'enclosure' 469 * metadata field and parses the value to display the enclosure(s). The 470 * enclosure(s) consist of enclosure HTML tag(s) with a URI and other 471 * attributes. 472 * 473 * @since 1.5.0 474 */ 475 function rss_enclosure() { 476 if ( post_password_required() ) { 477 return; 478 } 479 480 foreach ( (array) get_post_custom() as $key => $val ) { 481 if ( 'enclosure' === $key ) { 482 foreach ( (array) $val as $enc ) { 483 $enclosure = explode( "\n", $enc ); 484 485 if ( count( $enclosure ) < 3 ) { 486 continue; 487 } 488 489 // Only get the first element, e.g. 'audio/mpeg' from 'audio/mpeg mpga mp2 mp3'. 490 $t = preg_split( '/[ \t]/', trim( $enclosure[2] ) ); 491 $type = $t[0]; 492 493 /** 494 * Filters the RSS enclosure HTML link tag for the current post. 495 * 496 * @since 2.2.0 497 * 498 * @param string $html_link_tag The HTML link tag with a URI and other attributes. 499 */ 500 echo apply_filters( 'rss_enclosure', '<enclosure url="' . esc_url( trim( $enclosure[0] ) ) . '" length="' . absint( trim( $enclosure[1] ) ) . '" type="' . esc_attr( $type ) . '" />' . "\n" ); 501 } 502 } 503 } 504 } 505 506 /** 507 * Displays the atom enclosure for the current post. 508 * 509 * Uses the global $post to check whether the post requires a password and if 510 * the user has the password for the post. If not then it will return before 511 * displaying. 512 * 513 * Also uses the function get_post_custom() to get the post's 'enclosure' 514 * metadata field and parses the value to display the enclosure(s). The 515 * enclosure(s) consist of link HTML tag(s) with a URI and other attributes. 516 * 517 * @since 2.2.0 518 */ 519 function atom_enclosure() { 520 if ( post_password_required() ) { 521 return; 522 } 523 524 foreach ( (array) get_post_custom() as $key => $val ) { 525 if ( 'enclosure' === $key ) { 526 foreach ( (array) $val as $enc ) { 527 $enclosure = explode( "\n", $enc ); 528 529 $url = ''; 530 $type = ''; 531 $length = 0; 532 533 $mimes = get_allowed_mime_types(); 534 535 // Parse URL. 536 if ( isset( $enclosure[0] ) && is_string( $enclosure[0] ) ) { 537 $url = trim( $enclosure[0] ); 538 } 539 540 // Parse length and type. 541 for ( $i = 1; $i <= 2; $i++ ) { 542 if ( isset( $enclosure[ $i ] ) ) { 543 if ( is_numeric( $enclosure[ $i ] ) ) { 544 $length = trim( $enclosure[ $i ] ); 545 } elseif ( in_array( $enclosure[ $i ], $mimes, true ) ) { 546 $type = trim( $enclosure[ $i ] ); 547 } 548 } 549 } 550 551 $html_link_tag = sprintf( 552 "<link href=\"%s\" rel=\"enclosure\" length=\"%d\" type=\"%s\" />\n", 553 esc_url( $url ), 554 esc_attr( $length ), 555 esc_attr( $type ) 556 ); 557 558 /** 559 * Filters the atom enclosure HTML link tag for the current post. 560 * 561 * @since 2.2.0 562 * 563 * @param string $html_link_tag The HTML link tag with a URI and other attributes. 564 */ 565 echo apply_filters( 'atom_enclosure', $html_link_tag ); 566 } 567 } 568 } 569 } 570 571 /** 572 * Determines the type of a string of data with the data formatted. 573 * 574 * Tell whether the type is text, HTML, or XHTML, per RFC 4287 section 3.1. 575 * 576 * In the case of WordPress, text is defined as containing no markup, 577 * XHTML is defined as "well formed", and HTML as tag soup (i.e., the rest). 578 * 579 * Container div tags are added to XHTML values, per section 3.1.1.3. 580 * 581 * @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1 582 * 583 * @since 2.5.0 584 * 585 * @param string $data Input string. 586 * @return array array(type, value) 587 */ 588 function prep_atom_text_construct( $data ) { 589 if ( ! str_contains( $data, '<' ) && ! str_contains( $data, '&' ) ) { 590 return array( 'text', $data ); 591 } 592 593 if ( ! function_exists( 'xml_parser_create' ) ) { 594 wp_trigger_error( '', __( "PHP's XML extension is not available. Please contact your hosting provider to enable PHP's XML extension." ) ); 595 596 return array( 'html', "<![CDATA[$data]]>" ); 597 } 598 599 $parser = xml_parser_create(); 600 xml_parse( $parser, '<div>' . $data . '</div>', true ); 601 $code = xml_get_error_code( $parser ); 602 603 if ( PHP_VERSION_ID < 80000 ) { // xml_parser_free() has no effect as of PHP 8.0. 604 xml_parser_free( $parser ); 605 } 606 607 unset( $parser ); 608 609 if ( ! $code ) { 610 if ( ! str_contains( $data, '<' ) ) { 611 return array( 'text', $data ); 612 } else { 613 $data = "<div xmlns='http://www.w3.org/1999/xhtml'>$data</div>"; 614 return array( 'xhtml', $data ); 615 } 616 } 617 618 if ( ! str_contains( $data, ']]>' ) ) { 619 return array( 'html', "<![CDATA[$data]]>" ); 620 } else { 621 return array( 'html', htmlspecialchars( $data ) ); 622 } 623 } 624 625 /** 626 * Displays Site Icon in atom feeds. 627 * 628 * @since 4.3.0 629 * 630 * @see get_site_icon_url() 631 */ 632 function atom_site_icon() { 633 $url = get_site_icon_url( 32 ); 634 if ( $url ) { 635 echo '<icon>' . convert_chars( $url ) . "</icon>\n"; 636 } 637 } 638 639 /** 640 * Displays Site Icon in RSS2. 641 * 642 * @since 4.3.0 643 */ 644 function rss2_site_icon() { 645 $rss_title = get_wp_title_rss(); 646 if ( empty( $rss_title ) ) { 647 $rss_title = get_bloginfo_rss( 'name' ); 648 } 649 650 $url = get_site_icon_url( 32 ); 651 if ( $url ) { 652 echo ' 653 <image> 654 <url>' . convert_chars( $url ) . '</url> 655 <title>' . $rss_title . '</title> 656 <link>' . get_bloginfo_rss( 'url' ) . '</link> 657 <width>32</width> 658 <height>32</height> 659 </image> ' . "\n"; 660 } 661 } 662 663 /** 664 * Returns the link for the currently displayed feed. 665 * 666 * @since 5.3.0 667 * 668 * @return string Correct link for the atom:self element. 669 */ 670 function get_self_link() { 671 $parsed = parse_url( home_url() ); 672 673 $domain = $parsed['host']; 674 if ( isset( $parsed['port'] ) ) { 675 $domain .= ':' . $parsed['port']; 676 } 677 678 return set_url_scheme( 'http://' . $domain . wp_unslash( $_SERVER['REQUEST_URI'] ) ); 679 } 680 681 /** 682 * Displays the link for the currently displayed feed in a XSS safe way. 683 * 684 * Generate a correct link for the atom:self element. 685 * 686 * @since 2.5.0 687 */ 688 function self_link() { 689 /** 690 * Filters the current feed URL. 691 * 692 * @since 3.6.0 693 * 694 * @see set_url_scheme() 695 * @see wp_unslash() 696 * 697 * @param string $feed_link The link for the feed with set URL scheme. 698 */ 699 echo esc_url( apply_filters( 'self_link', get_self_link() ) ); 700 } 701 702 /** 703 * Retrieves the XML namespaces for the root element of a feed. 704 * 705 * Namespaces are keyed by their prefix, so the same prefix cannot be 706 * declared twice. The default namespaces of a feed type cannot be removed, 707 * as the bundled feed templates use them in their static markup. 708 * 709 * @since 7.2.0 710 * 711 * @param string $type Type of feed. Possible values include 'rss2', 'rss2-comments', 712 * 'rdf', 'atom', and 'atom-comments'. 713 * @return array<string, string> Array of namespace URIs, keyed by their prefix. 714 * @phpstan-param non-falsy-string $type 715 * @phpstan-return array<non-falsy-string, non-falsy-string> 716 */ 717 function wp_get_feed_namespaces( string $type ): array { 718 $defaults = array(); 719 720 switch ( $type ) { 721 case 'rss2': 722 $defaults = array( 723 'content' => 'http://purl.org/rss/1.0/modules/content/', 724 'wfw' => 'http://wellformedweb.org/CommentAPI/', 725 'dc' => 'http://purl.org/dc/elements/1.1/', 726 'atom' => 'http://www.w3.org/2005/Atom', 727 'sy' => 'http://purl.org/rss/1.0/modules/syndication/', 728 'slash' => 'http://purl.org/rss/1.0/modules/slash/', 729 ); 730 break; 731 732 case 'rss2-comments': 733 $defaults = array( 734 'content' => 'http://purl.org/rss/1.0/modules/content/', 735 'dc' => 'http://purl.org/dc/elements/1.1/', 736 'atom' => 'http://www.w3.org/2005/Atom', 737 'sy' => 'http://purl.org/rss/1.0/modules/syndication/', 738 ); 739 break; 740 741 case 'rdf': 742 $defaults = array( 743 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#', 744 'dc' => 'http://purl.org/dc/elements/1.1/', 745 'sy' => 'http://purl.org/rss/1.0/modules/syndication/', 746 'admin' => 'http://webns.net/mvcb/', 747 'content' => 'http://purl.org/rss/1.0/modules/content/', 748 ); 749 break; 750 751 case 'atom': 752 case 'atom-comments': 753 $defaults = array( 754 'thr' => 'http://purl.org/syndication/thread/1.0', 755 ); 756 break; 757 } 758 759 /** 760 * Filters the XML namespaces of a feed's root element. 761 * 762 * Namespaces are keyed by their prefix, which makes duplicate `xmlns` 763 * attributes impossible. 764 * 765 * @since 7.2.0 766 * 767 * @param array<string, string> $namespaces Array of namespace URIs, keyed by their prefix. 768 * @param string $type Type of feed. Possible values include 'rss2', 769 * 'rss2-comments', 'rdf', 'atom', and 'atom-comments'. 770 */ 771 $namespaces = apply_filters( 'wp_feed_namespaces', $defaults, $type ); 772 773 if ( ! is_array( $namespaces ) ) { 774 $namespaces = array(); 775 } 776 777 // The bundled feed templates use the default namespaces, so they cannot be removed. 778 $namespaces = array_merge( $namespaces, $defaults ); 779 780 $sanitized = array(); 781 782 foreach ( $namespaces as $prefix => $uri ) { 783 $prefix = (string) $prefix; 784 785 // Prefixes must be valid XML names, and the `xml` and `xmlns` prefixes are reserved. 786 if ( ! preg_match( '/^[\p{L}_][\p{L}\p{M}\p{N}._\-\x{B7}]*\z/u', $prefix ) 787 || in_array( strtolower( $prefix ), array( 'xml', 'xmlns' ), true ) 788 ) { 789 continue; 790 } 791 792 if ( ! is_string( $uri ) || empty( $uri ) ) { 793 continue; 794 } 795 796 $sanitized[ $prefix ] = $uri; 797 } 798 799 return $sanitized; 800 } 801 802 /** 803 * Displays the XML namespaces for the root element of a feed. 804 * 805 * Plugins should add namespaces via the {@see 'wp_feed_namespaces'} filter instead 806 * of the older {@see "{$type}_ns"} actions, as two action callbacks printing the 807 * same namespace produce a duplicate attribute, which is a well-formedness 808 * error in XML. 809 * 810 * @since 7.2.0 811 * 812 * @param string $type Type of feed. Possible values include 'rss2', 'rss2-comments', 813 * 'rdf', 'atom', and 'atom-comments'. 814 * @phpstan-param non-falsy-string $type 815 */ 816 function wp_feed_namespaces( string $type ): void { 817 foreach ( wp_get_feed_namespaces( $type ) as $prefix => $uri ) { 818 printf( "xmlns:%s=\"%s\"\n\t", $prefix, esc_attr( $uri ) ); 819 } 820 } 821 822 /** 823 * Gets the UTC time of the most recently modified post from WP_Query. 824 * 825 * If viewing a comment feed, the time of the most recently modified 826 * comment will be returned. 827 * 828 * @since 5.2.0 829 * 830 * @global WP_Query $wp_query WordPress Query object. 831 * 832 * @param string $format Date format string to return the time in. 833 * @return string|false The time in requested format, or false on failure. 834 */ 835 function get_feed_build_date( $format ) { 836 global $wp_query; 837 838 $datetime = false; 839 $max_modified_time = false; 840 $utc = new DateTimeZone( 'UTC' ); 841 842 if ( ! empty( $wp_query ) && $wp_query->have_posts() ) { 843 // Extract the post modified times from the posts. 844 $modified_times = wp_list_pluck( $wp_query->posts, 'post_modified_gmt' ); 845 846 // If this is a comment feed, check those objects too. 847 if ( $wp_query->is_comment_feed() && $wp_query->comment_count ) { 848 // Extract the comment modified times from the comments. 849 $comment_times = wp_list_pluck( $wp_query->comments, 'comment_date_gmt' ); 850 851 // Add the comment times to the post times for comparison. 852 $modified_times = array_merge( $modified_times, $comment_times ); 853 } 854 855 // Determine the maximum modified time. 856 $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', max( $modified_times ), $utc ); 857 } 858 859 if ( false === $datetime ) { 860 // Fall back to last time any post was modified or published. 861 $datetime = date_create_immutable_from_format( 'Y-m-d H:i:s', get_lastpostmodified( 'GMT' ), $utc ); 862 } 863 864 if ( false !== $datetime ) { 865 $max_modified_time = $datetime->format( $format ); 866 } 867 868 /** 869 * Filters the date the last post or comment in the query was modified. 870 * 871 * @since 5.2.0 872 * 873 * @param string|false $max_modified_time Date the last post or comment was modified in the query, in UTC. 874 * False on failure. 875 * @param string $format The date format requested in get_feed_build_date(). 876 */ 877 return apply_filters( 'get_feed_build_date', $max_modified_time, $format ); 878 } 879 880 /** 881 * Returns the content type for specified feed type. 882 * 883 * @since 2.8.0 884 * 885 * @param string $type Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'. 886 * @return string Content type for specified feed type. 887 */ 888 function feed_content_type( $type = '' ) { 889 if ( empty( $type ) ) { 890 $type = get_default_feed(); 891 } 892 893 $types = array( 894 'rss' => 'application/rss+xml', 895 'rss2' => 'application/rss+xml', 896 'rss-http' => 'text/xml', 897 'atom' => 'application/atom+xml', 898 'rdf' => 'application/rdf+xml', 899 ); 900 901 $content_type = ( ! empty( $types[ $type ] ) ) ? $types[ $type ] : 'application/octet-stream'; 902 903 /** 904 * Filters the content type for a specific feed type. 905 * 906 * @since 2.8.0 907 * 908 * @param string $content_type Content type indicating the type of data that a feed contains. 909 * @param string $type Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'. 910 */ 911 return apply_filters( 'feed_content_type', $content_type, $type ); 912 } 913 914 /** 915 * Builds SimplePie object based on RSS or Atom feed from URL. 916 * 917 * @since 2.8.0 918 * 919 * @param string|string[] $url URL of feed to retrieve. If an array of URLs, the feeds are merged 920 * using SimplePie's multifeed feature. 921 * See also {@link http://simplepie.org/wiki/faq/typical_multifeed_gotchas} 922 * @return SimplePie\SimplePie|WP_Error SimplePie object on success or WP_Error object on failure. 923 */ 924 function fetch_feed( $url ) { 925 if ( ! class_exists( 'SimplePie\SimplePie', false ) ) { 926 require_once ABSPATH . WPINC . '/class-simplepie.php'; 927 } 928 929 require_once ABSPATH . WPINC . '/class-wp-feed-cache-transient.php'; 930 require_once ABSPATH . WPINC . '/class-wp-simplepie-file.php'; 931 require_once ABSPATH . WPINC . '/class-wp-simplepie-sanitize-kses.php'; 932 933 $feed = new SimplePie\SimplePie(); 934 935 $feed->get_registry()->register( SimplePie\Sanitize::class, 'WP_SimplePie_Sanitize_KSES', true ); 936 937 /* 938 * We must manually overwrite $feed->sanitize because SimplePie's constructor 939 * sets it before we have a chance to set the sanitization class. 940 */ 941 $feed->sanitize = new WP_SimplePie_Sanitize_KSES(); 942 943 // Register the cache handler using the recommended method for SimplePie 1.3 or later. 944 if ( method_exists( 'SimplePie_Cache', 'register' ) ) { 945 SimplePie_Cache::register( 'wp_transient', 'WP_Feed_Cache_Transient' ); 946 $feed->set_cache_location( 'wp_transient' ); 947 } else { 948 // Back-compat for SimplePie 1.2.x. 949 require_once ABSPATH . WPINC . '/class-wp-feed-cache.php'; 950 $feed->set_cache_class( 'WP_Feed_Cache' ); 951 } 952 953 $feed->get_registry()->register( SimplePie\File::class, 'WP_SimplePie_File', true ); 954 955 /** This filter is documented in wp-includes/class-wp-feed-cache-transient.php */ 956 $feed->set_cache_duration( apply_filters( 'wp_feed_cache_transient_lifetime', 12 * HOUR_IN_SECONDS, $url ) ); 957 958 /** 959 * Fires just before processing the SimplePie feed object. 960 * 961 * @since 3.0.0 962 * 963 * @param SimplePie\SimplePie $feed SimplePie feed object (passed by reference). 964 * @param string|string[] $url URL of feed or array of URLs of feeds to retrieve. 965 */ 966 do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) ); 967 968 if ( empty( $url ) ) { 969 /* 970 * @todo: Set $url to empty string once supported by SimplePie. 971 * 972 * The early return without proceeding is to work around a PHP 8.5 973 * deprecation issue resolved in https://github.com/simplepie/simplepie/pull/949 974 * 975 * To avoid the duplicate code, this block can be replaced with `$url = '';` once SimplePie 976 * is upgraded to a version that includes the fix. 977 */ 978 $feed->init(); 979 $feed->set_output_encoding( get_bloginfo( 'charset' ) ); 980 981 if ( $feed->error() ) { 982 return new WP_Error( 'simplepie-error', $feed->error() ); 983 } 984 985 return $feed; 986 } elseif ( is_array( $url ) && count( $url ) === 1 ) { 987 $url = array_shift( $url ); 988 } elseif ( is_array( $url ) ) { 989 $feeds = array(); 990 $simplepie_errors = array(); 991 foreach ( $url as $feed_url ) { 992 $simplepie_instance = clone $feed; 993 $simplepie_instance->set_feed_url( $feed_url ); 994 $simplepie_instance->init(); 995 $simplepie_instance->set_output_encoding( get_bloginfo( 'charset' ) ); 996 997 if ( $simplepie_instance->error() ) { 998 $simplepie_errors[] = sprintf( 999 /* translators: %1$s is the feed URL, %2$s is the error message. */ 1000 __( 'Error fetching feed %1$s: %2$s' ), 1001 esc_url( $feed_url ), 1002 $simplepie_instance->error() 1003 ); 1004 unset( $simplepie_instance ); 1005 continue; 1006 } 1007 1008 $feeds[] = $simplepie_instance; 1009 unset( $simplepie_instance ); 1010 } 1011 1012 if ( ! empty( $simplepie_errors ) ) { 1013 return new WP_Error( 'simplepie-error', $simplepie_errors ); 1014 } 1015 1016 $feed->init(); 1017 $feed->data['items'] = SimplePie\SimplePie::merge_items( $feeds ); 1018 return $feed; 1019 } 1020 1021 $feed->set_feed_url( $url ); 1022 $feed->init(); 1023 $feed->set_output_encoding( get_bloginfo( 'charset' ) ); 1024 1025 if ( $feed->error() ) { 1026 return new WP_Error( 'simplepie-error', $feed->error() ); 1027 } 1028 1029 return $feed; 1030 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Tue Sep 15 08:20:32 2026 | Cross-referenced by PHPXref |