# magenable/module-popup

> A Magento 2 popup module with newsletter feature

`composer require magenable/module-popup`

Canonical URL: https://packagento.com/magenable/module-popup

## At a glance

- **Vendor**: magenable (https://packagento.com/magenable.md)
- **Latest version**: 1.0.7 — released 2026-06-16
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/magenable/module-popup and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require magenable/module-popup:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

A Magento 2 popup module with newsletter feature

## README

**Magenable Popup** is a Magento 2/Adobe Commerce module that adds a popup to website pages. The content for the popup is sourced from a selected CMS Block. Additionally, the module offers the option to include a newsletter subscription feature in the popup window. Google ReCaptcha v2 and v3 are supported.

![](README/1.png)

### Installation

#### Composer:

Run the following command in Magento 2 root folder

```
composer require magenable/module-popup
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
```
### Upgrade

#### Composer:

Run the following command in Magento 2 root folder

```
composer update magenable/module-popup
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy
```

### User Guide

#### Configuration:

Go to **Stores** > **Settings** > **Configuration** > **Magenable Extensions** > **Popup**.

##### General

- `Enabled` - Enable or Disable the popup
- `Title` - Title of the popup
- `CMS Block` - You can select a CMS Block for the popup content
- `Button Text` - Newsletter subscription button text
- `Popup Delay` - You can specify number of seconds when popup should arise

##### Visibility

- `Visibility Type` - Choose to show the popup on all pages, excluding specified pages, or only show the popup on specified pages
- `Pages` - Specify the URLs of the pages (without the base URL) based on the previous configuration

##### Newsletter Subscription

- `Add Newsletter Subscription Form` - You can add a newsletter subscription form to the popup

##### Design

- `Max Width of Popup` - Max width of popup in pixels
- `Button Text Color` - Newsletter subscription button color
- `Button Background` - Newsletter subscription button background

![](README/2.png)

**Note:** _Magento Google Recaptha implementation has a bug that breaks a big rendering aroun Newsletter box. It affects alignment of Newsletter pop-up._

##### Compatibility
Tested with Magento Open Source 2.4.4 - 2.4.7, but will probably work with older Magento 2.X versions and Adobe Commerce

##### About developer
The extension is developed by Magenable (https://magenable.com.au), eCommerce consultancy specializing in Magento/Adobe Commerce based in Melbourne, Australia

## Changelog

1.0.7 (2026-06-16)
=============
- Tested with Magento v2.4.9 and PHP 8.5

1.0.6 (2025-07-04)
=============
- Tested with Magento v2.4.8-p1

1.0.5 (2025-03-10)
=============
- Tested with Magento v2.4.8

1.0.4 (2024-12-19)
=============
- Tested on Magento v2.4.4-p11, v2.4.5-p10, v2.4.6-p8 and v2.4.7-p3

1.0.3 (2024-08-23)
=============
- Tested with Magento v2.4.6-p7 and v2.4.7-p2

1.0.2 (2024-04-10)
=============
- Tested with Magento 2.4.7 and PHP 8.3

1.0.1 (2024-03-11)
=============
- Tested with Magento 2.4.6-p4
- Added change-log.txt
- Fixed knockout closing tags
- Fixed the php 7 compatibility issues

## Recent Versions

| Version | Released |
|---|---|
| 1.0.7 | 2026-06-16 |
| 1.0.6 | 2025-07-04 |
| 1.0.4 | 2024-12-19 |
| 1.0.3 | 2024-08-23 |
| 1.0.2 | 2024-04-16 |
| 1.0.1 | 2023-09-27 |
| 1.0.0 | 2023-09-11 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magenable/module-base | * |
| magento/framework | >=102.0 |

## Quality

Latest release (1.0.7) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 24 | 24 warnings (ruleset: Magento2) — 2 auto-fixable with phpcbf |
| PHPMD | Warning | 3 | 3 rule violations (UnusedFormalParameter:2, EmptyCatchBlock:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 3 | valid; 3 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 3 | 3 | – | – |
| 2.4.8 | – | 3 | 3 | – |
| 2.4.9 | – | – | 3 | 3 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["magenable/module-popup"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

magenable is a Magento 2 vendor on Packagento. See https://packagento.com/magenable.md for their full catalogue.