enmi-conf.org: comparison wp/wp-includes/feed.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 * Many of the functions used in here belong in The Loop, or The Loop for the
 * Feeds.
 *
 * @package WordPress
 * @subpackage Feed
+* @since 2.1.0
 */
 /**
 * RSS container for the bloginfo function.
 *
 * @return string
 */
 function get_bloginfo_rss($show = '') {
 	$info = strip_tags(get_bloginfo($show));
 	/**
-	 * Filter the bloginfo for use in RSS feeds.
+	 * Filters the bloginfo for use in RSS feeds.
 	 *
 	 * @since 2.2.0
 	 *
 	 * @see convert_chars()
 	 * @see get_bloginfo()
 *
 * @param string $show See get_bloginfo() for possible values.
 */
 function bloginfo_rss($show = '') {
 	/**
-	 * Filter the bloginfo for display in RSS feeds.
+	 * Filters the bloginfo for display in RSS feeds.
 	 *
 	 * @since 2.1.0
 	 *
 	 * @see get_bloginfo()
 	 *
 /**
 * Retrieve the default feed.
 *
 * The default feed is 'rss2', unless a plugin changes it through the
-* 'default_feed' filter.
+* {@see 'default_feed'} filter.
 *
 * @since 2.5.0
 *
 * @return string Default feed, or for example 'rss2', 'atom', etc.
 */
 function get_default_feed() {
 	/**
-	 * Filter the default feed type.
+	 * Filters the default feed type.
 	 *
 	 * @since 2.5.0
 	 *
 	 * @param string $feed_type Type of default feed. Possible values include 'rss2', 'atom'.
 	 *                          Default 'rss2'.
 /**
 * Retrieve the blog title for the feed title.
 *
 * @since 2.2.0
-*
+* @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`.
-* @param string $sep Optional. How to separate the title. See wp_title() for more info.
+*
-* @return string Error message on failure or blog title on success.
+* @param string $deprecated Unused..
-*/
+* @return string The document title.
-function get_wp_title_rss( $sep = '&#187;' ) {
+*/
-	$title = wp_title( $sep, false );
+function get_wp_title_rss( $deprecated = '&#8211;' ) {
+	if ( '&#8211;' !== $deprecated ) {
-	if ( is_wp_error( $title ) ) {
+		/* translators: %s: 'document_title_separator' filter name */
-		return $title->get_error_message();
+		_deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), '<code>document_title_separator</code>' ) );
 	}
-	if ( $title && $sep && ' ' !== substr( $title, 0, 1 ) ) {
+	/**
-		$title = " $sep " . $title;
+	 * Filters the blog title for use as the feed title.
-	}
-	/**
-	 * Filter the blog title for use as the feed title.
 	 *
 	 * @since 2.2.0
-	 *
+	 * @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`.
-	 * @param string $title The current blog title.
+	 *
-	 * @param string $sep   Separator used by wp_title().
+	 * @param string $title      The current blog title.
-	 */
+	 * @param string $deprecated Unused.
-	$title = apply_filters( 'get_wp_title_rss', $title, $sep );
+	 */
-	return $title;
+	return apply_filters( 'get_wp_title_rss', wp_get_document_title(), $deprecated );
 }
 /**
 * Display the blog title for display of the feed title.
 *
 * @since 2.2.0
-* @see wp_title() $sep parameter usage.
+* @since 4.4.0 The optional `$sep` parameter was deprecated and renamed to `$deprecated`.
 *
-* @param string $sep Optional.
+* @param string $deprecated Unused.
 */
-function wp_title_rss( $sep = '&#187;' ) {
+function wp_title_rss( $deprecated = '&#8211;' ) {
-	/**
+	if ( '&#8211;' !== $deprecated ) {
-	 * Filter the blog title for display of the feed title.
+		/* translators: %s: 'document_title_separator' filter name */
+		_deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), '<code>document_title_separator</code>' ) );
+	}
+	/**
+	 * Filters the blog title for display of the feed title.
 	 *
 	 * @since 2.2.0
+	 * @since 4.4.0 The `$sep` parameter was deprecated and renamed to `$deprecated`.
 	 *
 	 * @see get_wp_title_rss()
 	 *
-	 * @param string $wp_title The current blog title.
+	 * @param string $wp_title_rss The current blog title.
-	 * @param string $sep      Separator used by wp_title().
+	 * @param string $deprecated   Unused.
 	 */
-	echo apply_filters( 'wp_title_rss', get_wp_title_rss( $sep ), $sep );
+	echo apply_filters( 'wp_title_rss', get_wp_title_rss(), $deprecated );
 }
 /**
 * Retrieve the current post title for the feed.
 *
 *
 * @return string Current post title.
 */
 function get_the_title_rss() {
 	$title = get_the_title();
-	/**
-	 * Filter the post title for use in a feed.
+	/**
+	 * Filters the post title for use in a feed.
 	 *
 	 * @since 1.2.0
 	 *
 	 * @param string $title The current post title.
 	 */
 	/** This filter is documented in wp-includes/post-template.php */
 	$content = apply_filters( 'the_content', get_the_content() );
 	$content = str_replace(']]>', ']]&gt;', $content);
 	/**
-	 * Filter the post content for use in feeds.
+	 * Filters 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'.
 * @since 0.71
 */
 function the_excerpt_rss() {
 	$output = get_the_excerpt();
 	/**
-	 * Filter the post excerpt for a feed.
+	 * Filters the post excerpt for a feed.
 	 *
 	 * @since 1.2.0
 	 *
 	 * @param string $output The current post excerpt.
 	 */
 *
 * @since 2.3.0
 */
 function the_permalink_rss() {
 	/**
-	 * Filter the permalink to the post for use in feeds.
+	 * Filters the permalink to the post for use in feeds.
 	 *
 	 * @since 2.3.0
 	 *
 	 * @param string $post_permalink The current post permalink.
 	 */
 * @since 3.0.0
 * @return none
 */
 function comments_link_feed() {
 	/**
-	 * Filter the comments permalink for the current post.
+	 * Filters the comments permalink for the current post.
 	 *
 	 * @since 3.6.0
 	 *
 	 * @param string $comment_permalink The current comment permalink with
 	 *                                  '#comments' appended.
 /**
 * 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.
+* @param int|WP_Comment $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.
+* @param int|WP_Comment $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);
 /**
 * Display the link to the comments.
 *
 * @since 1.5.0
-*/
+* @since 4.4.0 Introduced the `$comment` argument.
-function comment_link() {
+*
-	/**
+* @param int|WP_Comment $comment Optional. Comment object or id. Defaults to global comment object.
-	 * Filter the current comment's permalink.
+*/
+function comment_link( $comment = null ) {
+	/**
+	 * Filters 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() ) );
+	echo esc_url( apply_filters( 'comment_link', get_comment_link( $comment ) ) );
 }
 /**
 * Retrieve the current comment author for use in the feeds.
 *
 *
 * @return string Comment Author
 */
 function get_comment_author_rss() {
 	/**
-	 * Filter the current comment author for use in a feed.
+	 * Filters the current comment author for use in a feed.
 	 *
 	 * @since 1.5.0
 	 *
 	 * @see get_comment_author()
 	 *
 * @since 1.0.0
 */
 function comment_text_rss() {
 	$comment_text = get_comment_text();
 	/**
-	 * Filter the current comment content for use in a feed.
+	 * Filters the current comment content for use in a feed.
 	 *
 	 * @since 1.5.0
 	 *
 	 * @param string $comment_text The content of the current comment.
 	 */
 		else
 			$the_list .= "\t\t<category><![CDATA[" . @html_entity_decode( $cat_name, ENT_COMPAT, get_option('blog_charset') ) . "]]></category>\n";
 	}
 	/**
-	 * Filter all of the post categories for display in a feed.
+	 * Filters 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'.
 				// 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.
+				 * Filters 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', '<enclosure url="' . trim( htmlspecialchars( $enclosure[0] ) ) . '" length="' . trim( $enclosure[1] ) . '" type="' . $type . '" />' . "\n" );
+				echo apply_filters( 'rss_enclosure', '<enclosure url="' . esc_url( trim( $enclosure[0] ) ) . '" length="' . absint( trim( $enclosure[1] ) ) . '" type="' . esc_attr( $type ) . '" />' . "\n" );
 			}
 		}
 	}
 }
 	foreach ( (array) get_post_custom() as $key => $val ) {
 		if ($key == 'enclosure') {
 			foreach ( (array) $val as $enc ) {
 				$enclosure = explode("\n", $enc);
 				/**
-				 * Filter the atom enclosure HTML link tag for the current post.
+				 * Filters 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', '<link href="' . trim( htmlspecialchars( $enclosure[0] ) ) . '" rel="enclosure" length="' . trim( $enclosure[1] ) . '" type="' . trim( $enclosure[2] ) . '" />' . "\n" );
+				echo apply_filters( 'atom_enclosure', '<link href="' . esc_url( trim( $enclosure[0] ) ) . '" rel="enclosure" length="' . absint( trim( $enclosure[1] ) ) . '" type="' . esc_attr( trim( $enclosure[2] ) ) . '" />' . "\n" );
 			}
 		}
 	}
 }
 * @return array array(type, value)
 */
 function prep_atom_text_construct($data) {
 	if (strpos($data, '<') === false && strpos($data, '&') === false) {
 		return array('text', $data);
+	}
+	if ( ! function_exists( 'xml_parser_create' ) ) {
+		trigger_error( __( "PHP's XML extension is not available. Please contact your hosting provider to enable PHP's XML extension." ) );
+		return array( 'html', "<![CDATA[$data]]>" );
 	}
 	$parser = xml_parser_create();
 	xml_parse($parser, '<div>' . $data . '</div>', true);
 	$code = xml_get_error_code($parser);
 			$data = "<div xmlns='http://www.w3.org/1999/xhtml'>$data</div>";
 			return array('xhtml', $data);
 		}
 	}
-	if (strpos($data, ']]>') == false) {
+	if (strpos($data, ']]>') === false) {
 		return array('html', "<![CDATA[$data]]>");
 	} 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 "<icon>$url</icon>\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 '
+<image>
+	<url>' . convert_chars( $url ) . '</url>
+	<title>' . $rss_title . '</title>
+	<link>' . get_bloginfo_rss( 'url' ) . '</link>
+	<width>32</width>
+	<height>32</height>
+</image> ' . "\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.
+	 * Filters the current feed URL.
 	 *
 	 * @since 3.6.0
 	 *
 	 * @see set_url_scheme()
 	 * @see wp_unslash()
 /**
 * Return the content type for specified feed type.
 *
 * @since 2.8.0
+*
+* @param string $type Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'.
 */
 function feed_content_type( $type = '' ) {
 	if ( empty($type) )
 		$type = get_default_feed();
 	$types = array(
-		'rss'  => 'application/rss+xml',
+		'rss'      => 'application/rss+xml',
-		'rss2' => 'application/rss+xml',
+		'rss2'     => 'application/rss+xml',
-		'rss-http'  => 'text/xml',
+		'rss-http' => 'text/xml',
-		'atom' => 'application/atom+xml',
+		'atom'     => 'application/atom+xml',
-		'rdf'  => 'application/rdf+xml'
+		'rdf'      => 'application/rdf+xml'
 	);
 	$content_type = ( !empty($types[$type]) ) ? $types[$type] : 'application/octet-stream';
 	/**
-	 * Filter the content type for a specific feed type.
+	 * Filters 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'.
+	 * @param string $type         Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'.
-	 *                             Default 'rss2'.
 	 */
 	return apply_filters( 'feed_content_type', $content_type, $type );
 }
 /**
 * 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' );
+	if ( ! class_exists( 'SimplePie', false ) ) {
+		require_once( ABSPATH . WPINC . '/class-simplepie.php' );
+	}
+	require_once( ABSPATH . WPINC . '/class-wp-feed-cache.php' );
+	require_once( ABSPATH . WPINC . '/class-wp-feed-cache-transient.php' );
+	require_once( ABSPATH . WPINC . '/class-wp-simplepie-file.php' );
+	require_once( ABSPATH . WPINC . '/class-wp-simplepie-sanitize-kses.php' );
 	$feed = new SimplePie();
 	$feed->set_sanitize_class( 'WP_SimplePie_Sanitize_KSES' );
 	// We must manually overwrite $feed->sanitize because SimplePie's
 	$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 */
+	/** This filter is documented in wp-includes/class-wp-feed-cache-transient.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 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.
+	 * @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->handle_content_type();
+	$feed->set_output_encoding( get_option( 'blog_charset' ) );
 	if ( $feed->error() )
 		return new WP_Error( 'simplepie-error', $feed->error() );
 	return $feed;

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9