X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..refs/heads/pristine:/wp-includes/feed.php?ds=sidebyside
diff --git a/wp-includes/feed.php b/wp-includes/feed.php
index c77abd52..dbeb3a0f 100644
--- a/wp-includes/feed.php
+++ b/wp-includes/feed.php
@@ -7,6 +7,7 @@
*
* @package WordPress
* @subpackage Feed
+ * @since 2.1.0
*/
/**
@@ -25,7 +26,7 @@
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
*
@@ -52,7 +53,7 @@ function get_bloginfo_rss($show = '') {
*/
function bloginfo_rss($show = '') {
/**
- * Filter the bloginfo for display in RSS feeds.
+ * Filters the bloginfo for display in RSS feeds.
*
* @since 2.1.0
*
@@ -68,16 +69,15 @@ function bloginfo_rss($show = '') {
* 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
- * @uses apply_filters() Calls 'default_feed' hook on the default feed string.
*
* @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
*
@@ -92,46 +92,55 @@ function get_default_feed() {
* 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 = '»') {
- $title = wp_title($sep, false);
- if ( is_wp_error( $title ) )
- return $title->get_error_message();
+function get_wp_title_rss( $deprecated = '–' ) {
+ if ( '–' !== $deprecated ) {
+ /* translators: %s: 'document_title_separator' filter name */
+ _deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), 'document_title_separator
' ) );
+ }
+
/**
- * Filter the blog title for use as the feed title.
+ * Filters 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 = '»' ) {
+function wp_title_rss( $deprecated = '–' ) {
+ if ( '–' !== $deprecated ) {
+ /* translators: %s: 'document_title_separator' filter name */
+ _deprecated_argument( __FUNCTION__, '4.4.0', sprintf( __( 'Use the %s filter instead.' ), 'document_title_separator
' ) );
+ }
+
/**
- * Filter the blog title for display of the feed title.
+ * 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 $sep Separator used by wp_title().
+ * @param string $wp_title_rss The current blog 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 );
}
/**
@@ -143,8 +152,9 @@ function wp_title_rss( $sep = '»' ) {
*/
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
*
@@ -158,7 +168,6 @@ function get_the_title_rss() {
* Display the post title in the feed.
*
* @since 0.71
- * @uses get_the_title_rss() Used to retrieve current post title.
*/
function the_title_rss() {
echo get_the_title_rss();
@@ -177,11 +186,11 @@ function get_the_content_feed($feed_type = null) {
if ( !$feed_type )
$feed_type = get_default_feed();
- /** This filter is documented in wp-admin/post-template.php */
+ /** This filter is documented in wp-includes/post-template.php */
$content = apply_filters( 'the_content', get_the_content() );
$content = str_replace(']]>', ']]>', $content);
/**
- * Filter the post content for use in feeds.
+ * Filters the post content for use in feeds.
*
* @since 2.9.0
*
@@ -196,8 +205,6 @@ function get_the_content_feed($feed_type = null) {
* Display the post content for feeds.
*
* @since 2.9.0
- * @uses apply_filters() Calls 'the_content_feed' on the content before processing.
- * @see get_the_content()
*
* @param string $feed_type The type of feed. rss2 | atom | rss | rdf
*/
@@ -213,7 +220,7 @@ function the_content_feed($feed_type = null) {
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
*
@@ -229,7 +236,7 @@ function the_excerpt_rss() {
*/
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
*
@@ -246,7 +253,7 @@ function the_permalink_rss() {
*/
function comments_link_feed() {
/**
- * Filter the comments permalink for the current post.
+ * Filters the comments permalink for the current post.
*
* @since 3.6.0
*
@@ -261,7 +268,7 @@ function comments_link_feed() {
*
* @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) );
@@ -272,8 +279,8 @@ function comment_guid($comment_id = null) {
*
* @since 2.5.0
*
- * @param int|object $comment_id Optional comment object or id. Defaults to global comment object.
- * @return bool|string false on failure or guid for comment on success.
+ * @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);
@@ -288,10 +295,13 @@ function get_comment_guid($comment_id = null) {
* Display the link to the comments.
*
* @since 1.5.0
+ * @since 4.4.0 Introduced the `$comment` argument.
+ *
+ * @param int|WP_Comment $comment Optional. Comment object or id. Defaults to global comment object.
*/
-function comment_link() {
+function comment_link( $comment = null ) {
/**
- * Filter the current comment's permalink.
+ * Filters the current comment's permalink.
*
* @since 3.6.0
*
@@ -299,20 +309,19 @@ function 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.
*
* @since 2.0.0
- * @uses get_comment_author()
*
* @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
*
@@ -336,12 +345,11 @@ function comment_author_rss() {
* Display the current comment content for use in the feeds.
*
* @since 1.0.0
- * @uses get_comment_text()
*/
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
*
@@ -389,14 +397,13 @@ function get_the_category_rss($type = null) {
if ( 'rdf' == $type )
$the_list .= "\t\t