# ppl/module-order-comment

> Checkout comment field for Magento 2 that stores customer notes on the order and shows them in admin.

`composer require ppl/module-order-comment`

Canonical URL: https://packagento.com/ppl/module-order-comment

## At a glance

- **Vendor**: Pawel Pliousnin Digital Solutions (https://packagento.com/ppl.md)
- **Latest version**: 1.2.0 — released 2026-07-02
- **Pricing**: $10.00, one-time
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

This is a paid package. The Packagento install flow is licence-gated, so a Composer install needs a licence + project + project credentials in place first.

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

2. **Purchase the package.** Open https://packagento.com/ppl/module-order-comment, add it to your cart, and complete checkout. A licence is minted automatically once payment clears.

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 ppl/module-order-comment:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Checkout comment field for Magento 2 that stores customer notes on the order and shows them in admin.

## README

PPL Order Comment adds a checkout comment field that stores customer notes with the quote and order and displays them in the Magento admin.

### What It Adds
- Checkout comment capture during order placement
- Order admin display locations controlled by configuration
- Stored order note for customer service, fulfillment, and operations

### Requirements And Dependencies
- PHP: >=8.1
- Magento packages: magento/framework, magento/module-backend, magento/module-checkout, magento/module-config, magento/module-quote, magento/module-sales, magento/module-store
- PPL packages: ppl/module-hub

### Installation
Composer installation:

```bash
composer require ppl/module-order-comment
bin/magento module:enable Ppl_Hub Ppl_OrderComment
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean
```

Manual app/code installation: copy the module to `app/code/Ppl/OrderComment`, install the dependencies listed above, then run the same Magento commands without the Composer step.

### First Use
- Enable the module with Checkout, Quote, Sales, Store, Config, and Ppl_Hub dependencies.
- Configure Enabled, Max Length, and Admin Display Locations.
- Place a test order to confirm the comment is saved and visible.

Admin entry: `Stores > Configuration > PPL > Order Comment / Sales order detail`.

### Integrations And Boundaries
- Works beside reporting and order-management modules but does not require them.

### Localization
The package includes translation CSV files for 12 locales: de_DE, en_US, es_ES, fr_FR, it_IT, ja_JP, nl_NL, pl_PL, pt_BR, ru_RU, tr_TR, zh_CN.

### Documentation
- Screenshot inventory: `docs/images/ppl-order-comment/` in the repository documentation tree

### Support
Support contact: pliousnin@ppl-ds.com. Include the module version, Magento version, enabled PPL companion modules, and the relevant admin or storefront screenshot when reporting an issue.

## Changelog


### 1.2.0
- Adapted to the updated PPL Hub: admin navigation, ACL, and menu integration aligned to the PPL Hub 1.2 line
- Minor fixes and stability improvements

### Unreleased

- Added configurable admin order view display location for Customer Comment.
- Fixed admin order comment layout attachment by targeting Magento's order additional info container.

### 1.0.0

Initial release.

Features:

- Checkout order comment field
- Quote and sales order persistence through extension attributes
- Admin order view rendering
- Declarative schema for quote and order columns

## Recent Versions

| Version | Released |
|---|---|
| 1.2.0 | 2026-07-02 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| ext-mbstring | * |
| magento/framework | >=103.0.0 <104.0.0 |
| magento/module-backend | >=102.0.0 <103.0.0 |
| magento/module-checkout | >=100.4.0 <101.0.0 |
| magento/module-config | >=101.2.0 <102.0.0 |
| magento/module-quote | >=101.2.0 <102.0.0 |
| magento/module-sales | >=103.0.0 <104.0.0 |
| magento/module-store | >=101.1.0 <102.0.0 |
| magento/module-ui | >=101.0.0 <103.0.0 |
| php | >=8.1 |
| ppl/module-hub | ^1.2 |
| psr/log | ^1.0 \|\| ^2.0 \|\| ^3.0 |

## Quality

Latest release (1.2.0) passes 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 | Pass | 0 |  |
| PHPMD | Warning | 10 | 10 rule violations (UnusedFormalParameter:9, MissingImport:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (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 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### 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 | N/A | 0 | no resolvable dependency tree to audit: Your requirements could not be resolved to an installable set of packages. Problem 1 |
| Malware scan | Pass | 0 |  |

## Licence and pricing

One-time — $10.00. No renewal, no recurring charge. Includes patch releases for the licensed major version.

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=["ppl/module-order-comment"],
  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

Pawel Pliousnin Digital Solutions is a Magento 2 vendor on Packagento. See https://packagento.com/ppl.md for their full catalogue.