CINXE.COM

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> <head> <title>SimplePie Documentation: Documentation</title> <meta name="generator" content="DokuWiki Release 2006-11-06" /> <meta name="date" content="2007-06-18T00:42:23-0700" /> <meta name="keywords" content="reference,start" /> <link rel="start" href="/wiki/" /> <link rel="contents" href="/wiki/reference/start?do=index" title="Index" /> <link rel="alternate" type="application/rss+xml" title="Recent Changes" href="/wiki/feed.php" /> <link rel="alternate" type="application/rss+xml" title="Current Namespace" href="/wiki/feed.php?mode=list&ns=reference" /> <link rel="alternate" type="text/html" title="Plain HTML" href="/wiki/_export/xhtml/reference/start" /> <link rel="alternate" type="text/plain" title="Wiki Markup" href="/wiki/_export/raw/reference/start" /> <link rel="stylesheet" href="/wiki/lib/tpl/simplepie/wikistyles.css" type="text/css" media="screen"> <link rel="stylesheet" href="/css/sIFR-screen.css" type="text/css" media="screen"> <link rel="stylesheet" href="/css/sIFR-print.css" type="text/css" media="print"> <link rel="stylesheet" media="screen" type="text/css" href="/wiki/lib/exe/css.php" /> <link rel="stylesheet" media="print" type="text/css" href="/wiki/lib/exe/css.php?print=1" />  <link rel="alternate" type="application/rss+xml" title="RSS 2.0" href="http://feeds.feedburner.com/simplepie" />  <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <meta http-equiv="content-language" content="en-us" /> <meta http-equiv="imagetoolbar" content="false" />  <meta name="MSSmartTagsPreventParsing" content="true" /> <meta name="ROBOTS" content="ALL" /> <meta name="copyright" content="2004-2025 Ryan Parman, Geoffrey Sneddon" /> <meta name="description" content="A super-fast, easy-to-use, RSS and Atom parser written in PHP." /> <meta name="author" content="SimplePie.org" /> <meta name="rating" content="General" /> <meta name="revisit-after" content="2 Days" /> <meta name="doc-class" content="Living Document" /> <meta name="y_key" content="8a13570546b4e5cd" />  <link rel="shortcut icon" type="image/ico" href="/favicon.ico" />  <link rel="stylesheet" href="/css/simplepie.css" media="screen, projector" />  <script type="text/javascript" src="/mint/?js"></script> <script type="text/javascript" src="/scripts/sleight.js"></script> <script type="text/javascript" src="http://www.google-analytics.com/urchin.js"></script> <script type="text/javascript" src="/scripts/sifr.js"></script> <script type="text/javascript" src="/scripts/sifr-config.js"></script> </head> <body id="bodydocs"> <div class="announcement"><a href="https://github.com/simplepie/simplepie/releases/tag/1.5">SimplePie 1.5 is now available!</a></div> <div id="header"> <div id="headerInner"> <div id="logoContainer"> <div id="logoContainerInner"> <div id="logo"><a href="/"><img src="/images/logo_simplepie_horizontal.png" alt="SimplePie: PHP-based RSS and Atom feed handling" title="SimplePie: PHP-based RSS and Atom feed handling" border="0" /></a></div> <div id="feed"><form action="http://www.google.com/search" method="get"><input type="text" name="q" id="q" value="" class="text" /><input type="hidden" name="as_sitesearch" value="simplepie.org" /> <input type="submit" value="Search" class="button" /></form></div> <div class="clearLeft"></div> </div> </div> <div id="menu"> <table cellpadding="0" cellspacing="0" border="0"><tbody><tr><td> <ul><li id="overview"><a href="/">Overview</a></li><li id="demo"><a href="/demo/">Demo</a></li><li id="blog"><a href="/blog/">Blog</a></li><li id="downloads"><a href="/downloads/">Download</a></li><li id="docs"><a href="/wiki/">Documentation</a></li><li id="api"><a href="/api/">API Docs</a></li><li id="support"><a href="/support/">Support</a></li><li id="bugs"><a href="http://github.com/simplepie/simplepie/issues">Issue Tracker</a></li><li id="faq"><a href="/wiki/faq/start">FAQ</a></li></ul> <div class="clearLeft"></div> </td></tr></tbody></table> </div> </div> </div> <div id="site"> <div id="content"> <div class="chunk"> <h2 class="image"><img src="/images/copy_simplepie_documentation.gif" alt="SimplePie Documentation. Learn how to use this thing. It's way better than going to school." title="SimplePie Documentation. Learn how to use this thing. It's way better than going to school." /></h2> </div> <div class="chunk focus" id="controls"> <div class="buttons"> <form class="button btn_source" method="post" action="/wiki/start"><div class="no"><input type="hidden" name="do" value="edit" /><input type="hidden" name="rev" value="" /><input type="submit" value="Show pagesource" class="button" accesskey="v" title="Show pagesource [V]" /></div></form> <form class="button btn_revs" method="get" action="/wiki/start"><div class="no"><input type="hidden" name="do" value="revisions" /><input type="submit" value="Old revisions" class="button" accesskey="o" title="Old revisions [O]" /></div></form> <form class="button btn_recent" method="get" action="/wiki/start"><div class="no"><input type="hidden" name="do" value="recent" /><input type="submit" value="Recent changes" class="button" accesskey="r" title="Recent changes [R]" /></div></form> <form class="button btn_login" method="get" action="/wiki/start"><div class="no"><input type="hidden" name="do" value="login" /><input type="hidden" name="sectok" value="3b3df8ece7f8f60863d2d0913b361ac6" /><input type="submit" value="Login" class="button" title="Login" /></div></form> </div> <div class="search"> <form action="/wiki/" accept-charset="utf-8" class="search" id="dw__search" method="get"><div class="no"><input type="hidden" name="do" value="search" /><input type="text" id="qsearch__in" accesskey="f" name="id" class="edit" title="[F]" /><input type="submit" value="Search" class="button" title="Search" /><div id="qsearch__out" class="ajax_qsearch JSpopup"></div></div></form> </div> <div class="clearRight"></div> </div> <p class="footnote"><span class="bchead">You are here: </span><a href="/wiki/start" title="start">Documentation</a></p> <div class="chunk">  <div class="toc"> <div class="tocheader toctoggle" id="toc__header">Table of Contents</div> <div id="toc__inside"> <ul class="toc"> <li class="level1"><div class="li"><span class="li"><a href="#documentation" class="toc">Documentation</a></span></div> <ul class="toc"> <li class="level2"><div class="li"><span class="li"><a href="#frequently_asked_questions" class="toc">Frequently Asked Questions</a></span></div></li> <li class="level2"><div class="li"><span class="li"><a href="#setup" class="toc">Setup</a></span></div></li> <li class="level2"><div class="li"><span class="li"><a href="#usage" class="toc">Usage</a></span></div></li> <li class="level2"><div class="li"><span class="li"><a href="#enhancements" class="toc">Enhancements</a></span></div></li> <li class="level2"><div class="li"><span class="li"><a href="#miscellaneous" class="toc">Miscellaneous</a></span></div></li> <li class="level2"><div class="li"><span class="li"><a href="#simplepie_live_documentation" class="toc">SimplePie Live! Documentation</a></span></div></li></ul> </li></ul> </div> </div>  <h1 class="sectionedit1"><a name="documentation" id="documentation">Documentation</a></h1> <div class="level1"> <p> We've seen far too many open-source projects have really poor documentation, if any at all. We don't want to be like that. Our goal is to provide you with everything you need to install, upgrade, get started with, and really push SimplePie to its limits. </p> <p> Besides documenting each and every single public function, we've also put together guides for various things to help you along. We decided to move everything into a wiki so that people can add their own notes, clarifications, and other helpful hints to the docs. Feel free to add your own tutorials and such, but please follow existing uses of wiki links and the <a href="http://simplepie.org/api/" class="urlextern" title="http://simplepie.org/api/" rel="nofollow">API documentation</a>. </p> <p> <img src="/wiki/lib/images/smileys/icon_exclaim.gif" class="middle" alt=":!:" /> <strong>You can look up a specific class or method by going to <a href="http://simplepie.org/api/" class="urlextern" title="http://simplepie.org/api/" rel="nofollow">http://simplepie.org/api/</a>[class name]</strong> which is just like how you can look up <acronym title="Hypertext Preprocessor">PHP</acronym> functions by going to <a href="http://php.net/" class="urlextern" title="http://php.net/" rel="nofollow">http://php.net/</a>[function name]. </p> <p> Ready to learn? You can begin by clicking on one of the documentation links below. </p> </div> <h2 class="sectionedit2"><a name="frequently_asked_questions" id="frequently_asked_questions">Frequently Asked Questions</a></h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <strong><a href="/wiki/faq/start" class="wikilink1" title="faq:start">Frequently Asked Questions</a></strong></div> </li> <li class="level1"><div class="li"> <a href="/wiki/faq/typical_multifeed_gotchas" class="wikilink1" title="faq:typical_multifeed_gotchas">Typical Multifeed Gotchas</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/faq/problematic_feeds" class="wikilink1" title="faq:problematic_feeds">Known Problematic Feeds</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/faq/i_m_getting_memory_leaks" class="wikilink1" title="faq:i_m_getting_memory_leaks">I'm getting memory leaks!</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/faq/how_does_simplepie_s_caching_http_conditional_get_system_work" class="wikilink1" title="faq:how_does_simplepie_s_caching_http_conditional_get_system_work">How does SimplePie's caching system work?</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/faq/file_permissions" class="wikilink1" title="faq:file_permissions">How do I change the file permissions for the cache directory to be server-writable?</a></div> </li> </ul> </div> <h2 class="sectionedit3"><a name="setup" id="setup">Setup</a></h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="/wiki/setup/start" class="wikilink1" title="setup:start">Requirements and Getting Started</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/setup/sample_page" class="wikilink1" title="setup:sample_page">Create a sample SimplePie-enabled page</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/setup/upgrade" class="wikilink1" title="setup:upgrade">Upgrading from Beta 2, 3, 3.1, or 3.2</a></div> </li> </ul> </div> <h2 class="sectionedit4"><a name="usage" id="usage">Usage</a></h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="http://simplepie.org/api/" class="urlextern" title="http://simplepie.org/api/" rel="nofollow">API Documentation for 1.3</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/1.3/start" class="wikilink1" title="1.3:start">Other Documentation for 1.3</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/reference/start" class="wikilink1" title="reference:start">API Documentation for 1.2</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/tutorial/start" class="wikilink1" title="tutorial:start">Tips, Tricks, Tutorials, and Screencasts</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/ideas/start" class="wikilink1" title="ideas:start">Sites that have integrated SimplePie</a></div> </li> </ul> </div> <h2 class="sectionedit5"><a name="enhancements" id="enhancements">Enhancements</a></h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="/wiki/plugins/start" class="wikilink1" title="plugins:start">SimplePie Plugins and Integration</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/addons/start" class="wikilink1" title="addons:start">SimplePie Add-ons</a></div> </li> </ul> </div> <h2 class="sectionedit6"><a name="miscellaneous" id="miscellaneous">Miscellaneous</a></h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="/wiki/misc/coding_standards" class="wikilink1" title="misc:coding_standards">Coding Standards</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/misc/release_notes/start" class="wikilink1" title="misc:release_notes:start">Release Notes</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/misc/credits" class="wikilink1" title="misc:credits">SimplePie Credits</a></div> </li> <li class="level1"><div class="li"> <a href="/wiki/misc/in_the_media" class="wikilink1" title="misc:in_the_media">SimplePie in the Media</a></div> </li> </ul> </div> <h2 class="sectionedit7"><a name="simplepie_live_documentation" id="simplepie_live_documentation">SimplePie Live! Documentation</a></h2> <div class="level2"> <ul> <li class="level1"><div class="li"> <a href="/wiki/live/start" class="wikilink1" title="live:start">SimplePie Live!</a></div> </li> </ul> </div> <div class="clearRight"></div> <div align="right"><br /><span class="footnote"> start.txt · Last modified: 2013/08/11 04:43 (external edit)</span></div> </div> <div id="footer"> <p class="highlight" style="background-color:#ffc; border-bottom:1px solid #ccc;"><strong>Show some love!</strong> Wishlists for <a href="http://www.amazon.co.uk/gp/registry/wishlist/2ASV4RHBSM16H/026-9090951-0551667">Geoffrey</a>, <a href="http://www.amazon.com/gp/registry/wishlist/KAFYR57E8R81/">Ryan P.</a>, and <a href="http://www.amazon.com/gp/registry/wishlist/2P9RS76SG0UHL/">Ryan M.</a></p> <p class="footnote">SimplePie is © 2004–2025 <a href="http://ryanparman.com">Ryan Parman</a>, <a href="http://gsnedders.com/">Geoffrey Sneddon</a>, <a href="http://ryanmccue.info/">Ryan McCue</a> and contributors. Licensed under the <a href="http://www.opensource.org/licenses/bsd-license.php">BSD License</a>. Hosted thanks to <a href="http://ma.tt/">Matt Mullenweg</a>, powered by <a href="http://wordpress.org">WordPress</a> and <a href="http://php.net">PHP 5.6.40</a>, and managed with <a href="http://basecamphq.com/?referrer=skyzyx">Basecamp</a>. Syndication handled by <a href="http://simplepie.org" title="SimplePie 1.5">SimplePie</a>. Variation on the Feed Icon by <a href="http://www.bartelme.at/journal/archive/feed_icon_template">Wolfgang Bartelme</a>.</p> <div class="spacer"></div> </div> <script type="text/javascript">_uacct = "UA-1004552-1";urchinTracker();</script> </div> </div> <div class="no"><img src="/wiki/lib/exe/indexer.php?id=start&1743827372" width="1" height="1" alt="" /></div> </body> </html>