WPDev.one
Core Class
View Source on Trac ↗
Core Class

SimplePie

class SimplePie // Constructor: function Object() { [native code] }

SimplePie

Methods 100 methods

Method / Return Description
__construct()
void

The SimplePie class contains feed level data and options
__toString()
void

Used for converting object to a string
__destruct()
void

Remove items that link back to this before destroying this object
force_feed()
void

Force the given data/URL to be treated as a feed

Parameters: $enable: mixed
set_feed_url()
void

Set the URL of the feed you want to parse

Parameters: $url: mixed
set_file()
bool

Set an instance of {@see \SimplePie\File} to use as a feed

Parameters: $file: mixed
set_raw_data()
void

Set the raw XML data to parse

Parameters: $data: mixed
set_timeout()
void

Set the default timeout for fetching remote feeds

Parameters: $timeout: mixed
set_curl_options()
void

Set custom curl options

Parameters: $curl_options: array
force_fsockopen()
void

Force SimplePie to use fsockopen() instead of cURL

Parameters: $enable: mixed
enable_cache()
void

Enable/disable caching in SimplePie.

Parameters: $enable: mixed
set_cache()
void

Set a PSR-16 implementation as cache

Parameters: $cache: CacheInterface
force_cache_fallback()
void

SimplePie to continue to fall back to expired cache, if enabled, when

Parameters: $enable: mixed
set_cache_duration()
void

Set the length of time (in seconds) that the contents of a feed will be

Parameters: $seconds: mixed
set_autodiscovery_cache_duration()
void

Set the length of time (in seconds) that the autodiscovered feed URL will

Parameters: $seconds: mixed
set_cache_location()
void

Set the file system location where the cached files should be stored

Parameters: $location: mixed
get_cache_filename()
string

Return the filename (i.e. hash, without path and without extension) of the file to cache a given URL.

Parameters: $url: mixed
enable_order_by_date()
void

Set whether feed items should be sorted into reverse chronological order

Parameters: $enable: mixed
set_input_encoding()
void

Set the character encoding used to parse the feed

Parameters: $encoding: mixed
set_autodiscovery_level()
void

Set how much feed autodiscovery to do

Parameters: $level: mixed
get_registry()
Registry

Get the class registry
set_cache_class()
boolean

Set which class SimplePie uses for caching

Parameters: $class: mixed
set_locator_class()
boolean

Set which class SimplePie uses for auto-discovery

Parameters: $class: mixed
set_parser_class()
boolean

Set which class SimplePie uses for XML parsing

Parameters: $class: mixed
set_file_class()
boolean

Set which class SimplePie uses for remote file fetching

Parameters: $class: mixed
set_sanitize_class()
boolean

Set which class SimplePie uses for data sanitization

Parameters: $class: mixed
set_item_class()
boolean

Set which class SimplePie uses for handling feed items

Parameters: $class: mixed
set_author_class()
boolean

Set which class SimplePie uses for handling author data

Parameters: $class: mixed
set_category_class()
boolean

Set which class SimplePie uses for handling category data

Parameters: $class: mixed
set_enclosure_class()
boolean

Set which class SimplePie uses for feed enclosures

Parameters: $class: mixed
set_caption_class()
boolean

Set which class SimplePie uses for `<media:text>` captions

Parameters: $class: mixed
set_copyright_class()
boolean

Set which class SimplePie uses for `<media:copyright>`

Parameters: $class: mixed
set_credit_class()
boolean

Set which class SimplePie uses for `<media:credit>`

Parameters: $class: mixed
set_rating_class()
boolean

Set which class SimplePie uses for `<media:rating>`

Parameters: $class: mixed
set_restriction_class()
boolean

Set which class SimplePie uses for `<media:restriction>`

Parameters: $class: mixed
set_content_type_sniffer_class()
boolean

Set which class SimplePie uses for content-type sniffing

Parameters: $class: mixed
set_source_class()
boolean

Set which class SimplePie uses item sources

Parameters: $class: mixed
set_useragent()
void

Set the user agent string

Parameters: $ua: mixed
set_cache_namefilter()
void

Set a namefilter to modify the cache filename with

Parameters: $filter: NameFilter
set_cache_name_function()
void

Set callback function to create cache filename with

Parameters: $function: mixed
set_stupidly_fast()
void

Set options to make SP as fast as possible

Parameters: $set: mixed
set_max_checked_feeds()
void

Set maximum number of feeds to check with autodiscovery

Parameters: $max: mixed
remove_div()
void

No description available.

Parameters: $enable: mixed
strip_htmltags()
void

No description available.

Parameters: $tags: mixed, $encode: mixed
encode_instead_of_strip()
void

No description available.

Parameters: $enable: mixed
rename_attributes()
void

No description available.

Parameters: $attribs: mixed
strip_attributes()
void

No description available.

Parameters: $attribs: mixed
add_attributes()
void

No description available.

Parameters: $attribs: mixed
set_output_encoding()
void

Set the output encoding

Parameters: $encoding: mixed
strip_comments()
void

No description available.

Parameters: $strip: mixed
set_url_replacements()
void

Set element/attribute key/value pairs of HTML attributes

Parameters: $element_attribute: mixed
set_https_domains()
void

Set the list of domains for which to force HTTPS.

Parameters: $domains: mixed
set_image_handler()
void

Set the handler to enable the display of cached images.

Parameters: $page: mixed, $qs: mixed
set_item_limit()
void

Set the limit for items returned per-feed with multifeeds

Parameters: $limit: mixed
enable_exceptions()
void

Enable throwing exceptions

Parameters: $enable: mixed
init()
boolean

Initialize the feed object
fetch_data()
(array

Fetch the data via \SimplePie\File

Parameters: $cache: mixed
error()
(string

Get the error message for the occurred error
status_code()
int

Get the last HTTP status code
get_raw_data()
(string

Get the raw XML
get_encoding()
string

Get the character encoding used for output
handle_content_type()
void

Send the content-type header with correct encoding

Parameters: $mime: mixed
get_type()
int

Get the type of the feed
subscribe_url()
(string

Get the URL for the feed

Parameters: $permanent: mixed
get_feed_tags()
array

Get data for an feed-level element

Parameters: $namespace: mixed, $tag: mixed
get_channel_tags()
array

Get data for an channel-level element

Parameters: $namespace: mixed, $tag: mixed
get_image_tags()
array

Get data for an channel-level element

Parameters: $namespace: mixed, $tag: mixed
get_base()
string

Get the base URL value from the feed

Parameters: $element: mixed
sanitize()
string

Sanitize feed data

Parameters: $data: mixed, $type: mixed, $base: mixed
get_title()
(string

Get the title of the feed
get_category()
(\SimplePie\Category

Get a category for the feed

Parameters: $key: mixed
get_categories()
(array

Get all categories for the feed
get_author()
(\SimplePie\Author

Get an author for the feed

Parameters: $key: mixed
get_authors()
(array

Get all authors for the feed
get_contributor()
(\SimplePie\Author

Get a contributor for the feed

Parameters: $key: mixed
get_contributors()
(array

Get all contributors for the feed
get_link()
(string

Get a single link for the feed

Parameters: $key: mixed, $rel: mixed
get_permalink()
(string

Get the permalink for the item
get_links()
(array

Get all links for the feed

Parameters: $rel: mixed
get_all_discovered_feeds()
void

No description available.
get_description()
(string

Get the content for the item
get_copyright()
(string

Get the copyright info for the feed
get_language()
(string

Get the language for the feed
get_latitude()
(string

Get the latitude coordinates for the item
get_longitude()
(string

Get the longitude coordinates for the feed
get_image_title()
(string

Get the feed logo's title
get_image_url()
(string

Get the feed logo's URL
get_image_link()
(string

Get the feed logo's link
get_image_width()
(int

Get the feed logo's link
get_image_height()
(int

Get the feed logo's height
get_item_quantity()
int

Get the number of items in the feed

Parameters: $max: mixed
get_item()
(\SimplePie\Item

Get a single item from the feed

Parameters: $key: mixed
get_items()
(\SimplePie\Item[]

Get all items from the feed

Parameters: $start: mixed, $end: mixed
set_favicon_handler()
void

Set the favicon handler

Parameters: $page: mixed, $qs: mixed
get_favicon()
void

Get the favicon for the current feed
__call()
mixed

Magic method handler

Parameters: $method: mixed, $args: mixed
sort_items()
boolean

Sorting callback for items

Parameters: $a: mixed, $b: mixed
merge_items()
array

Merge items from several feeds into one

Parameters: $urls: mixed, $start: mixed, $end: mixed, $limit: mixed
store_links()
void

Store PubSubHubbub links as headers

Parameters: $file: mixed, $hub: mixed, $self: mixed
get_cache()
DataCache

Get a DataCache

Parameters: $feed_url: mixed

Properties

Property / Type Description
$data
mixed
public
 No description available.
$error
mixed
public
 No description available.
$status_code
mixed
public
 No description available.
$sanitize
mixed
public
 No description available.
$useragent
mixed
public
 No description available.
$feed_url
mixed
public
 No description available.
$permanent_url
mixed
public
 No description available.
$file
mixed
public
 No description available.
$raw_data
mixed
public
 No description available.
$timeout
mixed
public
 No description available.
$curl_options
mixed
public
 No description available.
$force_fsockopen
mixed
public
 No description available.
$force_feed
mixed
public
 No description available.
$enable_cache
mixed
public
 No description available.
$cache
mixed
public
 No description available.
$cache_namefilter
mixed
public
 No description available.
$force_cache_fallback
mixed
public
 No description available.
$cache_duration
mixed
public
 No description available.
$autodiscovery_cache_duration
mixed
public
 No description available.
$cache_location
mixed
public
 No description available.
$cache_name_function
mixed
public
 No description available.
$order_by_date
mixed
public
 No description available.
$input_encoding
mixed
public
 No description available.
$autodiscovery
mixed
public
 No description available.
$registry
mixed
public
 No description available.
$max_checked_feeds
mixed
public
 No description available.
$all_discovered_feeds
mixed
public
 No description available.
$image_handler
mixed
public
 No description available.
$multifeed_url
mixed
public
 No description available.
$multifeed_objects
mixed
public
 No description available.
$config_settings
mixed
public
 No description available.
$item_limit
mixed
public
 No description available.
$check_modified
mixed
public
 No description available.
$strip_attributes
mixed
public
 No description available.
$add_attributes
mixed
public
 No description available.
$strip_htmltags
mixed
public
 No description available.
$rename_attributes
mixed
public
 No description available.
$enable_exceptions
mixed
public
 No description available.

Class Information

Source File
wp-includes/SimplePie/src/SimplePie.php
Advertisement