SimplePie 1.3.1 is now available. Upgrade now!

SimplePie Documentation.  Learn how to use this thing.  It's way better than going to school.

You are here: Documentation » API Reference

API Reference

:!: This documentation is for 1.2 only. 1.3 documentation can be found in the API Docs section of the site.

These are all of the public functions for SimplePie. Our goal is to not break any of these constructors and methods for all 1.x releases. If there are methods or constructors not mentioned here, or are marked “Non-Public”, then they are not considered public and may change tomorrow and the “no-breaking” rule does not apply to them. The next API breakage will be in SimplePie 2.0, but that's still quite a while off. :)

Documentation for the latest in-development build can be found in our automatically generated API documentation.

SimplePie

Constructor

  • SimplePie — construct a new SimplePie object.

Constants

Methods

Configuration (Required)

Configuration (Basic)

Configuration (Advanced)

Extending Classes (Advanced)

Processing

  • __destruct() – Used for avoiding memory leaks when processing lots of feeds.
  • error() — Return the error message for the occured error.
  • handle_content_type() — Sets the proper HTTP headers for the page, setting the character set to match the output encoding.
  • init() — Initialise the feed, parsing it, etc.

Feed-Level Data (Basic)

Feed-Level GeoData

Feed-Level Data Hacking (Advanced)

  • get_all_discovered_feeds() — Get all feeds discovered during the autodiscovery process.
  • get_base() – Get the xml:base value of a given element.
  • get_channel_tags() — Get the value of ANY tag in the “channel” section of the feed.
  • get_feed_tags() — Get the value of ANY tag in the “feed” section of the feed.
  • get_image_tags() — Get the value of ANY tag in the “image” section of the feed.
  • merge_items() — Merge the items of multiple feeds together.
  • sanitize() – Sanitizes data based on the type of data it is expected to be.
  • sort_items() – An over-ridable method that handles the sorting of items by some criteria.

One-Click Subscriptions

SimplePie_Item

Methods

Item-Level Data (Basic)

Item-Level GeoData

Item-Level Data Hacking (Advanced)

  • get_base() – Get the xml:base value of a given element.
  • get_item_tags() — Get the value of ANY tag in the item.
  • sanitize() – Sanitizes data based on the type of data it is expected to be.

Bookmarking

SimplePie_Author

Methods

Author-Level Data

SimplePie_Category

Methods

Category-Level Data

  • get_term() — Get the category's identifier.
  • get_scheme() — Get the category's categorization scheme identifier.
  • get_label() — Get the category's human-readable label.

SimplePie_Enclosure

Methods

Enclosure-Level Data

Extended Enclosure-Level Data (Media RSS, iTunes RSS)

Embedding

  • embed() — Automatically embed the enclosure in the page using JavaScript.
  • native_embed() — Automatically embed the enclosure in the page using the <embed> tag.

SimplePie_Caption

Methods

Caption-Level Data

SimplePie_Copyright

Methods

Copyright-Level Data

SimplePie_Credit

Methods

Credit-Level Data

SimplePie_Rating

Methods

Rating-Level Data

SimplePie_Restriction

Methods

Restriction-Level Data

SimplePie_Source

Methods

Most of these methods are identical to those of SimplePie and SimplePie_Item methods, so we're linking back to those docs.

Source-Level Data (Basic)

Source-Level GeoData

Source-Level Data Hacking (Advanced)

  • get_base() – Get the xml:base value of a given element.
  • get_source_tags() – Get the value of ANY tag in the source.
  • sanitize() – Sanitizes data based on the type of data it is expected to be.

SimplePie_Cache (Non-Public)

SimplePie_Cache_File (Non-Public)

SimplePie_Content_Type_Sniffer (Non-Public)

SimplePie_Decode_HTML_Entities (Non-Public)

SimplePie_File (Non-Public)

SimplePie_Locator (Non-Public)

SimplePie_HTTP_Parser (Non-Public)

SimplePie_Misc (Non-Public)

SimplePie_Parser (Non-Public)

SimplePie_Parse_Date (Non-Public)

SimplePie_Sanitize (Non-Public)

SimplePie_XML_Declaration_Parser (Non-Public)


reference/start.txt · Last modified: 2013/08/10 21:57 (external edit)