Skip to content

What are the requirements in creating an osDXP Module?

What are the requirements in creating an osDXP Module?

As of the date of this FAQ, the osDXP Project is meeting to ratify the 1.0 Draft of osDXP Modules guidelines, as seen below. For an up-to the date version of current guidelines, the project is maintaining living documents on GitHub that will be helpful when determining if each module will be a fit...

osDXP Modules (Plugin) guidelines

  • Adhere to all WordPress Plugin Directory Guidelines & GPL Compliant Codebase
    Modules need to adhere to osDXP UX Standards.
  • Php 7.2 min. Version required
  • Detailed docblocks need to be present throughout your codebase
  • Valid codebase
    • Plugins must validate against an established ruleset for PHP and Javascript, passing linting tests against these rules.
    • PSR12 is the desired PHPCS ruleset to validate against, though:
    • If a plugin’s PHP is already standardized against the WordPress Coding Standards PHPCS rules, it may continue to do so for each DXP plugin release for the immediate future.
    • Javascript should validate against ES6, at a minimum.
  • No SaaS-ification of Client Data (because enterprises need to be in control of their data)
  • No Customer Data is saved on Vendors System (SaaS)
  • Clear data privacy standards
  • Accessibility declaration
  • Object Oriented/Class Based PHP

See how osDXP can help personalize your customer experience.