Skip to content

Maho - open source on-premises ecommerce platform

phpDoc code reference

Initializing search

MahoCommerce/maho

Home
User Guide
Developer Docs
Blog
Community
Marketplace
Sponsors

Maho - open source on-premises ecommerce platform

MahoCommerce/maho

Home
User Guide
User Guide
- Start here
- About
  About
- Catalog
  Catalog
- Customers & Marketing
  Customers & Marketing
- Storefront & Growth
  Storefront & Growth
Developer Docs
Developer Docs
- Getting started
- Migrate to Maho
- Security & SBOMs
- Hosting & Operations
  Hosting & Operations
- Developer Guide
  Developer Guide
  - Tutorial
    Tutorial
    
    Introduction
    
    Controller dispatch
    
    The Maho config
    
    Layouts, blocks and templates
    
    Models and ORM basics
    
    Setup resources
    
    Advanced ORM
    
    Data collections
  - Feature guides
    Feature guides
    
    JavaScript deferral
    
    Customer Segments
    
    Email Automation
    
    Gift Cards
  - Core & architecture
    Core & architecture
    
    Routing
    
    Event observers
    
    Override configs
    
    Rate limiting & honeypot
  - Database
    Database
    
    Database layer
    
    Declarative DB schema
  - Frontend & theming
    Frontend & theming
    
    Theme development
    
    Template directives
    
    Icons library
  - Utilities & tooling
    Utilities & tooling
    
    CLI tool
    
    Composer plugin
    
    Artificial Intelligence
    
    Date & time handling
    
    Language packs
    
    Array Import Adapter
- REST & GraphQL API (beta)
  REST & GraphQL API (beta)
- Legacy API
  Legacy API
  - REST API
    REST API
    
    Introduction
    
    Common HTTP status codes
    
    HTTP methods
    
    GET Filters
    
    Response formats
    
    Testing
    
    Authentication
    Authentication
    
    OAuth authentication
    
    OAuth configuration
    
    Permission settings
    Permission settings
    
    Introduction
    
    Roles configuration
    
    Attributes configuration
    
    Attributes description
    
    Extending REST API
  - SOAP API
    SOAP API
    
    Introduction
    
    Catalog Category
    
    Catalog Category Attribute
    
    Catalog Product
    Catalog Product
    
    Product
    
    Product Attribute
    
    Product Attribute Media
    
    Product Attribute Set
    
    Product Custom Option
    
    Product Custom Option Value
    
    Product Downloadable Link
    
    Product Link
    
    Product Tag
    
    Product Tier Price
    
    Product Types
    
    Catalog Inventory
    
    Checkout Cart
    Checkout Cart
    
    Checkout Cart
    
    Checkout Cart Coupon
    
    Checkout Cart Customer
    
    Checkout Cart Payment
    
    Checkout Cart Product
    
    Checkout Cart Shipping
    
    Customer
    Customer
    
    Customer
    
    Customer Group
    
    Customer Address
    
    Directory
    
    Store
    
    Sales Order
    Sales Order
    
    Order
    
    Credit Memo
    
    Invoice
    
    Shipment
- Code Reference
  Code Reference
  - phpDoc code reference
  - DeepWiki AI docs
Blog
Blog
- Blog
- Archive
  Archive
  - 2026
  - 2025
  - 2024
- Categories
  Categories
Community
Community
- Get Involved
- Community projects
  Community projects
  - Docker Starter
Marketplace
Sponsors

phpDoc Code Reference

A comprehensive PHP code reference in phpDoc format is available at https://phpdoc.mahocommerce.com

About Maho

A robust, modern, and lean open‑source on‑premises ecommerce platform built for the future of your business.

Stay Updated

Get release announcements and project news.