Documentation
Documentation
Documentation
Table of Contents
Packages
Classes
- Graphic_Data_Admin
- The admin-specific functionality of the plugin.
- Graphic_Data_Create_SVG
- Register class that defines Create SVG functions
- Graphic_Data_Export_Figures
- Class Graphic_Data_Export_Figures
- Graphic_Data_GitHub_Updater
- GitHub Updater - Optimized Version
- Graphic_Data_Support
- The code for creating the "Graphic Data Support" menu item and page in the plugin.
- Graphic_Data_SVG_Validator
- Enhanced SVG validation for WordPress plugin
- Graphic_Data_Login
- Register class that has the functions used to modify the login WordPress scene
- Graphic_Data_Custom_Roles
- Manages custom user roles and role-based access control for the Graphic Data Plugin.
- Graphic_Data_Utility
- Utility functions used across the plugin
- Graphic_Data_Validation
- Handles validation of custom post type fields before saving.
- Graphic_Data_About
- Register class that defines the About custom content post type as well as associated functions.
- Graphic_Data_Figure
- Handles the Figure custom post type for the Graphic Data plugin.
- Graphic_Data_Instance_Type
- Register class that defines the Instance Type functions
- Graphic_Data_Instance
- Registers the Instance custom post type and manages its admin interface.
- Graphic_Data_Loader
- Register all actions and filters for the plugin.
- Graphic_Data_Modal
- Manages the Modal custom post type and its admin interface.
- Graphic_Data_Scene
- Manages the Scene custom post type and its admin interface.
- Graphic_Data_Settings_Page
- Handles the admin settings page for the Graphic Data plugin.
- Graphic_Data_Tutorial_Content
- Class Graphic_Data_Tutorial_Content
- Graphic_Data_Plugin
- The core plugin class.
Constants
- GRAPHIC_DATA_DATA_DIR = \WP_CONTENT_DIR . '/data'
- The data directory inside of wp-content
- GRAPHIC_DATA_DATA_URL = \content_url('data')
- GRAPHIC_DATA_PLUGIN_DIR = \plugin_dir_path(__FILE__)
- The directory path of the plugin.
- GRAPHIC_DATA_PLUGIN_VERSION = $graphic_data_plugin_data['Version']
Functions
- graphic_data_activate() : mixed
- Plugin activation callback.
- graphic_data_ensure_public_data_dir() : void
- Ensure the public data directory exists with correct permissions.
- graphic_data_plugin_run() : mixed
- Begins execution of the plugin.
Constants
GRAPHIC_DATA_DATA_DIR
The data directory inside of wp-content
public
mixed
GRAPHIC_DATA_DATA_DIR
= \WP_CONTENT_DIR . '/data'
GRAPHIC_DATA_DATA_URL
public
mixed
GRAPHIC_DATA_DATA_URL
= \content_url('data')
GRAPHIC_DATA_PLUGIN_DIR
The directory path of the plugin.
public
mixed
GRAPHIC_DATA_PLUGIN_DIR
= \plugin_dir_path(__FILE__)
GRAPHIC_DATA_PLUGIN_VERSION
public
mixed
GRAPHIC_DATA_PLUGIN_VERSION
= $graphic_data_plugin_data['Version']
Functions
graphic_data_activate()
Plugin activation callback.
graphic_data_activate() : mixed
Ensures the public data directory exists when the plugin is activated.
Tags
graphic_data_ensure_public_data_dir()
Ensure the public data directory exists with correct permissions.
graphic_data_ensure_public_data_dir() : void
Creates GRAPHIC_DATA_DATA_DIR if it does not already exist, sets directory permissions to 0755, and drops an index.php guard file to prevent directory browsing while still allowing direct file access.
On failure the error is persisted to the 'graphic_data_data_dir_error' option so it can be surfaced via admin notices; on success that option is deleted.
Tags
graphic_data_plugin_run()
Begins execution of the plugin.
graphic_data_plugin_run() : mixed
Since everything within the plugin is registered via hooks, then kicking off the plugin from this point in the file does not affect the page life cycle.