X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/53f4633144ed68c8b8fb5861f992b5489894a940..607b7e02d77e7326161e8ec15639052d2040f745:/wp-includes/feed.php
diff --git a/wp-includes/feed.php b/wp-includes/feed.php
index f40f41a6..f673e91d 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,7 +69,7 @@ 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
*
@@ -76,7 +77,7 @@ function bloginfo_rss($show = '') {
*/
function get_default_feed() {
/**
- * Filter the default feed type.
+ * Filters the default feed type.
*
* @since 2.5.0
*
@@ -91,53 +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();
- }
-
- if ( $title && $sep && ' ' !== substr( $title, 0, 1 ) ) {
- $title = " $sep " . $title;
+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 );
}
/**
@@ -149,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
*
@@ -186,7 +190,7 @@ function get_the_content_feed($feed_type = null) {
$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
*
@@ -216,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
*
@@ -232,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
*
@@ -249,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
*
@@ -264,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) );
@@ -275,7 +279,7 @@ 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.
+ * @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) {
@@ -291,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
*
@@ -302,7 +309,7 @@ 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 ) ) );
}
/**
@@ -314,7 +321,7 @@ function comment_link() {
*/
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
*
@@ -342,7 +349,7 @@ function comment_author_rss() {
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
*
@@ -396,7 +403,7 @@ function get_the_category_rss($type = null) {
}
/**
- * 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
*
@@ -463,7 +470,7 @@ function rss_enclosure() {
$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
*
@@ -497,7 +504,7 @@ function atom_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
*
@@ -600,7 +607,7 @@ function rss2_site_icon() {
function self_link() {
$host = @parse_url(home_url());
/**
- * Filter the current feed URL.
+ * Filters the current feed URL.
*
* @since 3.6.0
*
@@ -616,29 +623,30 @@ function self_link() {
* 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',
- 'rss2' => 'application/rss+xml',
- 'rss-http' => 'text/xml',
- 'atom' => 'application/atom+xml',
- 'rdf' => 'application/rdf+xml'
+ '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.
+ * 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'.
- * Default 'rss2'.
+ * @param string $type Type of feed. Possible values include 'rss', rss2', 'atom', and 'rdf'.
*/
return apply_filters( 'feed_content_type', $content_type, $type );
}