Adding Customer Custom attributes creating document files by mtmmahi · Pull Request #446 · AdobeDocs/commerce-php

mtmmahi · 2026-04-23T15:59:12Z

Purpose of this pull request

This pull request adds tutorials for 3 additional custom customer attribute types (boolean, dropdown, and multiselect) to the Adobe Commerce PHP documentation.

Key Changes

Configuration Update: Updated /src/pages/config.md to include navigation links to all three new tutorial pages
Supporting Assets: Added 2 new image files to document the visual appearance of custom attributes in the Admin UI
Base Template: These tutorials extend the existing "Create a text field attribute" documentation

New Topics & Documentation Pages

whatsnew
Add tutorials showing how to extend Adobe Commerce customer attributes with three commonly-used field types, providing developers with step-by-step code implementations, dependency injection patterns, and data patch lifecycle management (including reversible rollback functionality):

thiaramus · 2026-04-23T20:57:07Z

@@ -0,0 +1,419 @@
+---
+title: Add a Custom boolean Field Attribute | Commerce PHP Extensions


boolean should be capitalised. Should be:

title: Add a Custom Boolean Field Attribute | Commerce PHP Extensions

Ttitle Updated

thiaramus · 2026-04-23T20:57:07Z

+The factory is stored rather than a single `CustomerSetup` instance, because both `apply()` and `revert()` need to create their own instance.
+
+```php
+<?php declare(strict_types=1);


This snippet is a method-level excerpt, not a complete PHP file. The <?php declare(strict_types=1); opening tag should not appear here — it is only appropriate at the top of a full file. Please remove this line from the snippet.

Removed it from code snippet

thiaramus · 2026-04-23T20:57:07Z

+### Code reference
+
+```php
+<?php declare(strict_types=1);


<?php and declare(strict_types=1); must each be on their own line, consistently across the document.

Updated as per the comment

thiaramus · 2026-04-23T20:57:07Z

@@ -0,0 +1,412 @@
+---
+title: Add a Custom dropdown Field Attribute | Commerce PHP Extensions


dropdown should be capitalised. Should be:

title: Add a Custom Dropdown Field Attribute | Commerce PHP Extensions

Ttitle Updated

thiaramus · 2026-04-23T20:57:07Z

+
+   ![Custom attribute in the customer grid](../../images/tutorials/custom-attribute-customer-grid.png)
+
+To remove the attribute, run `bin/magento setup:rollback` and target this patch. The `revert()` method will execute and delete the attribute from the system.


<?php and declare(strict_types=1); must each be on their own line, consistently across the document.

Updated the code

thiaramus · 2026-04-23T20:57:07Z

@@ -0,0 +1,416 @@
+---
+title: Add a Custom boolean Field Attribute | Commerce PHP Extensions


The title says boolean — copied from the boolean file and not updated. Should be:

title: Add a Custom Multiselect Field Attribute | Commerce PHP Extensions

Updated the title

thiaramus · 2026-04-23T20:57:07Z

@@ -0,0 +1,416 @@
+---
+title: Add a Custom boolean Field Attribute | Commerce PHP Extensions
+description: Follow this tutorial to create a custom boolean field attribute for Adobe Commerce or Magento Open Source.


The description also says boolean field attribute — copied from the boolean file and not updated. Should be:

description: Follow this tutorial to create a custom multiselect field attribute for Adobe Commerce or Magento Open Source.

Updated the Description

thiaramus · 2026-04-23T20:57:07Z

+
+This tutorial describes how a developer can create a custom multiselect attribute for the Customer entity using code. This will reflect in both the [Customer Grid](https://experienceleague.adobe.com/en/docs/commerce-admin/customers/customer-accounts/manage/manage-account) and the [Customer Form](https://experienceleague.adobe.com/en/docs/commerce-admin/customers/customer-accounts/manage/update-account) in the Admin.
+
+Use a multiselect attribute when you need to store multiple simultaneous values for a single customer field — for example, eligible shipping methods, allowed sales channels, or subscription preferences. Unlike the [dropdown attribute](custom-dropdown-attribute.md), which stores a single selected option ID as an integer, a multiselect attribute stores a comma-separated list of option IDs as a `varchar` value, handled by the `ArrayBackend` backend model. This tutorial also implements `PatchRevertableInterface`, which allows the attribute to be cleanly removed by running `bin/magento setup:rollback`.


Broken internal link: custom-dropdown-attribute.md does not exist in this PR — the dropdown file is named custom-dropdown-field-attribute.md. This will resolve automatically if the file naming issue is fixed by removing -field- from all filenames.

Updated the internal link

thiaramus · 2026-04-23T20:57:07Z

+### Code reference
+
+```php
+<?php declare(strict_types=1);


<?php and declare(strict_types=1); must each be on their own line, consistently across the document.

Updated as per comment

thiaramus · 2026-04-23T20:57:07Z

+        $this->moduleDataSetup->getConnection()->endSetup();
+    }
+}
+```


File is missing a trailing newline character. This will cause a MD047/single-trailing-newline markdownlint failure in CI. Please add a newline after the closing code fence.

Added new line et the end of the php snippet

mtmmahi · 2026-04-24T13:54:46Z

Implemented all changes as per the comments

Co-authored-by: Thiaramus <thiaramus@icloud.com>

github-actions · 2026-05-19T13:01:56Z

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-05-19T12:57:22.435Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-php/commerce-php
Skipped Rules:
  - check-frontmatter → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 834

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/coding-standards/technical-guidelines.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 589:128
    Message: Unexpected dead URL `https://en.wikipedia.org/wiki/Universally_unique_identifier`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 677:46
    Message: Unexpected dead URL `https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/development/backward-incompatible-changes/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1041:49
    Message: Unexpected dead URL `https://www.php.net/manual/en/class.throwable.php`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 425:37
    Message: Unexpected dead URL `https://eat.magento.com/ui/phpFqn?searchKey=TWFnZW50b1xGcmFtZXdvcmtcQ29uc29sZVxDbGk6OmdldERlZmF1bHRDb21tYW5kcw==`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/tutorials/admin/custom-boolean-field-attribute.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 2:1
    Message: Title is too long (62 characters). Consider keeping it under 60 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/tutorials/admin/custom-dropdown-field-attribute.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 2:1
    Message: Title is too long (63 characters). Consider keeping it under 60 characters.
    Rule: check-frontmatter

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/tutorials/admin/custom-multiselect-field-attribute.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 2:1
    Message: Title is too long (66 characters). Consider keeping it under 60 characters.
    Rule: check-frontmatter


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    834
  📄 Files with issues:  5
  ❌ Total errors:       0
  ⚠️  Total warnings:     7
  📋 Total issues:       7

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

github-actions · 2026-05-19T19:57:17Z

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-05-19T19:52:55.102Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-php/commerce-php
Skipped Rules:
  - check-frontmatter → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 834

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/development/backward-incompatible-changes/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 1041:49
    Message: Unexpected dead URL `https://www.php.net/manual/en/class.throwable.php`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 425:37
    Message: Unexpected dead URL `https://eat.magento.com/ui/phpFqn?searchKey=TWFnZW50b1xGcmFtZXdvcmtcQ29uc29sZVxDbGk6OmdldERlZmF1bHRDb21tYW5kcw==`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/development/package/component.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 147:33
    Message: Unexpected dead URL `https://packagist.org/`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    834
  📄 Files with issues:  2
  ❌ Total errors:       0
  ⚠️  Total warnings:     3
  📋 Total issues:       3

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

Add missing newline at the end of the file.

github-actions · 2026-05-19T20:27:10Z

🔍 Linter Report

Click to expand full report

═══════════════════════════════════════════════════════════════
                     LINTER REPORT
═══════════════════════════════════════════════════════════════

Generated: 2026-05-19T20:22:19.193Z
Mode: Full Linting (all rules + dead links check)
Target Directory: /home/runner/work/commerce-php/commerce-php
Skipped Rules:
  - check-frontmatter → src/pages/includes

───────────────────────────────────────────────────────────────

Files to process: 834

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/best-practices/security/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 21:111
    Message: Unexpected dead URL `https://wiki.owasp.org/index.php/Guide_to_Cryptography#Hashes`, expected live URL
    Rule: no-dead-urls

  ⚠️  WARNING
    Location: Line 19:130
    Message: Unexpected dead URL `https://cheatsheetseries.owasp.org/cheatsheets/Injection_Prevention_Cheat_Sheet.html#scripting-languages`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/development/backward-incompatible-changes/index.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 425:37
    Message: Unexpected dead URL `https://eat.magento.com/ui/phpFqn?searchKey=TWFnZW50b1xGcmFtZXdvcmtcQ29uc29sZVxDbGk6OmdldERlZmF1bHRDb21tYW5kcw==`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/development/security/non-secure-functions.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 20:111
    Message: Unexpected dead URL `https://wiki.owasp.org/index.php/Guide_to_Cryptography#Hashes`, expected live URL
    Rule: no-dead-urls

───────────────────────────────────────────────────────────────
📄 FILE: src/pages/module-reference/module-customer-import-export.md
───────────────────────────────────────────────────────────────
  ⚠️  WARNING
    Location: Line 35:3
    Message: Unexpected dead URL `https://experienceleague.adobe.com/en/docs/commerce-admin/systems/data-transfer/data-export`, expected live URL
    Rule: no-dead-urls


═══════════════════════════════════════════════════════════════
                        SUMMARY
═══════════════════════════════════════════════════════════════

  📁 Files processed:    834
  📄 Files with issues:  4
  ❌ Total errors:       0
  ⚠️  Total warnings:     5
  📋 Total issues:       5

Result: ⚠️  PASSED WITH WARNINGS - No fatal errors

═══════════════════════════════════════════════════════════════

This comment was automatically generated by the linter bot.

Adding Customer Custom attributes creating document files

ddbf6da

dshevtsov added this to Commerce - Pull Requests Apr 23, 2026

github-project-automation Bot moved this to 📋 Needs Review in Commerce - Pull Requests Apr 23, 2026

mtmmahi closed this Apr 23, 2026

github-project-automation Bot moved this from 📋 Needs Review to 🏁 Done in Commerce - Pull Requests Apr 23, 2026

mtmmahi reopened this Apr 23, 2026

github-project-automation Bot moved this from 🏁 Done to 🧑‍💻 In Progress in Commerce - Pull Requests Apr 23, 2026

Added Table of content record

2b2997e

thiaramus suggested changes Apr 23, 2026

View reviewed changes

github-project-automation Bot moved this from 🧑‍💻 In Progress to 🛠 Changes Requested in Commerce - Pull Requests Apr 23, 2026

Implemented Reviewer suggestions

1ece9cc

thiaramus suggested changes Apr 24, 2026

View reviewed changes

Comment thread src/pages/tutorials/admin/custom-boolean-field-attribute.md

Comment thread src/pages/tutorials/admin/custom-boolean-field-attribute.md Outdated

Comment thread src/pages/tutorials/admin/custom-multiselect-field-attribute.md

mtmmahi and others added 3 commits April 27, 2026 18:38

Update src/pages/tutorials/admin/custom-boolean-field-attribute.md

5bcc8f3

Co-authored-by: Thiaramus <thiaramus@icloud.com>

Update src/pages/tutorials/admin/custom-boolean-field-attribute.md

225721a

Co-authored-by: Thiaramus <thiaramus@icloud.com>

Update src/pages/tutorials/admin/custom-multiselect-field-attribute.md

5e7ac9f

Co-authored-by: Thiaramus <thiaramus@icloud.com>

thiaramus approved these changes Apr 27, 2026

View reviewed changes

Implemented Editorial reviewer changes

81b8be1

meker12 approved these changes May 6, 2026

View reviewed changes

github-project-automation Bot moved this from 🛠 Changes Requested to 👍 Approved in Commerce - Pull Requests May 6, 2026

meker12 added 2 commits May 6, 2026 15:04

Merge branch 'main' into add-custom-attributes

0b39e9b

Merge branch 'main' into add-custom-attributes

de0d466

meker12 self-assigned this May 15, 2026

meker12 added technical Updates to the code or processes that alter the technical content of the doc new-topic A major update published as an entirely new document labels May 15, 2026

Merge branch 'main' into add-custom-attributes

b5c1441

meker12 enabled auto-merge May 15, 2026 17:35

Linter Report review changes implemented

dda43cd

auto-merge was automatically disabled May 19, 2026 16:45
Head branch was pushed to by a user without write access

Fix missing newline at end of custom multiselect field doc

d654060

Add missing newline at the end of the file.

meker12 merged commit 66f8b69 into AdobeDocs:main May 19, 2026
7 checks passed

github-project-automation Bot moved this from 👍 Approved to 🏁 Done in Commerce - Pull Requests May 19, 2026

		@@ -0,0 +1,419 @@
		---
		title: Add a Custom boolean Field Attribute \| Commerce PHP Extensions

		@@ -0,0 +1,412 @@
		---
		title: Add a Custom dropdown Field Attribute \| Commerce PHP Extensions


		![Custom attribute in the customer grid](../../images/tutorials/custom-attribute-customer-grid.png)

		To remove the attribute, run `bin/magento setup:rollback` and target this patch. The `revert()` method will execute and delete the attribute from the system.

		@@ -0,0 +1,416 @@
		---
		title: Add a Custom boolean Field Attribute \| Commerce PHP Extensions


		This tutorial describes how a developer can create a custom multiselect attribute for the Customer entity using code. This will reflect in both the [Customer Grid](https://experienceleague.adobe.com/en/docs/commerce-admin/customers/customer-accounts/manage/manage-account) and the [Customer Form](https://experienceleague.adobe.com/en/docs/commerce-admin/customers/customer-accounts/manage/update-account) in the Admin.

		Use a multiselect attribute when you need to store multiple simultaneous values for a single customer field — for example, eligible shipping methods, allowed sales channels, or subscription preferences. Unlike the [dropdown attribute](custom-dropdown-attribute.md), which stores a single selected option ID as an integer, a multiselect attribute stores a comma-separated list of option IDs as a `varchar` value, handled by the `ArrayBackend` backend model. This tutorial also implements `PatchRevertableInterface`, which allows the attribute to be cleanly removed by running `bin/magento setup:rollback`.

Conversation

mtmmahi commented Apr 23, 2026 • edited by meker12 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose of this pull request

Key Changes

New Topics & Documentation Pages

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mtmmahi commented Apr 24, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented May 19, 2026

🔍 Linter Report

Uh oh!

github-actions Bot commented May 19, 2026

🔍 Linter Report

Uh oh!

github-actions Bot commented May 19, 2026

🔍 Linter Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mtmmahi commented Apr 23, 2026 •

edited by meker12

Loading