PHPackages                             pixelopen/sulu-reviewbundle - 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. pixelopen/sulu-reviewbundle

ActiveSulu-bundle

pixelopen/sulu-reviewbundle
===========================

Review bundle (Google My Business Review) for Sulu

2.6.0(1y ago)1205↓100%1MITPHPPHP ^8.0

Since Dec 7Pushed 1y ago2 watchersCompare

[ Source](https://github.com/Pixel-Open/sulu-reviewbundle)[ Packagist](https://packagist.org/packages/pixelopen/sulu-reviewbundle)[ Docs](https://github.com/Pixel-Open/sulu-reviewbundle)[ RSS](/packages/pixelopen-sulu-reviewbundle/feed)WikiDiscussions develop Synced today

READMEChangelog (3)Dependencies (12)Versions (5)Used By (0)

Sulu Review bundle
==================

[](#sulu-review-bundle)

[![GitHub release (with filter)](https://camo.githubusercontent.com/dcace8460ec74b3b2bec9ff4eb9a721fea735d64af6fcf3a61eece5f22c7e317/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f506978656c2d4f70656e2f73756c752d72657669657762756e646c653f7374796c653d666f722d7468652d6261646765)](https://camo.githubusercontent.com/dcace8460ec74b3b2bec9ff4eb9a721fea735d64af6fcf3a61eece5f22c7e317/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f506978656c2d4f70656e2f73756c752d72657669657762756e646c653f7374796c653d666f722d7468652d6261646765)[![Dependency](https://camo.githubusercontent.com/a7164181066052cd108eee770b71f67bfd7cbe74cf87af56067534814e843f34/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f73756c752d322e352d6363613030302e7376673f7374796c653d666f722d7468652d6261646765)](https://sulu.io/)

Presentation
------------

[](#presentation)

A bundle to display customer reviews for the Sulu CMS. Reviews can be retrieved automatically from Google My Business.

Requirements
------------

[](#requirements)

- PHP &gt;= 8.0
- Composer
- Sulu &gt;= 2.5.\*
- Symfony &gt;= 5.4

Features
--------

[](#features)

- Display reviews on the website
- Settings management
- Possibility to retrieve reviews from Google My Business

Installation
------------

[](#installation)

### Install the bundle

[](#install-the-bundle)

Execute the following [composer](https://getcomposer.org/) command to add the bundle to the dependencies of your project:

```
composer require pixelopen/sulu-reviewbundle
```

### Enable the bundle

[](#enable-the-bundle)

Enable the bundle by adding it to the list of registered bundles in the `config/bundles.php` file of your project:

```
return [
    /* ... */
    Pixel\ReviewBundle\ReviewBundle::class => ['all' => true],
];
```

### Update schema

[](#update-schema)

Use a doctrine migration for this.

Bundle Config
-------------

[](#bundle-config)

Define the Admin Api Route in `routes_admin.yaml`

```
review.reviews_api:
  type: rest
  prefix: /admin/api
  resource: pixel_review.reviews_route_controller
  name_prefix: review.

review.setting_api:
  type: rest
  prefix: /admin/api
  resource: pixel_review.settings_route_controller
  name_prefix: review.
```

Use
---

[](#use)

### Add/Edit a review

[](#addedit-a-review)

Go to the "Reviews" section in the administration interface. Then, click on "Add". Fill the fields that are needed for your use.

Here is the list of the fields:

- Customer name (mandatory)
- Review date (mandatory)
- Rating (mandatory)
- Message (Mandatory)
- Retrieve from Google My Business? (Read only. Allows you to know if the review was automatically picked up from Google)
- Customer image

Once you finished, click on "Save"

To edit a review, simply click on the pencil at the left of the review you wish to edit.

Remove/Restore a gallery
------------------------

[](#removerestore-a-gallery)

There are two ways to remove a review:

- Check every review you want to remove and then click on "Delete"
- Go to the detail of a review (see the above section) and click on "Delete".

In both cases, the review will be put in the trash.

To access the trash, go to the "Settings" and click on "Trash". To restore a review, click on the clock at the left. Confirm the restore. You will be redirected to the detail of the review you restored.

To remove permanently a review, check all the reviews you want to remove and click on "Delete".

Settings
--------

[](#settings)

This bundle comes with settings. Here the list of the different settings available:

- Total reviews (mandatory)
- Average rating (mandatory)
- Use Google rating?
- Retrieve Google review?
- Place ID
- API key

The total reviews and the average rating must be filled manually unless you use the Google rating.

The option "Use Google rating?" allows you to pick up the total rating and the average rating from Google. If you want to retrieve the reviews as well, check the "Retrieve Google review?" checkbox.

If you decide to use the reviews information from Google, you will need to fill the place ID and the API key. Once that is done, run the following command:

```
bin/console sync:google:rating
```

Twig function
-------------

[](#twig-function)

There are several twig function in order to help you use the reviews and the settings on your website:

**get\_latest\_reviews(limit)**: returns the latest reviews. It takes one parameter:

- limit: represents the number of the latest reviews to display. If no limit is provided, the default value is 3.

Example of use:

```

    {% set reviews = get_latest_reviews(4) %}
    {% for review in reviews %}

            {{ review.message|raw }}
            {{ review.name }} - {{ review.rating }}/5

    {% endfor %}

```

**get\_latest\_reviews\_html(limit)**: do the same thing as get\_latest\_reviews() but it renders a view instead. It takes one parameter:

- limit: represents the number of the latest reviews to display. If no limit is provided, the default value is 3.

Example of use:

```

    {{ get_latest_reviews_html(4) }}

```

**reviews\_settings()**: returns the settings of the bundle. No parameters are required.

Example of use:

```
{% set reviewsSettings = reviews_settings() %}
{% if reviewsSettings is not null %}

        Note : {{ reviewsSettings.averageRating }}

                More than {{ reviewsSettings.totalRating }} reviews

{% endif %}
```

Contributing
------------

[](#contributing)

You can contribute to this bundle. The only thing you must do is respect the coding standard we implements. You can find them in the `ecs.php` file.

###  Health Score

29

—

LowBetter than 63% of packages

Maintenance33

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~83 days

Total

3

Last Release

669d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/d2b87043ea111a9f5d76ffa990f48eea6e80576483c7bf33f0dcdd5a899c15c8?d=identicon)[pixeldev](/maintainers/pixeldev)

---

Top Contributors

[![matthieu2607](https://avatars.githubusercontent.com/u/14790414?v=4)](https://github.com/matthieu2607 "matthieu2607 (10 commits)")

---

Tags

google-my-businessreviews-customerssulusulu-bundlesulusulucmssulu-bundle

###  Code Quality

Static AnalysisPHPStan

Code StyleECS

Type Coverage Yes

### Embed Badge

![Health badge](/badges/pixelopen-sulu-reviewbundle/health.svg)

```
[![Health](https://phpackages.com/badges/pixelopen-sulu-reviewbundle/health.svg)](https://phpackages.com/packages/pixelopen-sulu-reviewbundle)
```

###  Alternatives

[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M125](/packages/sulu-sulu)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
