All documentation

Issue Tracker — Documentation

Issues & FAQ Revolution lets you publish known issues, FAQ-style notices, compatibility notes, fixes, and workarounds for products in your PrestaShop store. Customers can check a public Known Issues hub or a product-page tab before opening a support ticket.

Features

  • Public Known Issues hub. The module adds a front-office tracker at /known-issues for pending, open, resolved, closed, and won't-fix entries.
  • Product-page issue tab. The displayProductExtraContent hook adds a Known Issues tab to product pages with open and total counts.
  • Back-office issue manager. The AdminMPRIssuesRevolutionIssues controller provides a searchable list with product, title, status, severity, source, votes, ETA, active, and indexable columns.
  • Detailed issue records. Each entry can store a product, multilingual title and slug, description, affected versions, reproduction steps, workaround, resolution note, status, severity, reports, and fix ETA.
  • Customer report form. The public report endpoint saves submitted reports as pending entries with CSRF protection, a honeypot field, and a 3-per-hour submitter limit.
  • Clean public issue URLs. Individual issue pages use readable slugs such as /known-issues/checkout-validation-error, while older ID-based URLs redirect to the clean version.
  • Tracker browsing tools. The public hub includes status summaries, recent pending/open/resolved sections, search, status filtering, sorting, and per-page controls.
  • SEO controls. The hub uses the module SEO policy for robots, hreflang, canonical URLs, and sitemap eligibility; issue detail and report pages are kept out of indexing, hreflang, sitemap, and schema output.
  • Sitemap integration. The gSitemapAppendUrls hook can add the hub to XML sitemaps when sitemap inclusion is enabled.
  • Theme-aware front styling. The module registers front CSS through ThemeDetector and exposes stable classes such as .mprissues-page, .mprissues-wrapper, .mpr-f-item, and .mpr-f-badge.
Issue Tracker — Product known issues tab Issue Tracker — Mprissuesrevolution issue detail status and notes

Configuration options

Set these in Improve -> Issues -> Settings -> Configuration.

  • Enable front display. Turns the product tab and public Known Issues pages on or off; default: 1.
  • Default status for new issues. Sets whether new back-office entries start as open or resolved; default: open.
  • Allow users to report issues. Shows the public report form and saves valid submissions as pending reports; default: 1.
  • Include Known Issues hub in sitemap. Allows the hub to be added through the sitemap hook; default: 1.
  • Allow Known Issues hub indexing. Lets the main hub use index/follow SEO behavior; default: 1.
  • Allow individual issue pages to be indexed. Configuration field for issue-page indexing; default: 0. In the current module SEO policy, issue detail pages remain non-indexable and are excluded from hreflang, sitemap, and schema output.
  • Tab title. Sets the multilingual title shown on product tabs; default: Known Issues.
  • Show dates. Displays report and update dates on front-office issue displays; default: 1.
  • Show status badges. Displays status labels such as Pending, Open, Resolved, Closed, and Won't fix; default: 1.
  • Hide tab when empty. Hides the product tab when the product has no active public issues; default: 1.
Issue Tracker — Known issues hub Issue Tracker — Mprissuesrevolution product tab known issues

Customization examples

Example configuration values for a public tracker where customers can read entries but cannot submit new reports:

enabled=1
allow_reporting=0
INCLUDE_IN_SITEMAP=1
ISSUES_HUB_INDEXABLE=1
ISSUE_INDEXABLE=0

Example issue entry for the back office:

Product: Checkout module
Title: Checkout button hidden after theme update
URL slug: checkout-button-hidden-after-theme-update
Status: open
Severity: high
Affected module versions: 2.4.0 - 2.5.2
Affected PrestaShop versions: PrestaShop 8.1 - 8.2
Workaround: Disable the theme's custom checkout override until the next module update.
Active: 1
Index this issue page: 0

Example resolved entry:

Status: resolved
Fixed in version: 2.5.20
Resolution note: Fixed compatibility with the updated checkout template.

Supported status and severity values:

status: pending, open, resolved, closed, wontfix
severity: low, medium, high, critical
source: admin, user

Public URLs you can share in support replies:

/known-issues
/known-issues/report
/known-issues/checkout-validation-error

Status, product, search, sort, and pagination request states redirect back to the base hub URL.

The product-tab title automatically shows open and total public issue counts:

Known Issues
Known Issues (2/5)

You can adjust front-office styling from your theme CSS with the module classes:

.mprissues-wrapper .mpr-f-badge--open {
  background: #dc2626;
  color: #fff;
}

.mprissues-detail-panel--workaround {
  border-left-color: #d97706;
}

.mprissues-severity--critical {
  color: #b91c1c;
}

Theme template override paths, when your theme needs custom markup:

/themes/your-theme/modules/mprissuesrevolution/views/templates/hook/product-tab.tpl
/themes/your-theme/modules/mprissuesrevolution/views/templates/front/issues.tpl
/themes/your-theme/modules/mprissuesrevolution/views/templates/front/issue.tpl

The public hub URL is controlled by the PrestaShop meta entry installed by the module:

page: module-mprissuesrevolution-issues
default URL rewrite: known-issues
default title: Known Issues & Bug Tracker
Issue Tracker — Report issue modal Issue Tracker — Mprissuesrevolution product tab report form

Installation

  1. In your Back Office, go to Modules -> Module Manager.
  2. Click Upload a module and select the module ZIP file.
  3. Install the module.
  4. Open Improve -> Issues to create or review issue entries.
  5. Open Settings -> Configuration to set display, reporting, sitemap, and indexing behavior.
Issue Tracker — Product issues lazy details Issue Tracker — Mprissuesrevolution public tracker status and highlights

How it works

In the Back Office, you create an issue or FAQ entry, choose the affected product, set its status and severity, then add the public explanation, workaround, fix version, or resolution note.

Customers see the information in two places: a product-page Known Issues tab and the public Known Issues hub. The hub shows summary counts, recent pending items, open items, resolved items, search, status filtering, sorting, and links to individual issue pages.

Issue Tracker — Mprissuesrevolution admin issue editor

Honest limits

  • The module publishes issue information; it does not automatically detect bugs in your store.
  • Public reports do not include file or screenshot uploads. Customers who need to send attachments should use your normal support channel.
  • Submitted reports are saved as pending, so someone still needs to review them before treating them as confirmed.
  • Individual issue pages are kept non-indexable by the module SEO policy, even when the per-issue indexable flag exists in the Back Office.
  • Each issue is linked to a product ID, so it is best suited for product, module, or service-style catalogs.
  • For non-default languages, cloned English issue content may be hidden until the localized title or description differs from the default-language version.
Issue Tracker — Mprissuesrevolution admin issue list filters

FAQ

Is Issues & FAQ Revolution visible to customers?
Yes. When front display is enabled, customers can see the public Known Issues hub and product-page tab.

Can customers submit issue reports?
Yes. Public reports are saved as pending entries and can be reviewed in the Back Office.

Can I link an issue to a specific product or module?
Yes. Every issue belongs to a product ID, and issue detail pages can link back to the affected product and its documentation page.

Can I show a known issue only in the Back Office?
Yes. Disable the entry with its Active switch if you do not want it shown publicly.

Can individual issue pages be indexed by search engines?
No. The current module SEO policy keeps issue detail pages non-indexable and excludes them from hreflang, sitemap, and schema output.

Does the module add URLs to the sitemap?
Yes, when sitemap inclusion is enabled. The hub can be included; issue detail pages are skipped by the current SEO policy.

Can I change the public URL from /known-issues?
Yes. Change the URL rewrite for the PrestaShop meta page module-mprissuesrevolution-issues in Shop Parameters -> Traffic & SEO.

Are screenshots or file attachments supported in reports?
No. The built-in report form stores the selected product, title, description, and email address only.

Compatibility: PrestaShop 1.6 to 9.0 (latest), PHP 7.1+. We continue to support upcoming PrestaShop versions.

Issue Tracker — Mprissuesrevolution integrity checks
Back to top