Skip to content

Latest commit

 

History

History
131 lines (95 loc) · 4.55 KB

README.md

File metadata and controls

131 lines (95 loc) · 4.55 KB
Raw

Saltus Framework

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.

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

Requirements

Saltus Framework requires PHP 7.0+

Getting Started

Demo

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

Once the framework is included in your plugin, you can initialize it the following way:

    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’

Parameter Description
active boolean - sets this model to active or inactive
type string - type of model
name string - identifier of the custom post type
features array - Features that this CPT will support (More Info Soon)
supports array - refer to the supports argument of the register_post_type function from WordPress
labels array - Everything related with labels for this custom post type (More Info Soon)
options array - Refer to the second argument in the register_post_type function from WordPress
block_editor boolean - if the Block Editor should be enabled or not
meta array - Information for the Metaboxes for this CPT (More Info Soon)
settings array - Information for the Settings page of this CPT (More Info Soon)

Example File for a CPT Model (Soon)

Model type = ‘category’ or ‘tag’

Parameter Description
type string - ‘category’ // or 'tag' to set it to non-hierarchical automatically
name string - identifier of this taxonomy
associations string - to what CPT it should be associated
labels array - Everything related with labels for this custom post type (More Info Soon)
options array - Refer to the third parameter for register_taxonomy function from WordPress

Example File for a Taxonomy Model (Soon)

Filters/Hooks

(More Info Soon)

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.

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