fetch_feed( mixed $url )

Build SimplePie object based on RSS or Atom feed from URL.

Contents

Description Description

Parameters Parameters

$url

(mixed) (Required) URL of feed to retrieve. If an array of URLs, the feeds are merged using SimplePie's multifeed feature. See also http://simplepie.org/wiki/faq/typical_multifeed_gotchas

Top ↑

Return Return

(WP_Error|SimplePie) WP_Error object on failure or SimplePie object on success

Top ↑

Source Source

File: wp-includes/feed.php

684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
function fetch_feed( $url ) {
    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
    // 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-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 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' ) );
 
    if ( $feed->error() ) {
        return new WP_Error( 'simplepie-error', $feed->error() );
    }
 
    return $feed;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.8.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/class-wp-feed-cache-transient.php: wp_feed_cache_transient_lifetime

Filters the transient lifetime of the feed cache.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/plugin.php: do_action_ref_array()

Execute functions hooked on a specific action hook, specifying arguments in an array.
wp-includes/feed.php: wp_feed_options

Fires just before processing the SimplePie feed object.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/class-wp-error.php: WP_Error::__construct()

Initialize the error.
Show 1 more use Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-admin/includes/deprecated.php: wp_dashboard_plugins_output()

Display plugins text for the WordPress news widget.
wp-admin/includes/dashboard.php: wp_dashboard_rss_control()

The RSS dashboard widget control.
wp-includes/widgets/class-wp-widget-rss.php: WP_Widget_RSS::widget()

Outputs the content for the current RSS widget instance.
wp-includes/widgets.php: wp_widget_rss_output()

Display the RSS entries in a list.
wp-includes/widgets.php: wp_widget_rss_process()

Process RSS feed widget data and optionally retrieve feed items.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Example
    This example will retrieve and display a list of links for an existing RSS feed, limiting the selection to the five most recent items:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    <h2><?php _e( 'Recent news from Some-Other Blog:', 'wpdocs_textdomain' ); ?></h2>
     
    <?php // Get RSS Feed(s)
    include_once( ABSPATH . WPINC . '/feed.php' );
     
    // Get a SimplePie feed object from the specified feed source.
    $rss = fetch_feed( 'http://example.com/rss/feed/goes/here' );
     
    $maxitems = 0;
     
    if ( ! is_wp_error( $rss ) ) : // Checks that the object is created correctly
     
        // Figure out how many total items there are, but limit it to 5.
        $maxitems = $rss->get_item_quantity( 5 );
     
        // Build an array of all the items, starting with element 0 (first element).
        $rss_items = $rss->get_items( 0, $maxitems );
     
    endif;
    ?>
     
    <ul>
        <?php if ( $maxitems == 0 ) : ?>
            <li><?php _e( 'No items', 'wpdocs_textdomain' ); ?></li>
        <?php else : ?>
            <?php // Loop through each feed item and display each item as a hyperlink. ?>
            <?php foreach ( $rss_items as $item ) : ?>
                <li>
                    <a href="<?php echo esc_url( $item->get_permalink() ); ?>"
                        title="<?php printf( __( 'Posted %s', 'wpdocs_textdomain' ), $item->get_date('j F Y | g:i a') ); ?>">
                        <?php echo esc_html( $item->get_title() ); ?>
                    </a>
                </li>
            <?php endforeach; ?>
        <?php endif; ?>
    </ul>

    Expand full source codeCollapse full source code

You must log in before being able to contribute a note or feedback.