The WordPress Block code of this repository is outdated - follow the new approach explained in https://developer.wordpress.org/
This is a WordPress plugin that registers a Gutenberg block. The block displays posts from an RSS feed.
Gutenberg has to be installed on your WordPress instance in order to use this plugin.
The plugin uses the fetch_feed WordPress function to display the entries from a feed on your website (https://codex.wordpress.org/Function_Reference/fetch_feed).
Here are the steps for installing and setting up this plugin to your WordPress site:
- download the plugin and upload it to your plugins folder;
- activate the plugin from the WordPress dashboard;
- go to the edit page of the article, that will display the feed, and choose the RSS Feed Gutenberg block from the available list.
Once the plugin is installed, you'll first need to enter the URL of your feed URL. There is a helpful button for validating the feed URL. If there is something wrong, an error will appear.
Here are the available feed options:
- Number of posts to be shown on the front-end. The default number is 10.
- Whether to show the descriptions of the posts on the front-end.
- Whether to show the dates of the posts on the front-end.
There are a few WordPress hooks that allows you to modify the output. All of them are related to the front-end.
Actions
grf_before_items -- called before displaying the feed on your site.
grf_before_item -- called before each feed entry.
grf_after_item -- called after each feed entry.
grf_after_items -- called after all listed entries.
Filters
grf_frontend_output -- allows you to modify the HTML markup that will be displayed on the site.
In case, a feed isn't configured or it isn't a valid one, the following messages might appear on the page that uses the custom block:
- Missing feed URL:
Please set the URL of the RSS feed through the WordPress dashboard. - Incorrect feed:
Please make sure the provided URL is a valid feed. - No posts:
No feed items found.