X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..refs/tags/wordpress-4.3:/wp-includes/feed.php diff --git a/wp-includes/feed.php b/wp-includes/feed.php index 8f9219c5..f40f41a6 100644 --- a/wp-includes/feed.php +++ b/wp-includes/feed.php @@ -1,155 +1,374 @@ get_error_message(); - $title = apply_filters('get_wp_title_rss', $title); + } + + if ( $title && $sep && ' ' !== substr( $title, 0, 1 ) ) { + $title = " $sep " . $title; + } + + /** + * Filter the blog title for use as the feed title. + * + * @since 2.2.0 + * + * @param string $title The current blog title. + * @param string $sep Separator used by wp_title(). + */ + $title = apply_filters( 'get_wp_title_rss', $title, $sep ); return $title; } -function wp_title_rss($sep = '»') { - echo apply_filters('wp_title_rss', get_wp_title_rss($sep)); +/** + * Display the blog title for display of the feed title. + * + * @since 2.2.0 + * @see wp_title() $sep parameter usage. + * + * @param string $sep Optional. + */ +function wp_title_rss( $sep = '»' ) { + /** + * Filter the blog title for display of the feed title. + * + * @since 2.2.0 + * + * @see get_wp_title_rss() + * + * @param string $wp_title The current blog title. + * @param string $sep Separator used by wp_title(). + */ + echo apply_filters( 'wp_title_rss', get_wp_title_rss( $sep ), $sep ); } +/** + * Retrieve the current post title for the feed. + * + * @since 2.0.0 + * + * @return string Current post title. + */ function get_the_title_rss() { $title = get_the_title(); - $title = apply_filters('the_title_rss', $title); + /** + * Filter the post title for use in a feed. + * + * @since 1.2.0 + * + * @param string $title The current post title. + */ + $title = apply_filters( 'the_title_rss', $title ); return $title; } - +/** + * Display the post title in the feed. + * + * @since 0.71 + */ function the_title_rss() { echo get_the_title_rss(); } - -function the_content_rss($more_link_text='(more...)', $stripteaser=0, $more_file='', $cut = 0, $encode_html = 0) { - $content = get_the_content($more_link_text, $stripteaser, $more_file); - $content = apply_filters('the_content_rss', $content); - if ( $cut && !$encode_html ) - $encode_html = 2; - if ( 1== $encode_html ) { - $content = wp_specialchars($content); - $cut = 0; - } elseif ( 0 == $encode_html ) { - $content = make_url_footnote($content); - } elseif ( 2 == $encode_html ) { - $content = strip_tags($content); - } - if ( $cut ) { - $blah = explode(' ', $content); - if ( count($blah) > $cut ) { - $k = $cut; - $use_dotdotdot = 1; - } else { - $k = count($blah); - $use_dotdotdot = 0; - } - for ( $i=0; $i<$k; $i++ ) - $excerpt .= $blah[$i].' '; - $excerpt .= ($use_dotdotdot) ? '...' : ''; - $content = $excerpt; - } +/** + * Retrieve the post content for feeds. + * + * @since 2.9.0 + * @see get_the_content() + * + * @param string $feed_type The type of feed. rss2 | atom | rss | rdf + * @return string The filtered content. + */ +function get_the_content_feed($feed_type = null) { + if ( !$feed_type ) + $feed_type = get_default_feed(); + + /** This filter is documented in wp-includes/post-template.php */ + $content = apply_filters( 'the_content', get_the_content() ); $content = str_replace(']]>', ']]>', $content); - echo $content; + /** + * Filter the post content for use in feeds. + * + * @since 2.9.0 + * + * @param string $content The current post content. + * @param string $feed_type Type of feed. Possible values include 'rss2', 'atom'. + * Default 'rss2'. + */ + return apply_filters( 'the_content_feed', $content, $feed_type ); } +/** + * Display the post content for feeds. + * + * @since 2.9.0 + * + * @param string $feed_type The type of feed. rss2 | atom | rss | rdf + */ +function the_content_feed($feed_type = null) { + echo get_the_content_feed($feed_type); +} +/** + * Display the post excerpt for the feed. + * + * @since 0.71 + */ function the_excerpt_rss() { $output = get_the_excerpt(); - echo apply_filters('the_excerpt_rss', $output); + /** + * Filter the post excerpt for a feed. + * + * @since 1.2.0 + * + * @param string $output The current post excerpt. + */ + echo apply_filters( 'the_excerpt_rss', $output ); } +/** + * Display the permalink to the post for use in feeds. + * + * @since 2.3.0 + */ function the_permalink_rss() { - echo apply_filters('the_permalink_rss', get_permalink()); + /** + * Filter the permalink to the post for use in feeds. + * + * @since 2.3.0 + * + * @param string $post_permalink The current post permalink. + */ + echo esc_url( apply_filters( 'the_permalink_rss', get_permalink() ) ); +} +/** + * Outputs the link to the comments for the current post in an xml safe way + * + * @since 3.0.0 + * @return none + */ +function comments_link_feed() { + /** + * Filter the comments permalink for the current post. + * + * @since 3.6.0 + * + * @param string $comment_permalink The current comment permalink with + * '#comments' appended. + */ + echo esc_url( apply_filters( 'comments_link_feed', get_comments_link() ) ); } -function comment_link() { - echo get_comment_link(); +/** + * Display the feed GUID for the current comment. + * + * @since 2.5.0 + * + * @param int|object $comment_id Optional comment object or id. Defaults to global comment object. + */ +function comment_guid($comment_id = null) { + echo esc_url( get_comment_guid($comment_id) ); } +/** + * Retrieve the feed GUID for the current comment. + * + * @since 2.5.0 + * + * @param int|object $comment_id Optional comment object or id. Defaults to global comment object. + * @return false|string false on failure or guid for comment on success. + */ +function get_comment_guid($comment_id = null) { + $comment = get_comment($comment_id); + + if ( !is_object($comment) ) + return false; -function get_comment_author_rss() { - return apply_filters('comment_author_rss', get_comment_author() ); + return get_the_guid($comment->comment_post_ID) . '#comment-' . $comment->comment_ID; } +/** + * Display the link to the comments. + * + * @since 1.5.0 + */ +function comment_link() { + /** + * Filter the current comment's permalink. + * + * @since 3.6.0 + * + * @see get_comment_link() + * + * @param string $comment_permalink The current comment permalink. + */ + echo esc_url( apply_filters( 'comment_link', get_comment_link() ) ); +} +/** + * Retrieve the current comment author for use in the feeds. + * + * @since 2.0.0 + * + * @return string Comment Author + */ +function get_comment_author_rss() { + /** + * Filter the current comment author for use in a feed. + * + * @since 1.5.0 + * + * @see get_comment_author() + * + * @param string $comment_author The current comment author. + */ + return apply_filters( 'comment_author_rss', get_comment_author() ); +} + +/** + * Display the current comment author in the feed. + * + * @since 1.0.0 + */ function comment_author_rss() { echo get_comment_author_rss(); } - +/** + * Display the current comment content for use in the feeds. + * + * @since 1.0.0 + */ function comment_text_rss() { $comment_text = get_comment_text(); - $comment_text = apply_filters('comment_text_rss', $comment_text); + /** + * Filter the current comment content for use in a feed. + * + * @since 1.5.0 + * + * @param string $comment_text The content of the current comment. + */ + $comment_text = apply_filters( 'comment_text_rss', $comment_text ); echo $comment_text; } - -function comments_rss_link($link_text = 'Comments RSS', $commentsrssfilename = 'nolongerused') { - $url = get_post_comments_feed_link(); - echo "$link_text"; -} - - -function comments_rss($commentsrssfilename = 'nolongerused') { - return get_post_comments_feed_link(); -} - - -function get_author_rss_link($echo = false, $author_id, $author_nicename) { - $auth_ID = (int) $author_id; - $permalink_structure = get_option('permalink_structure'); - - if ( '' == $permalink_structure ) { - $link = get_option('home') . '?feed=rss2&author=' . $author_id; - } else { - $link = get_author_posts_url($author_id, $author_nicename); - $link = trailingslashit($link) . user_trailingslashit('feed', 'feed'); - } - - $link = apply_filters('author_feed_link', $link); - - if ( $echo ) - echo $link; - return $link; -} - - -function get_category_rss_link($echo = false, $cat_ID, $category_nicename) { - $permalink_structure = get_option('permalink_structure'); - - if ( '' == $permalink_structure ) { - $link = get_option('home') . '?feed=rss2&cat=' . $cat_ID; - } else { - $link = get_category_link($cat_ID); - $link = trailingslashit($link) . user_trailingslashit('feed', 'feed'); - } - - $link = apply_filters('category_feed_link', $link); - - if ( $echo ) - echo $link; - return $link; -} - - -function get_the_category_rss($type = 'rss') { +/** + * Retrieve all of the post categories, formatted for use in feeds. + * + * All of the categories for the current post in the feed loop, will be + * retrieved and have feed markup added, so that they can easily be added to the + * RSS2, Atom, or RSS1 and RSS0.91 RDF feeds. + * + * @since 2.1.0 + * + * @param string $type Optional, default is the type returned by get_default_feed(). + * @return string All of the post categories for displaying in the feed. + */ +function get_the_category_rss($type = null) { + if ( empty($type) ) + $type = get_default_feed(); $categories = get_the_category(); $tags = get_the_tags(); - $home = get_bloginfo_rss('home'); $the_list = ''; $cat_names = array(); @@ -169,47 +388,44 @@ function get_the_category_rss($type = 'rss') { foreach ( $cat_names as $cat_name ) { if ( 'rdf' == $type ) - $the_list .= "\n\t\t\n"; + $the_list .= "\t\t\n"; elseif ( 'atom' == $type ) - $the_list .= sprintf( '', attribute_escape( apply_filters( 'get_bloginfo_rss', get_bloginfo( 'url' ) ) ), attribute_escape( $cat_name ) ); + $the_list .= sprintf( '', esc_attr( get_bloginfo_rss( 'url' ) ), esc_attr( $cat_name ) ); else - $the_list .= "\n\t\t\n"; + $the_list .= "\t\t\n"; } - return apply_filters('the_category_rss', $the_list, $type); + /** + * Filter all of the post categories for display in a feed. + * + * @since 1.2.0 + * + * @param string $the_list All of the RSS post categories. + * @param string $type Type of feed. Possible values include 'rss2', 'atom'. + * Default 'rss2'. + */ + return apply_filters( 'the_category_rss', $the_list, $type ); } - -function the_category_rss($type = 'rss') { +/** + * Display the post categories in the feed. + * + * @since 0.71 + * @see get_the_category_rss() For better explanation. + * + * @param string $type Optional, default is the type returned by get_default_feed(). + */ +function the_category_rss($type = null) { echo get_the_category_rss($type); } -function get_tag_feed_link($tag_id, $feed = 'rss2') { - $tag_id = (int) $tag_id; - - $tag = get_tag($tag_id); - - if ( empty($tag) || is_wp_error($tag) ) - return false; - - $permalink_structure = get_option('permalink_structure'); - - if ( '' == $permalink_structure ) { - $link = get_option('home') . "?feed=$feed&tag=" . $tag->slug; - } else { - $link = get_tag_link($tag->term_id); - if ( 'rss2' == $feed ) - $feed_link = 'feed'; - else - $feed_link = "feed/$feed"; - $link = $link . user_trailingslashit($feed_link, 'feed'); - } - - $link = apply_filters('tag_feed_link', $link, $feed); - - return $link; -} - +/** + * Display the HTML type based on the blog setting. + * + * The two possible values are either 'xhtml' or 'html'. + * + * @since 2.2.0 + */ function html_type_rss() { $type = get_bloginfo('html_type'); if (strpos($type, 'xhtml') !== false) @@ -219,35 +435,256 @@ function html_type_rss() { echo $type; } - +/** + * Display the rss enclosure for the current post. + * + * Uses the global $post to check whether the post requires a password and if + * the user has the password for the post. If not then it will return before + * displaying. + * + * Also uses the function get_post_custom() to get the post's 'enclosure' + * metadata field and parses the value to display the enclosure(s). The + * enclosure(s) consist of enclosure HTML tag(s) with a URI and other + * attributes. + * + * @since 1.5.0 + */ function rss_enclosure() { - global $id, $post; - if ( !empty($post->post_password) && ($_COOKIE['wp-postpass_'.COOKIEHASH] != $post->post_password) ) + if ( post_password_required() ) return; - foreach (get_post_custom() as $key => $val) { + foreach ( (array) get_post_custom() as $key => $val) { if ($key == 'enclosure') { - foreach ((array)$val as $enc) { - $enclosure = split("\n", $enc); - echo apply_filters('rss_enclosure', '' . "\n"); + foreach ( (array) $val as $enc ) { + $enclosure = explode("\n", $enc); + + // only get the first element, e.g. audio/mpeg from 'audio/mpeg mpga mp2 mp3' + $t = preg_split('/[ \t]/', trim($enclosure[2]) ); + $type = $t[0]; + + /** + * Filter the RSS enclosure HTML link tag for the current post. + * + * @since 2.2.0 + * + * @param string $html_link_tag The HTML link tag with a URI and other attributes. + */ + echo apply_filters( 'rss_enclosure', '' . "\n" ); } } } } +/** + * Display the atom enclosure for the current post. + * + * Uses the global $post to check whether the post requires a password and if + * the user has the password for the post. If not then it will return before + * displaying. + * + * Also uses the function get_post_custom() to get the post's 'enclosure' + * metadata field and parses the value to display the enclosure(s). The + * enclosure(s) consist of link HTML tag(s) with a URI and other attributes. + * + * @since 2.2.0 + */ function atom_enclosure() { - global $id, $post; - if ( !empty($post->post_password) && ($_COOKIE['wp-postpass_'.COOKIEHASH] != $post->post_password) ) + if ( post_password_required() ) return; - foreach (get_post_custom() as $key => $val) { + foreach ( (array) get_post_custom() as $key => $val ) { if ($key == 'enclosure') { - foreach ((array)$val as $enc) { - $enclosure = split("\n", $enc); - echo apply_filters('atom_enclosure', '' . "\n"); + foreach ( (array) $val as $enc ) { + $enclosure = explode("\n", $enc); + /** + * Filter the atom enclosure HTML link tag for the current post. + * + * @since 2.2.0 + * + * @param string $html_link_tag The HTML link tag with a URI and other attributes. + */ + echo apply_filters( 'atom_enclosure', '' . "\n" ); } } } } -?> +/** + * Determine the type of a string of data with the data formatted. + * + * Tell whether the type is text, html, or xhtml, per RFC 4287 section 3.1. + * + * In the case of WordPress, text is defined as containing no markup, + * xhtml is defined as "well formed", and html as tag soup (i.e., the rest). + * + * Container div tags are added to xhtml values, per section 3.1.1.3. + * + * @link http://www.atomenabled.org/developers/syndication/atom-format-spec.php#rfc.section.3.1 + * + * @since 2.5.0 + * + * @param string $data Input string + * @return array array(type, value) + */ +function prep_atom_text_construct($data) { + if (strpos($data, '<') === false && strpos($data, '&') === false) { + return array('text', $data); + } + + $parser = xml_parser_create(); + xml_parse($parser, '
' . $data . '
', true); + $code = xml_get_error_code($parser); + xml_parser_free($parser); + + if (!$code) { + if (strpos($data, '<') === false) { + return array('text', $data); + } else { + $data = "
$data
"; + return array('xhtml', $data); + } + } + + if (strpos($data, ']]>') === false) { + return array('html', ""); + } else { + return array('html', htmlspecialchars($data)); + } +} + +/** + * Displays Site Icon in atom feeds. + * + * @since 4.3.0 + * + * @see get_site_icon_url() + */ +function atom_site_icon() { + $url = get_site_icon_url( 32 ); + if ( $url ) { + echo "$url\n"; + } +} + +/** + * Displays Site Icon in RSS2. + * + * @since 4.3.0 + */ +function rss2_site_icon() { + $rss_title = get_wp_title_rss(); + if ( empty( $rss_title ) ) { + $rss_title = get_bloginfo_rss( 'name' ); + } + + $url = get_site_icon_url( 32 ); + if ( $url ) { + echo ' + + ' . convert_chars( $url ) . ' + ' . $rss_title . ' + ' . get_bloginfo_rss( 'url' ) . ' + 32 + 32 + ' . "\n"; + } +} + +/** + * Display the link for the currently displayed feed in a XSS safe way. + * + * Generate a correct link for the atom:self element. + * + * @since 2.5.0 + */ +function self_link() { + $host = @parse_url(home_url()); + /** + * Filter the current feed URL. + * + * @since 3.6.0 + * + * @see set_url_scheme() + * @see wp_unslash() + * + * @param string $feed_link The link for the feed with set URL scheme. + */ + echo esc_url( apply_filters( 'self_link', set_url_scheme( 'http://' . $host['host'] . wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) ); +} + +/** + * Return the content type for specified feed type. + * + * @since 2.8.0 + */ +function feed_content_type( $type = '' ) { + if ( empty($type) ) + $type = get_default_feed(); + + $types = array( + 'rss' => 'application/rss+xml', + 'rss2' => 'application/rss+xml', + 'rss-http' => 'text/xml', + 'atom' => 'application/atom+xml', + 'rdf' => 'application/rdf+xml' + ); + + $content_type = ( !empty($types[$type]) ) ? $types[$type] : 'application/octet-stream'; + + /** + * Filter the content type for a specific feed type. + * + * @since 2.8.0 + * + * @param string $content_type Content type indicating the type of data that a feed contains. + * @param string $type Type of feed. Possible values include 'rss2', 'atom'. + * Default 'rss2'. + */ + return apply_filters( 'feed_content_type', $content_type, $type ); +} + +/** + * Build SimplePie object based on RSS or Atom feed from URL. + * + * @since 2.8.0 + * + * @param mixed $url URL of feed to retrieve. If an array of URLs, the feeds are merged + * using SimplePie's multifeed feature. + * See also {@link ​http://simplepie.org/wiki/faq/typical_multifeed_gotchas} + * + * @return WP_Error|SimplePie WP_Error object on failure or SimplePie object on success + */ +function fetch_feed( $url ) { + require_once( ABSPATH . WPINC . '/class-feed.php' ); + + $feed = new SimplePie(); + + $feed->set_sanitize_class( 'WP_SimplePie_Sanitize_KSES' ); + // We must manually overwrite $feed->sanitize because SimplePie's + // constructor sets it before we have a chance to set the sanitization class + $feed->sanitize = new WP_SimplePie_Sanitize_KSES(); + + $feed->set_cache_class( 'WP_Feed_Cache' ); + $feed->set_file_class( 'WP_SimplePie_File' ); + + $feed->set_feed_url( $url ); + /** This filter is documented in wp-includes/class-feed.php */ + $feed->set_cache_duration( apply_filters( 'wp_feed_cache_transient_lifetime', 12 * HOUR_IN_SECONDS, $url ) ); + /** + * Fires just before processing the SimplePie feed object. + * + * @since 3.0.0 + * + * @param object &$feed SimplePie feed object, passed by reference. + * @param mixed $url URL of feed to retrieve. If an array of URLs, the feeds are merged. + */ + do_action_ref_array( 'wp_feed_options', array( &$feed, $url ) ); + $feed->init(); + $feed->set_output_encoding( get_option( 'blog_charset' ) ); + $feed->handle_content_type(); + + if ( $feed->error() ) + return new WP_Error( 'simplepie-error', $feed->error() ); + + return $feed; +}