| Property | Type | Description | |
|---|---|---|---|
| $active | boolean | True if the module is active | |
| $dependencies_met_cb | callback | Contains registered callback to determine if a modules dependencies are met | |
| $module_box_long_cb | callback | Contains registered callback to output module long description in module box | |
| $module_box_summary_cb | callback | Contains registered callback to output module summary in module box | |
| $post_activation_cb | callback | Contains registered callback to execute after activation | |
| $requires_install_reindex | [type] | True if the module requires content reindexing after activating | |
| $setup_cb | callback | Contains registered callback to execute after setup | |
| $slug | string | Module slug | |
| $title | string | Module pretty title |
| Method | Description | |
|---|---|---|
| __construct ( $args ) | Initiate the module, setting all relevant instance variables | |
| dependencies_met ( ) : boolean | WP_Error | Ran to see if dependencies are met. Returns true or a WP_Error containing an error message to display | |
| is_active ( ) : boolean | Returns true if the module is active | |
| output_module_box ( ) | Outputs module box | |
| output_module_box_full ( ) | Outputs module box long description | |
| post_activation ( ) | Ran after a module is activated | |
| setup ( ) | Ran after a function is activated |
| public __construct ( $args ) |
| public dependencies_met ( ) : boolean | WP_Error | ||
| return | boolean | WP_Error | |
| public output_module_box_full ( ) |
| public callback $dependencies_met_cb | ||
| return | callback | |
| public callback $module_box_long_cb | ||
| return | callback | |
| public callback $module_box_summary_cb | ||
| return | callback | |
| public callback $post_activation_cb | ||
| return | callback | |
| public [type] $requires_install_reindex | ||
| return | [type] | |
| public callback $setup_cb | ||
| return | callback | |