=== RSS Feed Pro ===
Contributors: Artiosmedia, steveneray, arafatrahmanbd
Donate link: https://www.zeffy.com/en-US/donation-form/your-donation-makes-a-difference-6
Tags: RSS, podcast, feed, streaming, RSS feed
Requires at least: 4.6
Tested up to: 6.9.0
Version: 1.1.12
Stable tag: 1.1.12
Requires PHP: 7.4.33
License: GPLv3 or later license and included
URI: http://www.gnu.org/licenses/gpl-3.0.html
Display an RSS Feed in a widget, a page, or a post using a shortcode with any number of parameters. Sort the archive by Category, Year, and Author.
== Description ==
WordPress comes with a default site-wide RSS feed, but it isn’t sufficient for podcasts, as it only shares blog posts. RSS Feed Pro is a full-featured podcasting plugin designed for both beginners and power users. A user first sets up their preferred podcast hosting, and the plugin delivers it to your WordPress build.
The plugin is an upgraded and advanced revision of Frank Bültge's RSSImport. RSS Feed Pro will display feeds in your blog, using PHP, a widget, or a shortcode. If you uninstall RSSImport and install RSS Feed Pro, you should not lose any of your current configurations. The plugin uses only standard WordPress functionality; therefore, no external libraries are required. As with all other content you publish, ensure that you are allowed to stream the content from the feeds you are importing.
To create a shortcode for sorting your RSS feeds archive catalog, please activate the plugin then click on RSS Archives > Add New Under "Shortcode Details". Add the feed URL, then the user can select their sort mode (By Year, By Category, and By Author Name)
To use the RSS Feed Pro widget, navigate to widgets and locate a widget named "RSS Feed Pro". Select the checkboxes for the shortcodes you'd like to use for your widget. Please click the "Installation" tab above for a comprehensive guide of the plugin's features and functions.
As of version 1.1.12, it enhances image support for the %picture_url% placeholder. The plugin now detects images from multiple RSS feed formats, including enclosure thumbnails, image enclosures, media:thumbnail elements, and images embedded within the feed content.
The plugin’s language support includes: English, Spanish, French, German, and Russian.
= Acknowledgements =
Based on Frank Bültge RSSImport plugin that was no longer supported. Thanks to [Dave Wolf](http://www.davewolf.net, "Dave Wolf") for the original idea, to [Thomas Fischer](http://www.securityfocus.de "Thomas Fischer") and [Gunnar Tillmann](http://www.gunnart.de "Gunnar Tillmann") for code enhancements in the original build-up to version 4.6.1 and Ilya Shindyapin, http://skookum.com for the idea and solution of pagination before version 4.6.1.
= License =
This advance fee plugin is public domain. Since it's released under the GPL, you can use it free of charge on your personal or commercial blog. However, if you have gained value from this plugin, you can thank us by leaving a [donation](https://www.paypal.com/donate/?cmd=_s-xclick&hosted_button_id=E7LS2JGFPLTH2 "Support the Needy") which will support the needy globally.
== Installation ==
1. Upload the plugin files to the '/wp-content/plugins/plugin-name' directory, or install the plugin through the WordPress plugins screen directly.
2. Activate the plugin through the 'Plugins' screen in WordPress.
3. Access the 'Admin Panel > RSS Shortcodes' to create any shortcode you might need. We suggest Sort by Author, Sort by Category, Sort by Year.
You can insert the following code into a PHP plugin or in a template, for example `sidebar.php` or `single.php`:
_Example:_
`<?php rssfp_import(10, 'https://yourdomain.com/feed/'); ?>`
This is the minimal code needed for using the plugin. The plugin accepts a number of parameters for customizing the feed content import. See below for the full list of available parameters. You can also use any of the parameters with Shortcode in posts and pages.
_Example Shortcode:_
`[RSSImport display="5" feedurl="https://yourdomain.com/feed/" use_simplepie="true"]`
For all (bool) parameters you can either use the strings `true` and `false` or the integer values `1` and `0`.
1. `display` - The number of items to display. Default is `5`.
2. `feedurl` - The feed address. Default is `https://yourdomain.com/feed/`.
3. `before_desc` - The HTML or string to insert before the description. Default is `empty`. You can use some variables which will be replaced, see below.
4. `displaydescriptions` - (bool) When set to true, the description for each entry will be displayed. Default is `false`.
5. `after_desc` - The HTML or string to insert after the description. Default is `empty`. You can use some variables which will be replaced, see below.
6. `html` - (bool) When set to true, the description can include HTML tags. Default is `false`.
7. `truncatedescchar` - The maximum number of characters allowed in descriptions. If the description is longer than this length, it will be truncated to the given length. Default is `200`, set the value to empty quotes `''` to never truncate descriptions.
8. `truncatedescstring` - The HTML or string to insert at the end of a description after it has been truncated. Default is ` ... `
9. `truncatetitlechar` - The maximum number of characters allowed in titles. If the title is longer than this value, it will be truncated to the given length. Default is `''`, which means never truncate titles.
10. `truncatetitlestring` - The HTML or string to insert at the end of a title after it has been truncated. Default is `' ... '`.
11. `before_date` - The HTML or string to insert before the date. Default is ` `.
12. `date` - (bool) If true, display the date of the item. Default is `false`.
13. `after_date` - The HTML or string to insert after the date. Default is ``.
14. `date_format`- The date format string. Leave empty to use the format of your WordPress installation. If a different date format is desired, specify a PHP date string, for example: `F j, Y`. See also [the date and time formatting page in the WordPress Codex](https://codex.wordpress.org/Formatting_Date_and_Time).
15. `before_creator` - The HTML or string to insert before the creator of the item. Default is ` `.
16. `creator` - (bool) If true, display the creator of the item. Default is `false`.
17. `after_creator` - The HTML or string to insert after creator of the item. Default is ``.
18. `start_items` - The HTML or string to insert before the list of items. Default is ``.
19. `end_items` - The HTML or string to insert after the list of items. Default is `
`.
20. `start_item` - The HTML or string to insert before each item. Default is ``. You can use some variables which will be replaced, see below.
21. `end_item` - The HTML or string to insert after each item. Default is ``. You can use some variables which will be replaced, see below.
22. `target` - The string to use for the `target` attribute on links. Default is `empty`. Valid options are `blank`, `self`, `parent`, `top`.
23. `rel` - The string to use for the `rel` attribute on links. Default is `empty`. Valid options are `nofollow` and `follow`.
24. `desc4title` - The description to use in the `title` attribute on item title links. Default is `false`.
25. `charsetscan` - (bool) If true, scan the feed content for the correct character set. This may cause the content to load more slowly. Use this option if you're having problems with feed content being displayed with stranged characters. Default is `false`.
26. `debug` - (bool) If true, activate debug-mode, which will echo the Magpie object as an array. Default is `false`. Only use this option for debugging.
27. `before_noitems` - The HTML or string to insert before the no items message. Default is ``.
28. `noitems`- The message to display when the feed is empty. Default is `No items, feed is empty.`.
29. `after_noitems` - The HTML or string to insert before the no items message. Default is `
`.
30. `before_error` - The HTML or string to insert before the error message. Default is ``.
31. `error` - Error message displayed when there is an error loading or displaying the feed. Default is `Error: Feed has an error or is not valid`.
32. `after_error` - The HTML or string to insert before the error message. Default is `
`.
33. `paging` - (bool) If true, enable pagination. Default is `false`.
34. `prev_paging_link` - The name of the previous page link. Default is `« Previous`.
35. `next_paging_link` - The name next page link. Default is `Next »`.
36. `prev_paging_title` - The title attribute of the previous page link. Default is `more items`.
37. `next_paging_title` - The title attribute of the next page link. Default is `more items`.
38. `use_simplepie` - (bool) If true, use SimplePie to parse the feed. SimplePie is included in WordPress 2.8 and newer and can parse both RSS and ATOM feeds. Default is `false` if used with Shortcode, `true` if used with the PHP function.
39. `view` - (bool) If true, calling the `rssfp_import()` function will print the rendered HTML directly to the output. If false, the rendered HTML will be returned by the function as a string value and nothing will be output. Default when using PHP code is `true`. Default when using Shortcode is `false`.
40. `random_sort` - (bool) If true, Items will be displayed in random order. Default when using Shortcode is `false`.
41. `order` - (string) Order of the filds Date, Title, Creator, Description. Use a comma separated string for your order. Default is `date,title,creator,description`
The parameters `before_desc`, `after_desc`, `start_item` and `end_item` accepts the following variables which will be replaced:
1. `%title%` for the title of the entry
2. `%href%` for the entry's URL
3. `%picture_url%` for the URL of a thumbnail image for the entry if available. To use this variable, SimplePie is required to be enabled (`use_simplepie="true"`)
If pagination is enabled, it adds a `div` with the class `rsspaging` to enable easier styling with CSS. You can also style the previous and next links, which have the classes: `rsspaging_prev` and `rsspaging_next`.
You can use any of the parameters in the php function `rssfp_import` in your templates or with the Shortcode `[RSSImport]` in posts and pages.
= Examples =
_Using the PHP function with many parameters:_
rssfp_import(
$display = 5, $feedurl = 'https://bueltge.de/feed/',
$before_desc = '', $displaydescriptions = false, $after_desc = '', $html = false, $truncatedescchar = 200, $truncatedescstring = ' ... ',
$truncatetitlechar = '', $truncatetitlestring = ' ... ',
$before_date = ' ', $date = false, $after_date = '',
$before_creator = ' ', $creator = false, $after_creator = '',
$start_items = '',
$start_item = '', $end_item = ''
);
Please note that for the PHP function the parameters are expected in the order in which they are defined in the above list. Thus if you skip one parameter, you will also have to skip all of the subsequent parameters.
_Using Shortcode with several parameters:_
[RSSImport display="10" feedurl="https://your_feed_url/"
displaydescriptions="true" html="true"
start_items="" end_items="
" paging="true" use_simplepie="true"]
_Add a "more" link to the output:_
rssfp_import(
$display = 5,
$feedurl = 'https://yourdomain.com/feed/',
$before_desc = '',
$displaydescriptions = true,
$after_desc = ' show more'
);
or
[RSSImport feedurl="https://wordpress.org/news/feed/" after_desc=" show more" displaydescriptions="true" use_simplepie="true"]
_Enable Thumbnail Pictures:_
rssfp_import(
$display = 5,
$feedurl = 'https://bueltge.de/feed/',
$before_desc = '
',
$displaydescriptions = true
);
or
[RSSImport feedurl="https://wordpress.org/news/feed/" displaydescriptions="true" before_desc="" after_desc="