Adobe Magento DevDocs
  • Cloud
    Cloud basics
    • Cloud Guide
    • Cloud Architecture
    • Project Structure
    • Upgrades and Patches
    • Release Notes
    Cloud development
    • Local development
    • Configure and launch Docker
    • Docker quick reference
    • Configure Application
    • Configure Environments
    Functional Testing
    • Magento application testing
    • Magento Cloud code testing
  • Setup
    • Installation Guide
    • Magento Extensions Guide
    • Software Update Guide
    • Configuration Guide
    • Performance Best Practices
    • Migration Guide
    • Release Information
    • Command-line Tools Reference
  • Development
    Backend
    • Architecture
    • PHP Developer Guide
    • Extension Developer Best Practices
    • Module Reference Guide
    • Coding Standards
    • Contributor Guide
    Frontend
    • Frontend Developer Guide
    • UI Components Guide
    • JavaScript Developer Guide
    • Admin Design Pattern Library
    • Admin Style Guide
    • PWA Documentation Site
    • Page Builder Developer Guide
    API
    • Get Started with Magento Web APIs
    • REST API Reference
    • SOAP API Reference
    • GraphQL Developer Guide
    • Marketplace EQP API Reference
    • Business Intelligence API
  • Testing
    • Magento Testing Guide
    • Functional Acceptance Testing (MFTF)
    • Integration Testing
    • JavaScript Unit Testing
    • PHP Unit Testing
    • Web API Functional Testing
  • Functional Areas
    • Advanced Reporting
    • B2B
    • Checkout
    • Extensions Marketplace
    • Inventory Management
    • Order Management
    • Page Builder
    • Payment Integrations
    • Product Recommendations
    • Security and Compliance
    • Staging
  • Tutorials
    • Rest Tutorials
    • Customize Product Creation Form
    • Customize Checkout
    • Magento Support
    • Video Tutorials
  • Magento 2.3
  • Magento 2.4
Developer
  • Commerce Developer Documentation
  • PWA Studio
  • Order Management
Merchant
  • Commerce User Guide
  • Order Management
  • Business Intelligence

PHP Developer Guide

  • Introduction
    • Developer roadmap
    • Introduction to Composer
    • Glossary of common terms
  • Prepare (development quick start)
    • Component types
    • About component file structure
    • Extension repository structure
    • Roadmap for developing and packaging components
    • Extension lifecycle
  • Build
    • The di.xml file
    • Optimal development environment
    • The composer.json file
    • Define your configuration files
    • Create your component file structure
    • Register your component
    • URN schema validation
    • Name your component
    • Component load order
    • Enable or disable your component
  • Package
    • Package a component
    • Upload your component to the Magento Marketplace
  • Validate
    • Test your component
  • Partial caching
    • Create custom cache engines
    • Create a cache type
  • Full page caching
    • Public content
    • Private content
  • Add CLI commands
    • Command naming guidelines
    • How to add CLI commands
  • Staging (Magento Commerce only)
  • Component development
    • Asynchronous/deferred operations
    • Service contracts
    • Public interfaces & APIs
    • Service contract design patterns
    • Dependency injection
    • ObjectManager
    • Events and observers
    • Factories
    • Proxies
    • Code generation
    • EAV and extension attributes
    • Plugins (Interceptors)
    • Routing
    • Indexing
      • Indexing overview
      • Indexer optimization
      • Adding a custom indexer
    • Declarative schema
      • Declarative schema overview
      • Migrate install/upgrade scripts to declarative schema
      • Configure declarative schema
      • Develop data and schema patches
    • Web APIs
      • Configure services as web APIs
      • Set custom routes
      • WebApi request processors pool
    • Message Queues
      • Message queues overview
      • Message queues and stores
      • Configure message Queues
      • Handling outdated in-memory object states
      • Migrate message queue configuration
      • Bulk operations
      • Example bulk operations implementation
    • Adding extension attributes to entity
    • Adding an admin grid
    • Searching with repositories
    • Clear directories during development
    • Adapters
    • View models
    • Variable Pool
  • Configuration
    • Sensitive Environment Settings
    • Configuration Importers
  • Framework
    • Serialize Library
    • Array Manager
  • Security
    • XSS Prevention
    • Non-secure functions
    • Content Security Policies
  • Versioning
    • Check the Magento version
    • Module version dependencies
    • Codebase changes

Package

Edit on GitHub
Log an Issue

Use Composer to package your module.

  • Using Composer to package a Magento 2 module
  • Distribution on Magento Marketplace only. Upload your package to the Magento Marketplace
  • Become a Contributor
  • Glossary
  • Privacy Policy
  • Terms of Service
  • License/Trademark FAQ
  • Release Notes
  • Third-Party Licenses
© 2020 Magento. All rights reserved.