PHPackages spatie/laravel-feed - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. spatie/laravel-feed ActiveLibrary[Utility & Helpers](/categories/utility) spatie/laravel-feed =================== Generate rss feeds 4.5.0(2mo ago)9743.6M—4.7%10220MITPHPPHP ^8.2CI passing Since Mar 5Pushed 2mo ago15 watchersCompare [ Source](https://github.com/spatie/laravel-feed)[ Packagist](https://packagist.org/packages/spatie/laravel-feed)[ Docs](https://github.com/spatie/laravel-feed)[ Fund](https://spatie.be/open-source/support-us)[ GitHub Sponsors](https://github.com/spatie)[ RSS](/packages/spatie-laravel-feed/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (10)Dependencies (8)Versions (70)Used By (20) [ ![Logo for laravel-feed](https://camo.githubusercontent.com/881a47957ad8fe87a8ba1ef631b1d48f317334738cb8d98b5da9ac871f031ae7/68747470733a2f2f7370617469652e62652f7061636b616765732f6865616465722f6c61726176656c2d666565642f68746d6c2f6c696768742e77656270) ](https://spatie.be/open-source?utm_source=github&utm_medium=banner&utm_campaign=laravel-feed)Generate RSS feeds in a Laravel app =================================== [](#generate-rss-feeds-in-a-laravel-app) [![Latest Version on Packagist](https://camo.githubusercontent.com/0a77ac44e3568d43658ab20238e31c40d84fb14d38d65f5cc8ec2acbf57b1bfe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7370617469652f6c61726176656c2d666565642e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/laravel-feed)[![MIT Licensed](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![run-tests](https://github.com/spatie/laravel-feed/actions/workflows/run-tests.yml/badge.svg)](https://github.com/spatie/laravel-feed/actions/workflows/run-tests.yml)[![Total Downloads](https://camo.githubusercontent.com/55ef5cc80e393fb1a2123d63c959801663a9a333e62effd1157d767c51d6cabe/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7370617469652f6c61726176656c2d666565642e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/laravel-feed) This package provides an easy way to generate a feed for your Laravel application. Supported formats are [RSS](http://www.whatisrss.com/), [Atom](https://en.wikipedia.org/wiki/Atom_(standard)), and [JSON](https://jsonfeed.org). There's almost no coding required on your part. Just follow the installation instructions, update your config file, and you're good to go. Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects [on our website](https://spatie.be/opensource). Support us ---------- [](#support-us) [![](https://camo.githubusercontent.com/65ab01facc8411215c460177ea5eaf7a1265b7b9e38f74c6a7c7cb177aae705f/68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6c61726176656c2d666565642e6a70673f743d31)](https://spatie.be/github-ad-click/laravel-feed) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards). Installation ------------ [](#installation) You can install the package via composer: ``` composer require spatie/laravel-feed ``` Register the routes the feeds will be displayed on using the `feeds`-macro. ``` // In routes/web.php Route::feeds(); ``` Optionally, you can pass a string as a first argument of the macro. The string will be used as a URL prefix for all configured feeds. Next, you must publish the config file: ``` php artisan feed:install ``` Here's what that looks like: ``` return [ 'feeds' => [ 'main' => [ /* * Here you can specify which class and method will return * the items that should appear in the feed. For example: * [App\Model::class, 'getAllFeedItems'] * * You can also pass an argument to that method. Note that their key must be the name of the parameter: * * [App\Model::class, 'getAllFeedItems', 'parameterName' => 'argument'] */ 'items' => '', /* * The feed will be available on this url. */ 'url' => '', 'title' => 'My feed', 'description' => 'The description of the feed.', 'language' => 'en-US', /* * The image to display for the feed. For Atom feeds, this is displayed as * a banner/logo; for RSS and JSON feeds, it's displayed as an icon. * An empty value omits the image attribute from the feed. */ 'image' => '', /* * The format of the feed. Acceptable values are 'rss', 'atom', or 'json'. */ 'format' => 'atom', /* * The view that will render the feed. */ 'view' => 'feed::atom', /* * The mime type to be used in the tag. Set to an empty string to automatically * determine the correct value. */ 'type' => '', /* * The content type for the feed response. Set to an empty string to automatically * determine the correct value. */ 'contentType' => '', ], ], ]; ``` Optionally you can publish the view files: ``` php artisan vendor:publish --provider="Spatie\Feed\FeedServiceProvider" --tag="feed-views" ``` Usage ----- [](#usage) Imagine you have a model named `NewsItem` that contains records that you want to have displayed in the feed. First you must implement the `Feedable` interface on that model. `Feedable` expects one method: `toFeedItem`, which should return a `FeedItem` instance. ``` // app/NewsItem.php use Illuminate\Database\Eloquent\Model; use Spatie\Feed\Feedable; use Spatie\Feed\FeedItem; class NewsItem extends Model implements Feedable { public function toFeedItem(): FeedItem { return FeedItem::create() ->id($this->id) ->title($this->title) ->summary($this->summary) ->updated($this->updated_at) ->link($this->link) ->authorName($this->author) ->authorEmail($this->authorEmail); } } ``` If you prefer, returning an associative array with the necessary keys will do the trick too. ``` // app/NewsItem.php use Illuminate\Database\Eloquent\Model; use Spatie\Feed\Feedable; use Spatie\Feed\FeedItem; class NewsItem extends Model implements Feedable { public function toFeedItem(): FeedItem { return FeedItem::create([ 'id' => $this->id, 'title' => $this->title, 'summary' => $this->summary, 'updated' => $this->updated_at, 'link' => $this->link, 'authorName' => $this->authorName, ]); } } ``` Next, you'll have to create a method that will return all the items that must be displayed in the feed. You can name that method anything you like and you can do any query you want. ``` // app/NewsItem.php public static function getFeedItems() { return NewsItem::all(); } ``` Finally, you have to put the name of your class and the url where you want the feed to rendered in the config file: ``` // config/feed.php return [ 'feeds' => [ 'news' => [ /* * Here you can specify which class and method will return * the items that should appear in the feed. For example: * 'App\Model@getAllFeedItems' * or * ['App\Model', 'getAllFeedItems'] * * You can also pass an argument to that method. Note that their key must be the name of the parameter: * * ['App\Model@getAllFeedItems', 'parameterName' => 'argument'] * or * ['App\Model', 'getAllFeedItems', 'parameterName' => 'argument'] */ 'items' => 'App\NewsItem@getFeedItems', /* * The feed will be available on this url. */ 'url' => '/feed', 'title' => 'All newsitems on mysite.com', /* * The format of the feed. Acceptable values are 'rss', 'atom', or 'json'. */ 'format' => 'atom', /* * Custom view for the items. * * Defaults to feed::feed if not present. */ 'view' => 'feed::feed', ], ], ]; ``` The `items` key must point to a method that returns one of the following: - An array or collection of `Feedable`s - An array or collection of `FeedItem`s - An array or collection of arrays containing feed item values ### Customizing your feed views [](#customizing-your-feed-views) This package provides, out of the box, the `feed::feed` view that displays your feeds details. However, you could use a custom view per feed by providing a `view` key inside of your feed configuration. In the following example, we're using the previous `News` feed with a custom `feeds.news` view (located on `resources/views/feeds/news.blade.php`): ``` // config/feed.php return [ 'feeds' => [ 'news' => [ 'items' => ['App\NewsItem', 'getFeedItems'], 'url' => '/feed', 'title' => 'All newsitems on mysite.com', /* * The format of the feed. Acceptable values are 'rss', 'atom', or 'json'. */ 'format' => 'atom', /* * Custom view for the items. * * Defaults to feed::feed if not present. */ 'view' => 'feeds.news', ], ], ]; ``` ### Automatically generate feed links [](#automatically-generate-feed-links) To discover a feed, feed readers are looking for a tag in the head section of your html documents that looks like this: ``` ``` You can add this to your `` through a partial view. ``` @include('feed::links') ``` As an alternative you can use this blade component: ``` ``` Testing ------- [](#testing) ``` composer test ``` Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [Jolita Grazyte](https://github.com/JolitaGrazyte) - [Freek Van der Herten](https://github.com/freekmurze) - [Sebastian De Deyne](https://github.com/sebastiandedeyne) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 74 — ExcellentBetter than 100% of packages Maintenance83 Actively maintained with recent releases Popularity66 Solid adoption and visibility Community43 Growing community involvement Maturity90 Battle-tested with a long release history Bus Factor1 Top contributor holds 68.8% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~53 days Recently: every ~93 days Total 69 Last Release 86d ago Major Versions 1.4.1 → 2.0.02017-08-30 2.7.1 → 3.0.02020-09-08 3.2.1 → 4.0.02021-05-31 PHP version history (8 changes)1.0.0PHP ^7.0 2.1.2PHP ^7.1 2.2.0PHP ^7.2 2.7.1PHP ^7.3 3.0.0PHP ^7.4 3.1.0PHP ^7.4|^8.0 4.0.0PHP ^8.0 4.4.1PHP ^8.2 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/7535935?v=4)[Spatie](/maintainers/spatie)[@spatie](https://github.com/spatie) --- Top Contributors [![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (236 commits)")[![sebastiandedeyne](https://avatars.githubusercontent.com/u/1561079?v=4)](https://github.com/sebastiandedeyne "sebastiandedeyne (41 commits)")[![rubenvanassche](https://avatars.githubusercontent.com/u/619804?v=4)](https://github.com/rubenvanassche "rubenvanassche (11 commits)")[![AdrianMrn](https://avatars.githubusercontent.com/u/12762044?v=4)](https://github.com/AdrianMrn "AdrianMrn (9 commits)")[![Gummibeer](https://avatars.githubusercontent.com/u/6187884?v=4)](https://github.com/Gummibeer "Gummibeer (4 commits)")[![riasvdv](https://avatars.githubusercontent.com/u/3626559?v=4)](https://github.com/riasvdv "riasvdv (4 commits)")[![patinthehat](https://avatars.githubusercontent.com/u/5508707?v=4)](https://github.com/patinthehat "patinthehat (4 commits)")[![laravel-shift](https://avatars.githubusercontent.com/u/15991828?v=4)](https://github.com/laravel-shift "laravel-shift (4 commits)")[![AlexVanderbist](https://avatars.githubusercontent.com/u/6287961?v=4)](https://github.com/AlexVanderbist "AlexVanderbist (3 commits)")[![trovster](https://avatars.githubusercontent.com/u/48729?v=4)](https://github.com/trovster "trovster (3 commits)")[![jimirobaer](https://avatars.githubusercontent.com/u/8984769?v=4)](https://github.com/jimirobaer "jimirobaer (3 commits)")[![akoepcke](https://avatars.githubusercontent.com/u/5311185?v=4)](https://github.com/akoepcke "akoepcke (2 commits)")[![peter279k](https://avatars.githubusercontent.com/u/9021747?v=4)](https://github.com/peter279k "peter279k (2 commits)")[![renatofmachado](https://avatars.githubusercontent.com/u/4793869?v=4)](https://github.com/renatofmachado "renatofmachado (1 commits)")[![seschi98](https://avatars.githubusercontent.com/u/8929221?v=4)](https://github.com/seschi98 "seschi98 (1 commits)")[![timvandijck](https://avatars.githubusercontent.com/u/4528796?v=4)](https://github.com/timvandijck "timvandijck (1 commits)")[![vdbelt](https://avatars.githubusercontent.com/u/11087503?v=4)](https://github.com/vdbelt "vdbelt (1 commits)")[![zachleigh](https://avatars.githubusercontent.com/u/5616626?v=4)](https://github.com/zachleigh "zachleigh (1 commits)")[![alexander-feil](https://avatars.githubusercontent.com/u/2084361?v=4)](https://github.com/alexander-feil "alexander-feil (1 commits)")[![ctf0](https://avatars.githubusercontent.com/u/7388088?v=4)](https://github.com/ctf0 "ctf0 (1 commits)") --- Tags blogfeedlaravelphprssspatielaravelrsslaravel-feed ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/spatie-laravel-feed/health.svg) ``` [![Health](https://phpackages.com/badges/spatie-laravel-feed/health.svg)](https://phpackages.com/packages/spatie-laravel-feed) ``` ### Alternatives [spatie/laravel-data Create unified resources and data transfer objects 1.8k28.9M627](/packages/spatie-laravel-data)[spatie/laravel-enum Laravel Enum support 3655.4M31](/packages/spatie-laravel-enum)[spatie/laravel-livewire-wizard Build wizards using Livewire 4061.0M4](/packages/spatie-laravel-livewire-wizard)[spatie/laravel-rdap Perform RDAP queries in a Laravel app 72108.3k2](/packages/spatie-laravel-rdap)[spatie/laravel-support-bubble A non-intrusive support chat bubble that can be displayed on any page 391173.6k](/packages/spatie-laravel-support-bubble)[tonysm/importmap-laravel Use ESM with importmap to manage modern JavaScript in Laravel without transpiling or bundling. 148399.8k1](/packages/tonysm-importmap-laravel) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)