SimplePie

Properties · 40

$dataSimplePie\array<string,public

$errorstring|string[]|nullpublic

$status_codeintpublic

$sanitizeSimplePie\Sanitizepublic

$useragentstringpublic

$feed_urlstringpublic

$permanent_urlSimplePie\?stringpublic

$fileSimplePie\Fileprivate

$raw_datastring|falsepublic

$timeoutintpublic

$curl_optionsSimplePie\array<int,public

$force_fsockopenboolpublic

$force_feedboolpublic

$enable_cacheboolprivate

$cacheSimplePie\Cache\DataCache|nullprivate

$cache_namefilterSimplePie\Cache\NameFilterprivate

$force_cache_fallbackboolpublic

$cache_durationintpublic

$autodiscovery_cache_durationintpublic

$cache_locationstringpublic

$cache_name_functionSimplePie\string&(callable(string):public

$order_by_dateboolpublic

$input_encodingmixedpublic

$autodiscoverySimplePie\self::LOCATOR_*public

$registrySimplePie\Registrypublic

Class registry object

$max_checked_feedsintpublic

$all_discovered_feedsSimplePie\array<Response>|nullpublic

$image_handlerstringpublic

$multifeed_urlSimplePie\array<string>public

$multifeed_objectsSimplePie\array<int,public

$config_settingsSimplePie\array<mixed>public

$item_limitintpublic

$check_modifiedboolpublic

$strip_attributesSimplePie\array<string>public

$add_attributesSimplePie\array<string,public

$strip_htmltagsSimplePie\array<string>public

$rename_attributesstring[]|stringpublic

$enable_exceptionsboolpublic

$http_clientSimplePie\HTTP\Client|nullprivate

$http_client_injectedboolprivate

Methods · 103

• __construct()The SimplePie class contains feed level data and options
• __toString()Used for converting object to a string
• __destruct()Remove items that link back to this before destroying this object
• force_feed()Force the given data/URL to be treated as a feed
• set_feed_url()Set the URL of the feed you want to parse
• set_file()Set an instance of {@see File} to use as a feed
• set_raw_data()Set the raw XML data to parse
• set_http_client()Set a PSR-18 client and PSR-17 factories
• set_timeout()Set the default timeout for fetching remote feeds
• set_curl_options()Set custom curl options
• force_fsockopen()Force SimplePie to use fsockopen() instead of cURL
• enable_cache()Enable/disable caching in SimplePie.
• set_cache()Set a PSR-16 implementation as cache
• force_cache_fallback()SimplePie to continue to fall back to expired cache, if enabled, when feed is unavailable.
• set_cache_duration()Set the length of time (in seconds) that the contents of a feed will be cached
• set_autodiscovery_cache_duration()Set the length of time (in seconds) that the autodiscovered feed URL will be cached
• set_cache_location()Set the file system location where the cached files should be stored
• get_cache_filename()Return the filename (i.e. hash, without path and without extension) of the file to cache a given URL.
• enable_order_by_date()Set whether feed items should be sorted into reverse chronological order
• set_input_encoding()Set the character encoding used to parse the feed
• set_autodiscovery_level()Set how much feed autodiscovery to do
• get_registry()Get the class registry
• set_cache_class()Set which class SimplePie uses for caching
• set_locator_class()Set which class SimplePie uses for auto-discovery
• set_parser_class()Set which class SimplePie uses for XML parsing
• set_file_class()Set which class SimplePie uses for remote file fetching
• set_sanitize_class()Set which class SimplePie uses for data sanitization
• set_item_class()Set which class SimplePie uses for handling feed items
• set_author_class()Set which class SimplePie uses for handling author data
• set_category_class()Set which class SimplePie uses for handling category data
• set_enclosure_class()Set which class SimplePie uses for feed enclosures
• set_caption_class()Set which class SimplePie uses for `` captions
• set_copyright_class()Set which class SimplePie uses for ``
• set_credit_class()Set which class SimplePie uses for ``
• set_rating_class()Set which class SimplePie uses for ``
• set_restriction_class()Set which class SimplePie uses for ``
• set_content_type_sniffer_class()Set which class SimplePie uses for content-type sniffing
• set_source_class()Set which class SimplePie uses item sources
• set_useragent()Set the user agent string
• set_cache_namefilter()Set a namefilter to modify the cache filename with
• set_cache_name_function()Set callback function to create cache filename with
• set_stupidly_fast()Set options to make SP as fast as possible
• set_max_checked_feeds()Set maximum number of feeds to check with autodiscovery
• remove_div()
• strip_htmltags()
• encode_instead_of_strip()
• rename_attributes()
• strip_attributes()
• add_attributes()
• set_output_encoding()Set the output encoding
• strip_comments()
• set_url_replacements()Set element/attribute key/value pairs of HTML attributes containing URLs that need to be resolved relative to the feed
• set_https_domains()Set the list of domains for which to force HTTPS.
• set_image_handler()Set the handler to enable the display of cached images.
• set_item_limit()Set the limit for items returned per-feed with multifeeds
• enable_exceptions()Enable throwing exceptions
• init()Initialize the feed object
• fetch_data()Fetch the data
• error()Get the error message for the occurred error
• status_code()Get the last HTTP status code
• get_raw_data()Get the raw XML
• get_encoding()Get the character encoding used for output
• handle_content_type()Send the content-type header with correct encoding
• get_type()Get the type of the feed
• subscribe_url()Get the URL for the feed
• get_feed_tags()Get data for an feed-level element
• get_channel_tags()Get data for an channel-level element
• get_image_tags()Get data for an channel-level element
• get_base()Get the base URL value from the feed
• sanitize()Sanitize feed data
• get_title()Get the title of the feed
• get_category()Get a category for the feed
• get_categories()Get all categories for the feed
• get_author()Get an author for the feed
• get_authors()Get all authors for the feed
• get_contributor()Get a contributor for the feed
• get_contributors()Get all contributors for the feed
• get_link()Get a single link for the feed
• get_permalink()Get the permalink for the item
• get_links()Get all links for the feed
• get_all_discovered_feeds()
• get_description()Get the content for the item
• get_copyright()Get the copyright info for the feed
• get_language()Get the language for the feed
• get_latitude()Get the latitude coordinates for the item
• get_longitude()Get the longitude coordinates for the feed
• get_image_title()Get the feed logo's title
• get_image_url()Get the feed logo's URL
• get_image_link()Get the feed logo's link
• get_image_width()Get the feed logo's link
• get_image_height()Get the feed logo's height
• get_item_quantity()Get the number of items in the feed
• get_item()Get a single item from the feed
• get_items()Get all items from the feed
• set_favicon_handler()Set the favicon handler
• get_favicon()Get the favicon for the current feed
• __call()Magic method handler
• make_item()Item factory
• sort_items()Sorting callback for items
• merge_items()Merge items from several feeds into one
• store_links()Store PubSubHubbub links as headers
• get_cache()Get a DataCache
• get_http_client()Get a HTTP client

Source

View on Trac ↗View on GitHub ↗

32class SimplePie33{34    /**35     * SimplePie Name36     */37    public const NAME = 'SimplePie';38 39    /**40     * SimplePie Version41     */42    public const VERSION = '1.9.0';43 44    /**45     * SimplePie Website URL46     */47    public const URL = 'http://simplepie.org';48 49    /**50     * SimplePie Linkback51     */52    public const LINKBACK = '<a href="' . self::URL . '" title="' . self::NAME . ' ' . self::VERSION . '">' . self::NAME . '</a>';53 54    /**55     * No Autodiscovery56     * @see SimplePie::set_autodiscovery_level()57     */58    public const LOCATOR_NONE = 0;59 60    /**61     * Feed Link Element Autodiscovery62     * @see SimplePie::set_autodiscovery_level()63     */64    public const LOCATOR_AUTODISCOVERY = 1;65 66    /**67     * Local Feed Extension Autodiscovery68     * @see SimplePie::set_autodiscovery_level()69     */70    public const LOCATOR_LOCAL_EXTENSION = 2;71 72    /**73     * Local Feed Body Autodiscovery74     * @see SimplePie::set_autodiscovery_level()75     */76    public const LOCATOR_LOCAL_BODY = 4;77 78    /**79     * Remote Feed Extension Autodiscovery80     * @see SimplePie::set_autodiscovery_level()81     */82    public const LOCATOR_REMOTE_EXTENSION = 8;83 84    /**85     * Remote Feed Body Autodiscovery86     * @see SimplePie::set_autodiscovery_level()87     */88    public const LOCATOR_REMOTE_BODY = 16;89 90    /**91     * All Feed Autodiscovery92     * @see SimplePie::set_autodiscovery_level()93     */94    public const LOCATOR_ALL = 31;95 96    /**97     * No known feed type98     */99    public const TYPE_NONE = 0;100 101    /**102     * RSS 0.90103     */104    public const TYPE_RSS_090 = 1;105 106    /**107     * RSS 0.91 (Netscape)108     */109    public const TYPE_RSS_091_NETSCAPE = 2;110 111    /**

History

3 changes between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/SimplePie/src/SimplePie.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.