Options - dotherightthing/wpdtrt-plugin-boilerplate GitHub Wiki

Summary

DTRT WordPress Plugin Boilerplate uses a configuration array, separated into several different option types.

Status

• Stable @ 1.3.2
• Option merging may be problematic with old data is used, use unset() to remove unwanted persistent array keys
• Needs further documentation

---

Option types

Various options are stored in a single, multidimensional $options array, which is saved to the WordPress Options table.

Plugin options

$options['plugin_options']

• What: Global options available anywhere in the Plugin
• Format: An array of options, each describing a form input for data collection and display
• Defaults: Set in wpdrt-pluginname.php
• Updates: Updated via user input on plugin options page
• See: Options: Add a global option

Plugin dependencies

$options['plugin_dependencies']

• What: WordPress plugin dependencies required by the Plugin
• Format: An array of TGMPA dependencies, each describing a source repository
• Defaults: Set in wpdrt-pluginname.php (config object)
• Updates: Set in class-wpdtrt-plugin-boilerplatename-plugin (set_plugin_dependency() in wp_setup())
• See: Options: Add a WordPress plugin dependency

Instance Options

$options['instance_options']

• What: Widget & Shortcode options
• Format: An array of options, each describing a form input for data collection and display
• Defaults: Set in wpdrt-pluginname.php
• Updates: Updated via user input on widget screen, and coded shortcode options
• See: Options: Add a shortcode or widget option

Plugin data

$options['plugin_data']

• What: API response
• Format: JSON
• Defaults: Set in class-wpdtrt-plugin-boilerplatename-plugin (get_api_data())
• Updates: Updated via repeat calls to the API after a timeout (via options page)
• See: -

Plugin data options

$options['plugin_data_options']

• What: meta data attached to the plugin data, to determine refresh frequency
• Format: An array containing two options: last_updated and force_refresh
• Defaults: -
• Updates: TODO - Via options page?
• See: -