nested in the list.
false - the default behaviour and is what feedList has always done. No update date is displayed.
* additional_fields - lets you enter a list of fields you want to display. The list of fields needs to be delimited by a tilde (~). If you want to show a nested field then it needs to be defined as a period/dot delimited item.
example using del.icio.us and you want to show the tags associated with the item and the summary of the item -
feedList(array("rss_feed_url"=>"http://del.icio.us/rss/finalcut",
"additional_fields"=>'summary~dc.subject'
)
In this example the list of fields is summary and dc.subject - dc.subject drills down into the rss structure to reach the node
- - del.icio.us currently exports the list of tags
in the dc.subject field.
* max_characters - The maximum number of characters to return. If you want to show everything, set to 0 (default).
NOTE: if this is set (non 0 number) then any HTML entities will not be converted back to HTML to make sure your sites HTML doesn't get broken.
* max_char_wordbreak - Used only if max_characters is NOT 0. Prevent breaking up words.
true - we cut on the last space before max_characters.
false - cuts right at the max_characters point
* show_description_only - provides a mechanism for turning off the item titles
true - suppresses the title and the description separator; forces "show_description" to be true
false - won't change the behavior of the plugin at all. (DEFAULT)
FILTER USAGE
* basic:
NOTE if you aren't using named parameters with the fitler then ONLY provide the url after the rss: or else it won't work. Left as rss: for backwards compatability but will work with ATOM feeds as well.
* NAMED PARAMETERS
NOTE when using the filter and named parameters ALL parameters including the URL must be named. Also note that if you are providing different HTML for the before or after parameter you must escape it. For instance if you want before='' then you must pass before='<li>'
Finally note the whole thing must be on ONE line. No line breaks or else it won't work.
* random file:
NOTE: if you aren't using named parameters with the filter only provide the full path to the file or else it won't work.
NOTE: if you don't provide a filepath the default one set in the file, feedlist.php near line 187 will be used (typically siteroot\wp-content\plugins\feeds.txt)
* Named Parameters
NOTE: this example will pull one feed from the file, and then show 3 items fro the feed
EXAMPLES:
NAMED PARAMETER EXAMPLE -- PREFERRED METHOD
"http://www.auf-der-hoehe.de/index.php?id=23&type=333&feed_id=71&no_cache=1",
"num_items"=>10,
"show_description"=>false,
"random"=>true,
"sort"=>"asc",
"new_window"=>true,
"show_date"=>true
)
);
?>
BASIC
due to the fact that rssLinkList wraps each item with an tag pair by default you need to provide the or wrappers around the function call.
COMBINING LISTS:
You can also combine rss calls into one html list simply by wrapping multiple rssLinkList function calls in one set of html list tags. Notice I only specify the first parameter here. All parameters have defaults so the only one you really need to provide is the URL.
since the function, feedList, by default wraps each rss item in - tags you will end up with one long list of items to display.
ENCODING EXAMPLE:
","
","-",true); ?>
NOTE:
Remember, if you don't want your items to be displayed as an html list - you need to override the default parameters of "before" and "after" in the function call.
-------------------
RANDOM FEEDS
-------------------
This is a feature that lets you prepopulate a text file in a easy to read format that feedList will use to display your feeds randomly.
It supports pretty much every option the normal feedList functionality supports but with the added ability of displaying items from multiple feeds
at one time.
There are some potential areas where you might have problems using this.
1. You don't format your feed file properly.
2. You don't tell feedList the correct location of your feed file. 99% of the time this will be the problem.
For an example of a feedFile check out the feedFile_example.txt that comes with the plugin. For the absolutely easiest
means of using this feature just create a copy of feedFil_example.txt and renamte it as feeds.txt and put it in your wp-content/plugins
directory.
USAGE:
SIMPLE: assuming you put your feeds.txt file in the wp-content/plugins directory
ADVANCED:
there are ALOT of parameters you can pass into randomFeedList. I am taking a different approach to it here than I do elsewhere in the feedList plugin.
If you want to pass parameters they must be passed in as shown separating each additional name/value pair with an ampersand &.
PARAMETERS
file - the path to your feedfile (default: '.wp-content/plugins/feeds.txt')
feedsToShow - the number of feeds to poll from your feedfile (default: 5)
num_items - the number of items to show from each feed polled (default: 1)
show_description - show the description of each item or not (default: false)
randomItemsPerFeed - not only can you show random feeds from the feed file but you can also show random items from each feed (default: true)
beforeItems - what to show before an item (default: '')
afterItems - what to show after an item (default: '')
description_separator - what to show, if the description is displayed, between the item title and the description (default: '-')
encoding - a weak effort at internationalization support. If your feeds show up with weird characters try setting this to true (default: false)
sort - how to sort the feed items by title: asc (ascending order), desc (descending), or none - leave feed in its natural order, typically date of posting (default: none)
new_window - wheter to open the links in a new window (default: false)
ignore_cache - wheter to ignore the cached copy of the feed - recommended to leave as false (default: false)
suppress_link - wheter to remove the link from the title (default: false)
show_date - wheter to show the date each feed was last updated (default false);
additional_fields - any additional fields to display with the item. (default: an empty string)
CRAZY ADVANCED CALLING:
if you want to specify all of those parameters in one call
== Troubleshooting ==
1. if your feed isn't being loaded properly then try to replace the following two files in your wp-includes directory of your wordpress install:
class-snoopy.php and rss.php
with the copies found at http://code.google.com/p/wp-feedlist/downloads/list
== Extensions ==
I have added a rudimentary extension mechanism that will let you add custom behavior to how feedList process the feeds. This way you can edit the feedListExtensions.php file and
not have to worry about breaking compatiability with feedList (thus you will get updates without a problem. Upgrades may become more difficult in the future so we shall see how this
goes.
-- transformLinkURL --
This extension point is used to make changes to the URLs associated with all the links before they are used within feedList. For example if you wanted to add a tracking code
to the end of the url you could just update the default function to return as follows:
return $url . "&trackingCode=mytrackingCode";
Obviously you'd want to add a little bit of logic to make sure you needed the & and not the ? before appending your new url argument (I leave that to you). Likewise
this is a pretty weak example but hopefully it illustrates the extension point well enough. One user is using this extension point to reroute all URls to a different location
before they go off to their actual destination (not sure why).