

Module Guidelines

Developers working on osDXP modules should follow the guidelines listed below

• Plugins should register only one settings page, available as a subpage of Module Settings

• GPL Compliant Codebase

• Php 7.4 minimum version compatibility

• Detailed docblocks need to be present throughout your codebase

• Plugins must validate against an established ruleset for PHP and meet ES6 standards for JavaScript, passing linting tests against these rules.

  • The preferred PHPCS ruleset is a custom one made up of PSR12 and some necessary checks for WordPress security, sanitization, and prevention of deprecated code.

  • Javascript should validate against ES6, at a minimum.

• No SaaS-ification of Client Data (No Customer Data is saved on Vendors System)

• Clear data privacy standards

• Accessibility declaration

• Object Oriented/Class Based PHP.

• Follow osDXP UX Standards

• No "AdWare" (promotional popups, admin notices, or other text taking up screen space)