README

Saltus Framework helps you develop WordPress plugins that are based on Custom Post Types.

We built it to make things easier and faster for developers with different skills. Add metaboxes, settings pages and other enhancements with just a few lines of code.

Visit saltus.dev for more information.

Version

Current version [1.3.5] - 2026-06-20

See change log file for full details.

Features

* Create Custom Post Types easily
* Control all labels and messages
* Add administration columns
* Add administration lists
* Add settings pages
* Add metaboxes
* Enable cloning
* Enable single entry export
* Enable drag&drop reordering
* Create Taxonomies easily
* Control labels
* Associate with any existing post type
* Add quick edit fields

Requirements

Saltus Framework requires PHP 7.4+

Installation

Install the framework in your plugin with Composer:

composer require saltus/framework

Getting Started

Demo

Refer to the Framework Demo for a complete plugin example and to the Wiki for complete documentation.

Once the framework is installed and Composer's autoloader is loaded by your plugin, you can initialize it the following way:

    $autoload = __DIR__ . '/vendor/autoload.php';
    if ( is_readable( $autoload ) ) {
      require_once $autoload;
    }

    if ( class_exists( \Saltus\WP\Framework\Core::class ) ) {

      /*
      * The path to the plugin root directory is mandatory,
      * so it loads the models from a subdirectory.
      */
      $framework = new \Saltus\WP\Framework\Core( dirname( __FILE__ ) );
      $framework->register();

      /**
       * Initialize plugin after this
       */

    }

The framework will search for a model file, by default in the folder src/models. This can be changed using a filter.

A model file should return one array or a multidimensional array of models to build the Custom Post Types or Taxonomies. Simple example:

    return [
        'type'     => 'cpt',
        'name'     => 'movie',
    ];

The above example will create a Custom Post Type 'movie'.

Several models in same file:

    return [
    [
        'type'     => 'cpt',
        'name'     => 'movie',
    ],
    [
            'type'         => 'category',
            'name'         => 'genre',
            'associations' => [
                ‘movie’,
            ],
        ],
    ];

The above example will create a Custom Post Type 'movie' and a hierarchical Taxonomy 'genre' associated with the Custom Post Type 'movie'.

Models

Currently there are 2 types of Model, one for Custom Post Types and another for Taxonomies. Depending what you define, you’ll have different parameters available.

Model type = ‘cpt’

Example File for a CPT Model (Soon)

Model type = ‘category’ or ‘tag’

Example File for a Taxonomy Model (Soon)

Filters/Hooks

Saltus Framework provides several hooks to customize its behavior.

Actions

Filters

Credits and Licenses:

Includes a simplified version of SoberWP/Models. Their license is in lib/sobwewp/models/LICENSE.md. Is used to load php/json/yaml models of CPT.

Includes the Codestart Framework which is licensed under GPL.

Patching Codestar Framework

Every time the Codestar Framework is updated, our custom fixes may be overwritten. To re-apply the patches located in lib/codestar-framework/patches, run the following command from the repository root:

for f in lib/codestar-framework/patches/*; do git apply "$f"; done

Includes support for github-updater to keep track on updates through the WordPress backend.

• Download github-updater
• Clone github-updater to your sites plugins/ folder
• Activate via WordPress

Building

Disadvantages of classmap

As we move from 'files' to 'classmap', heed this:

Manual Updates: If you add new classes, you must regenerate the classmap by running composer dump-autoload.