Index | WordPress Plugin Framework

A

Action_Scheduler_Page_Module — Class in namespace WPPF\v1_2_2\Admin: Manage the settings for for this plugin.
Admin_Notice_Module — Class in namespace WPPF\v1_2_2\Admin: This module holds the logic for saving our admin notices as transients and displaying them on an admin page load.
Action_Scheduler_Page — Class in namespace WPPF\v1_2_2\Admin\Screens: The options page configuration for general settings regarding the modules included in this plugin.
Admin_Module — Class in namespace WPPF\v1_2_2\Framework: A class to represent and help deal with common plugin admin functionality.
Autoloader — Class in namespace WPPF\v1_2_2\Framework: Autoloader class for managing multiple SPL autoload directories
Autoloader::add_module_directory() — Method in class Autoloader: Read a module directory and cache class file locations.
$ Framework#autoloader — Property in class Framework
Utility::assoc_array_splice() — Method in class Utility: Splices a given $input using normal array_splice functionality, but preserving associative array key values in $replacments.
Action_Scheduler — Class in namespace WPPF\v1_2_2\Plugin: A class to manage the WPPF Action Scheduler solution.
Action — Class in namespace WPPF\v1_2_2\Plugin\Action_Scheduler: A class to represent a callable Action assigned to a Timer and all of it's properties.
$ Action#action — Property in class Action
Form_Builder::add_timer_class() — Method in class Form_Builder: Register a Timer with the Form Builder.
$ Timer#Actions — Property in class Timer
$ Timer#actions_data — Property in class Timer
Timer::add_action() — Method in class Timer: Add an Action to the Timer instance, optionally update the Action and { $this->action_data } if it already exists.
Staging_Detection_Notice::add_notice() — Method in class Staging_Detection_Notice: Add a notice message to the Queue.
$ Upgrader_Schema#actions — Property in class Upgrader_Schema
Upgrader_Schema::add_action() — Method in class Upgrader_Schema: Add an action to the Schema.
WC_Tab_Navigator::add_tab() — Method in class WC_Tab_Navigator: Add a tab to the navigator.
Admin_Notice — Class in namespace WPPF\v1_2_2\WordPress\Admin: A class intended to provide application notifications to the admin users. Built off transients to be one-time use.
Admin_Notice_Queue — Class in namespace WPPF\v1_2_2\WordPress\Admin: Utility functions class to hold useful chunks of code we find ourselves often reusing.
Admin_Notice_Queue::add_notice() — Method in class Admin_Notice_Queue: Add an Admin Notice to the global queue.
Admin_Notices — Class in namespace WPPF\v1_2_2\WordPress\Admin: Utility functions class to hold useful chunks of code we find ourselves often reusing.
Admin_Notices::add_notice() — Method in class Admin_Notices: Add an Admin Notice to the global queue.
Meta_Box::add_meta_box() — Method in class Meta_Box: Add the Meta Box to the WordPress environment.
Management_Page::add_menu_item() — Method in class Management_Page: The inherited, abstract menu item function.
Options_Page::add_menu_item() — Method in class Options_Page: The inherited, abstract menu item function.
Options_Page::add_section() — Method in class Options_Page: Register a section with this Page.
Page::add_menu_item() — Method in class Page: The function which will be called to add the page to the menu.
Post_Screens::add_post() — Method in class Post_Screens: The function that hooks when adding a new Post of the static post type.
Admin_Module — Class in namespace WPPF\v1_2_2\WordPress: This Module is not a Module which is necessarily loaded only when TRUE === is_admin(), rather this namespace simply holds all of the administrative abstractions for WordPress.
$ Meta_Schema#args — Property in class Meta_Schema
$ Plugin#admin_module — Property in class Plugin
Plugin::activation() — Method in class Plugin: A default, empty function to run on plugin activation.
Post::add_meta() — Method in class Post: Add a Post Meta to this Post.
$ Post_Type#args — Property in class Post_Type
Post_Type::add_meta_box() — Method in class Post_Type: Add a Meta Box to this Post Type if it is not already added.

B

Utility::boundary_replace() — Method in class Utility: Replace all word boundaries with a single character.

C

Action_Scheduler_Page_Module::construct() — Method in class Action_Scheduler_Page_Module: Add WordPress hooks, set Page instance.
Admin_Notice_Module::construct() — Method in class Admin_Notice_Module: Module entry point.
WPPF_Settings_Page_Module::construct() — Method in class WPPF_Settings_Page_Module: Add WordPress hooks, set Settings Page instance.
$ Autoloader#class_map — Property in class Autoloader
Module::construct() — Method in class Module: An empty, placeholder function for overriding, this is where the module "starts" it's WordPress code.
Module::construct_submodules() — Method in class Module: Loop through all loaded modules and run their initialization functions.
Utility::class_basename() — Method in class Utility: The basename function, except for classes; returns the name component of a fully-qualified class with namespace. Credit to markus-perl at https://coderwall.com/p/cpxxxw/php-get-class-name-without-namespace
Action_Scheduler::construct() — Method in class Action_Scheduler: Entry point.
$ Action#callable_args — Property in class Action
Cron_Manager — Class in namespace WPPF\v1_2_2\Plugin\Action_Scheduler: A class to manage the WP Cron associated with the Action Scheduler and how ofter to check for timers to run.
Cron_Manager::check_cron_timer() — Method in class Cron_Manager: Checks is the cron timer is created and creates it if it is not.
Interval_Timer::count_runnable_contexts() — Method in class Interval_Timer: Count how many times the Interval Timer should have run between now and the last time it ran.
Staging_Detection::construct() — Method in class Staging_Detection: Module entry point.
Staging_Detection_Notice::construct() — Method in class Staging_Detection_Notice: Module entry point.
$ Meta_Box#context — Property in class Meta_Box
Meta_Box::create_input_name() — Method in class Meta_Box: Get the HTML name attribute prefix for grouping data inputs in this meta box.
Screens::construct_screen() — Method in class Screens: The primary entry function for running code globally in the admin area. This code will run with regular Module constructions.
Screens::current_screen() — Method in class Screens: The primary entry function for running code locally in the screen. This code will run in the 'current_screen' WordPress hook.
Screens::construct() — Method in class Screens: The primary entry point for the Admin Module to call when registering this Screen.
Meta_Schema::create_error_message() — Method in class Meta_Schema: Return an HTML list of validation errors.

D

Utility::debug_backtrace() — Method in class Utility: Print a minimized debug backtrace.
Utility::doing_it_wrong() — Method in class Utility: Our own, non-private version of _doing_it_wrong(), credit to https://wordpress.stackexchange.com/questions/238672/what-is-an-alternative-method-to-the-wordpress-private-doing-it-wrong-functio
Action::do() — Method in class Action: Do the action callable. Do the roar.
Timer_Manager::delete_timer() — Method in class Timer_Manager: Attempt to delete a timer from the database.
$ Settings_Section#description — Property in class Settings_Section
$ Meta#data — Property in class Meta
Plugin::deactivation() — Method in class Plugin: A default, empty function to run on plugin deactivation.
Plugin::deactivate() — Method in class Plugin: Force deactivate this Plugin by updating the WordPress options. There was an 'activate' function, but you must require the Plugin file before using the class anyway.

E

$ Module#enabled — Property in class Module
Utility::export_alias_object_properties() — Method in class Utility: A function to export object/associative array values to an associative array with matching key/value pairs and alias/value pairs.
Form_Builder::enqueue_form_builder_scripts() — Method in class Form_Builder: Enqueue the scripts and styles for the form builder.
Interval_Timer::export_array() — Method in class Interval_Timer: The inherited abstract for exporting the properties created by this class.
Simple_Timer::export_array() — Method in class Simple_Timer: The inherited abstract for exporting the properties created by this class.
Timer::export_array() — Method in class Timer: Abstract function to cover the exporting of properties of super classes in { $this->to_array() }
Plugin_Upgrader_Trait::execute_schemas() — Method in class Plugin_Upgrader_Trait: Loop through and execute all Schema actions.
Email — Class in namespace WPPF\v1_2_2\WooCommerce: An abstract class for mandating essential parts of the \WC_Email, and implementing email set-up and sending.
Email::email_id() — Method in class Email: Abstract: mandate email ID field.
Email::email_title() — Method in class Email: Abstract: mandate email method title field (appears in WC settings).
Email::email_description() — Method in class Email: Abstract: mandate email description field (appears in WC settings)
Email::email_heading() — Method in class Email: Abstract: mandate email heading field.
Email::email_subject() — Method in class Email: Abstract: mandate email subject field.
Email::email_html_template() — Method in class Email: Abstract: mandate email HTML template field.
Email_Traits — Class in namespace WPPF\v1_2_2\WooCommerce: A trait to expand the capabilities of the WooCommerce_Plugin to include email-related functionality.
WC_Tab_Navigator::enqueue_navigator_script() — Method in class WC_Tab_Navigator: Check whether the WPPF WC Tab Navigator scripts have been enqueued and maybe enqueue them.
Admin_Notices::error() — Method in class Admin_Notices: A function to queue an error warning admin notice.
Meta::export() — Method in class Meta: Create a data structure that should be saved in it's own format in the database.
Plugin::enqueue_js() — Method in class Plugin: Enqueue a script from the assets folder.
Plugin::enqueue_css() — Method in class Plugin: Enqueue a stylesheet from the assets folder.
Post_Type::export_args() — Method in class Post_Type: Return the Post Type options and the merged labels.
Post_Type::export_labels() — Method in class Post_Type: Return the array reperesentation of labels with all the data associated with registering a Post Type.

F

Framework — Class in namespace WPPF\v1_2_2\Framework: The wrappper class for a proprietary set of code which seeks to facilitate WordPress development and encourage use of the documented coding standards.
Framework_Module — Class in namespace WPPF\v1_2_2: This Module is for holding framework abstractions.
Form_Builder — Class in namespace WPPF\v1_2_2\Plugin\Action_Scheduler: A class to automate the creation of timers through form submissions.

G

Framework::get_version() — Method in class Framework: Return the current framework verion.
Framework::get_autoloader() — Method in class Framework: Return the WPPF\v1_2_2\Autoloader instance.
Module::get_loaded_modules() — Method in class Module: Get the currently loaded modules.
Singleton::get_instances() — Method in class Singleton: Return a copy of the instances array.
Singleton::get_class_reflection() — Method in class Singleton: A short one-liner tool to get a ReflectionClass so we can get runtime info for the static class instance and not this abstract.
Utility::get_namespace_version() — Method in class Utility: Extract a version token from a class or namespace string.
Utility::guided_array_merge() — Method in class Utility: Takes a 'guide' array, the keys of which are used to search subsequent arrays for values to merge in.
Utility::get_file_namespace() — Method in class Utility: Open a file and read out the namespace. Credit to https://stackoverflow.com/questions/4512398/php-get-namespace-of-included-file.
Utility::get_file_class_name() — Method in class Utility: Open a PHP file and return the first class/interface/trait name found.
Form_Builder::get_timer_classes() — Method in class Form_Builder: Return the registered Timer classes.
Form_Builder::get_form() — Method in class Form_Builder: Get a submitted Timer form or return NULL if it does not exist.
Form_Builder::generate_timer_from_form() — Method in class Form_Builder: Takes the name of a timer form submitted and the desired timer ID and creates a new Timer instance from it.
Form_Builder::generate_form_input_name() — Method in class Form_Builder: A function to generate a name for form inputs.
Interval_Timer::get_interval_types() — Method in class Interval_Timer: Get the interval types.
Interval_Timer::get_next_run() — Method in class Interval_Timer: Return the \DateTime instance that represents the next time the Interval Timer is supposed to be run.
Interval_Timer::get_interval_value() — Method in class Interval_Timer: Get the value in seconds of the interval type of this Interval Timer.
Interval_Timer::get_start_datetime() — Method in class Interval_Timer: Return a DateTime instance of the initial start time for this Interval Timer.
Simple_Timer::get_interval_types() — Method in class Simple_Timer: Get the interval types.
Simple_Timer::get_next_run() — Method in class Simple_Timer: Return the \DateTime instance that represents the next time the Interval Timer is supposed to be run.
Simple_Timer::get_interval_value() — Method in class Simple_Timer: Get the value in seconds of the interval type of this Interval Timer.
Timer::get_next_run() — Method in class Timer: Abstract function which returns a timestamp of when the last run of Actions is/was supposed to be. This allows timers to implement their own system for deciding the timer sequence without being bound to a static interval.
Timer::get_created() — Method in class Timer: Get the creation DateTime in GMT.
Timer::get_last_run() — Method in class Timer: Get the last run time. Returns in GMT.
Timer::get_actions() — Method in class Timer: Get the Actions.
Timer::get_action() — Method in class Timer: Return an Action instance from this Timer, if it exists, else return NULL.
Timer_Manager::get_timers() — Method in class Timer_Manager: Return all Timers instances from the database in an associative list of their IDs.
Timer_Manager::get_timer() — Method in class Timer_Manager: Find a Timer instance and return it, or NULL if not found.
Upgrader_Schema::get_version() — Method in class Upgrader_Schema: Abstract function to return the version coresponding to the upgrade schema.
Upgrader_Schema::get_actions() — Method in class Upgrader_Schema: Return the Schema actions.
Email::get_content_html() — Method in class Email: Get content html using WooCommerce template functions.
WC_Tab_Navigator::get_tabs() — Method in class WC_Tab_Navigator: Get the tabs belonging to the Navigator instance.
Meta_Box::get_id() — Method in class Meta_Box: Return the ID of the Meta Box (used in the "id" attribute, says WordPress docs, i.e. the "id" attribute in the HTML DOM for Javascript events).
Meta_Box::get_title() — Method in class Meta_Box: The title of the Meta Box.
Meta_Box::get_nonce() — Method in class Meta_Box: A generated nonce for super class forms.
Meta_Box::get_nonce_action() — Method in class Meta_Box: A generated nonce action for super class forms.
Meta_Box::get_post_data() — Method in class Meta_Box: Return the expected input data from the POST data.
Page::get_sections() — Method in class Page: Return the Sections associated with this Settings Page.
Settings_Field::get_field_name() — Method in class Settings_Field: Create a reusable Field ID.
Settings_Field::get_input_name() — Method in class Settings_Field: Create a reusable input ID.
Settings_Section::get_settings_page() — Method in class Settings_Section: Return the Settings Page instance.
Settings_Section::get_settings_fields() — Method in class Settings_Section: Return the Settings Field instances.
Settings_Section::get_section_name() — Method in class Settings_Section: Create a reusable section ID.
Settings_Section::get_section_option_name() — Method in class Settings_Section: Generate the key to be used in the options table in the database.
Screens::get_valid_screens() — Method in class Screens: Return a set of nested associative arrays which define the screens for which code should run.
Screens::get_current_screen_callback() — Method in class Screens: Returns the callback function associated with the current screen in this class. Otherwise, if not on a valid screen, returns FALSE.
Post_Screens::get_valid_screens() — Method in class Post_Screens: The required abstract inherited function for returning screen actions.
Meta::get_schema() — Method in class Meta: Return the Meta schema.
Meta::get_data() — Method in class Meta: Get the meta data of this instance.
Meta_Schema::generate_default() — Method in class Meta_Schema: Generate a default set of data based of of the Schema.
Plugin::get_admin_module() — Method in class Plugin: Get the Admin Module.
Plugin::get_template() — Method in class Plugin: A function to retrieve a template file from the templates directory.
Plugin::get_plugin_file() — Method in class Plugin: Return the file location of the Plugin instance.
Plugin::get_plugin_id() — Method in class Plugin: Return the Plugin site ID, which should be the plugin folder name and the name of the PHP file.
Post::get_post() — Method in class Post: Returns the parent WP_Post object.
Post::get_ID() — Method in class Post: Returns the ID of the parent WP_Post.
Post::get_title() — Method in class Post: Returns the title of the parent WP_Post.
Post::get_meta() — Method in class Post: Returns the Post meta.
Post_Meta::get_post() — Method in class Post_Meta: Return the Post.
Post_Type::get_all_posts() — Method in class Post_Type: Get all Posts with this post type.

H

Timer::has_action() — Method in class Timer: Check whether an action exists in { $this->action_data }.

I

$ Admin_Module#includes — Property in class Admin_Module
$ Module#is_submodule — Property in class Module
$ Module#includes_dir — Property in class Module
$ Module#includes — Property in class Module
Module::import_module() — Method in class Module: Given a Module class name and a file path, loads the file into the PHP environment, then checks to make sure the given class extends Module and adds it to { $this->loaded_modules }
Singleton::instance() — Method in class Singleton: Maybe initialize singleton instance and return the instance.
$ Action#id — Property in class Action
Interval_Timer — Class in namespace WPPF\v1_2_2\Plugin\Action_Scheduler: A Timer instance that bases it's run times off of even intervals from a specified start times. It can also return how many missed intervals a Timer may potentially have.
$ Interval_Timer#interval — Property in class Interval_Timer
$ Simple_Timer#interval — Property in class Simple_Timer
$ Timer#id — Property in class Timer
Timer::instantiate_timer() — Method in class Timer: Attempt to create a Timer super class instance using the 'timer_class' property associated with the Timer.
Plugin_Upgrader_Trait::init_upgrader() — Method in class Plugin_Upgrader_Trait: Check if the Upgraders need to be run, then run them and update the current version if so.
Staging_Detection::is_staging() — Method in class Staging_Detection: Whether or not the site host is detected to be a staging host.
Admin_Notice::is_admin_notice() — Method in class Admin_Notice: Check whether a variable is an Admin Notice.
Admin_Notices::info() — Method in class Admin_Notices: A function to queue an info admin notice.
$ Settings_Section#inputs — Property in class Settings_Section
Screens::is_current_screen() — Method in class Screens: Iterates through the current screen 'base', 'id', and 'action' sequentially through the valid screens of this class and returns TRUE if they match, otherwise FALSE.
Meta::import() — Method in class Meta: Set properties of the class based on an associative array.

K

$ Settings_Field#key — Property in class Settings_Field
Meta::key() — Method in class Meta: The meta key used in the database.

L

$ Admin_Module#loaded_screens — Property in class Admin_Module
$ Module#loaded_modules — Property in class Module
Module::load_class_file() — Method in class Module: Load a class from a file and return the full class name.
$ Timer#last_run — Property in class Timer
Email_Traits::load_emails() — Method in class Email_Traits: Load the WC Email files.
$ Settings_Field#label — Property in class Settings_Field
$ Settings_Section#label — Property in class Settings_Section
Settings_Section::load_option() — Method in class Settings_Section: Load and return the option associated with this section.
Meta::load() — Method in class Meta: The function used to load meta data from the database.
$ Plugin#loaded_post_types — Property in class Plugin
Post_Meta::load() — Method in class Post_Meta: The required abstract loading function.
User_Meta::load() — Method in class User_Meta: The required abstract loading function.

M

Action_Scheduler_Page::menu_title() — Method in class Action_Scheduler_Page
WPPF_Settings_Page::menu_title() — Method in class WPPF_Settings_Page
Module — Class in namespace WPPF\v1_2_2\Framework: A class to represent crucial project file system structures and bind their PHP functionalities to WordPress.
$ Module#modules_dir — Property in class Module
$ Interval_Timer#multiplier — Property in class Interval_Timer
$ Simple_Timer#multiplier — Property in class Simple_Timer
Timer::maybe_run_timer() — Method in class Timer: Check if the Timers next run time is past and fire the run function if it is.
Timer::merge_actions() — Method in class Timer: Merge Actions from another Timer instance into this instance.
$ Admin_Notice#message — Property in class Admin_Notice: The message this Notice should display.
Meta_Box — Class in namespace WPPF\v1_2_2\WordPress\Admin: A manager for Meta Boxes that appear on admin edit pages. Manages the form rendering and post save hooking processes.
Meta_Box::meta_key() — Method in class Meta_Box: A meta key to use when saving the Post Meta to the database. Should be lowercase and underscored.
Management_Page — Class in namespace WPPF\v1_2_2\WordPress\Admin\Pages: A class to abstract and automate the process of creating a page under the 'tools' menu item.
Page::menu_title() — Method in class Page: The menu name/title for display.
Page::menu_item_exists() — Method in class Page: See if the Settings Page exists in the WP global $submenu.
Meta — Class in namespace WPPF\v1_2_2\WordPress: An abstract class for other abstract classes to inherit regarding saving meta values in standard form in the WordPress database.
Meta_Schema — Class in namespace WPPF\v1_2_2\WordPress: A class for validating input patterns and types for Meta stored in the database.
$ Post#Meta — Property in class Post
$ Post_Type#Meta_Boxes — Property in class Post_Type

O

Utility::object_to_assoc_array() — Method in class Utility: A more verbose and syntactical way to convert an instantiated object's properties to an associative array.
$ Admin_Notice#options — Property in class Admin_Notice: Extra options passed to the Notification.
Options_Page — Class in namespace WPPF\v1_2_2\WordPress\Admin\Pages: A class to abstract and automate the process of creating a page under the 'settings' menu item.

P

$ Action_Scheduler_Page_Module#Page — Property in class Action_Scheduler_Page_Module

Action_Scheduler_Page::page_option_group() — Method in class Action_Scheduler_Page

Action_Scheduler_Page::page_title() — Method in class Action_Scheduler_Page

Action_Scheduler_Page::page_capability() — Method in class Action_Scheduler_Page

WPPF_Settings_Page::page_option_group() — Method in class WPPF_Settings_Page

WPPF_Settings_Page::page_title() — Method in class WPPF_Settings_Page

WPPF_Settings_Page::page_capability() — Method in class WPPF_Settings_Page

$ Framework#plugins — Property in class Framework

Utility::pascal_underscorify() — Method in class Utility

A function which converts the subject to Pascal-case then replaces word boundaries with underscores and returns the resulting string.

Utility::print_debug() — Method in class Utility

One of my preferred functions for quickly displaying object debuggging information in a

tag and optionally killing the script execution.

Form_Builder::print_form() — Method in class Form_Builder

Print the Timer builder form.

Interval_Timer::print_form() — Method in class Interval_Timer

The inherited abstract function for printing the output for the Form Builder.

Interval_Timer::print_info() — Method in class Interval_Timer

The inherited abstract for printing Timer info.

Simple_Timer::print_form() — Method in class Simple_Timer

The inherited abstract function for printing the output for the Form Builder.

Simple_Timer::print_info() — Method in class Simple_Timer

The inherited abstract for printing Timer info.

Timer::print_form() — Method in class Timer

Abstract function to print form options for the form builder.

Timer::print_info() — Method in class Timer

Abstract function to print a table of the Timer's useful information.

Plugin_Upgrader_Trait — Class in namespace WPPF\v1_2_2\Plugin

A trait to extend the Plugin functionality by providing methods for running tasks on version updates.

Plugin_Module — Class in namespace WPPF\v1_2_2

This Module holds specific Plugin-related functionality that doesn't belong with WordPress native abstractions.

WC_Tab_Navigator::print_navigator() — Method in class WC_Tab_Navigator

Print the Navigator HTML.

Admin_Notice::print() — Method in class Admin_Notice

Print the HTML notice (for use by the 'admin_notices' action hook).

Admin_Notice_Queue::print_notices() — Method in class Admin_Notice_Queue

Print all of the Admin Notices and remove the transient.

Admin_Notices::print_notices() — Method in class Admin_Notices

Print all of the Admin Notices and remove the transient.

$ Meta_Box#priority — Property in class Meta_Box

$ Meta_Box#permissions — Property in class Meta_Box

Page — Class in namespace WPPF\v1_2_2\WordPress\Admin\Pages

A class to abstract and automate the process of building Pages.

Page::page_option_group() — Method in class Page

The page slug for registering settings, adding menu items, etc.

Page::page_title() — Method in class Page

The page name/title for display.

Page::page_capability() — Method in class Page

The capability required for the page to be displayed to the user.

Post_Screens — Class in namespace WPPF\v1_2_2\WordPress\Admin\Screens

A manager for screens that belong to a post type.

Post_Screens::post_type() — Method in class Post_Screens

Get the post type of the posts that this screen is associated with.

$ Meta_Schema#pattern — Property in class Meta_Schema

Plugin — Class in namespace WPPF\v1_2_2\WordPress

A class to represent and help deal with common plugin functionality.

$ Plugin#post_types_dir — Property in class Plugin

Post — Class in namespace WPPF\v1_2_2\WordPress

A class to represent and help deal with common custom post type functionality.

$ Post#Post — Property in class Post

Post::post_type() — Method in class Post

Get the post type of the Post.

Post_Meta — Class in namespace WPPF\v1_2_2\WordPress

An abstract for dealing with Post Meta.

$ Post_Meta#Post — Property in class Post_Meta

Post_Type — Class in namespace WPPF\v1_2_2\WordPress

In this class, we attempt to define and encapsulate the functionalities of a single "Post Type" in WordPress.

Post_Type::post_type() — Method in class Post_Type

Get the name of the Post Type.

Post_Type::post_type_options() — Method in class Post_Type

Get the options for the Post Type.

Q

Admin_Notice::queue_notice() — Method in class Admin_Notice: Add the Notice to the display queue.

R

Action_Scheduler_Page::render() — Method in class Action_Scheduler_Page: Required inherited function to render the Page.
Autoloader::register_spl_autoload_function() — Method in class Autoloader: An alias function for linking our class search function to the SPL autoload list.
Framework::register_plugin() — Method in class Framework: Add a plugin instance to the list of registered plugins.
Module::register_submodules() — Method in class Module: Our special function for searching for submodule folders, loading them into the current module and PHP environment.
Timer_Manager::run_timer_queue() — Method in class Timer_Manager: Check all Timers to maybe be run.
Plugin_Upgrader_Trait::requires_version_upgrade() — Method in class Plugin_Upgrader_Trait: Check if the Plugin version is newer than the currently stored version.
Plugin_Upgrader_Trait::run_upgrades() — Method in class Plugin_Upgrader_Trait: Find all upgrade Schemas and run them.
Meta_Box::render() — Method in class Meta_Box: The function that will output the Meta Box HTML. Hooked by { $this->add_meta_box() } through { self::_render() }.
Options_Page::render() — Method in class Options_Page: Get all of the settings for this page and display them.
Settings_Field::render() — Method in class Settings_Field: The function which gets called to print the Field's HTML.
Settings_Section::render() — Method in class Settings_Section: The template for displaying data about the section.
Post_Type::register() — Method in class Post_Type: Register the Post Type with WordPress.
Post_Type::register_meta_boxes() — Method in class Post_Type: Register all Meta Boxes associated with this Post Type.

S

$ WPPF_Settings_Page_Module#Settings_Page — Property in class WPPF_Settings_Page_Module
$ Admin_Module#screens_dir — Property in class Admin_Module
$ Autoloader#scanned_modules — Property in class Autoloader
Autoloader::search_for_class_file() — Method in class Autoloader: Search for a class file via the cached class map.
Module::submodule_construct() — Method in class Module: The function which gets called when a module is being constructed. This ensures the submodule construct sequences don't get fired when a submodule is first initialized.
Module::submodule_instance() — Method in class Module: The function which gets called if this module is being imported as a submodule.
Singleton — Class in namespace WPPF\v1_2_2\Framework: An abstraction to apply to singleton instances for uniform initialization.
Utility::slugify() — Method in class Utility: A function which replaces word boundaries with dashes and returns the lowercase string.
Utility::scandir() — Method in class Utility: A wrapper for scandir which removes . and .. as values from the return array, and can optionally return only files or folders.
Utility::scandir_filter() — Method in class Utility: Take in an array of potential files and folders and filter them accordingly.
$ Interval_Timer#start — Property in class Interval_Timer
Simple_Timer — Class in namespace WPPF\v1_2_2\Plugin\Action_Scheduler: A Timer instance that bases it's run times off of even intervals from a specified start times. It can also return how many missed intervals a Timer may potentially have.
Timer::save() — Method in class Timer: A wrapper function for \WPPF\v1_2_2\Plugin\Action_Scheduler\Timer_Manager::update_timer().
Timer_Manager::set_timers() — Method in class Timer_Manager: Given an array of Timers, update all Timers in the database to reflect the data in the array.
Plugin_Upgrader_Trait::sort_upgrade_schemas() — Method in class Plugin_Upgrader_Trait: Sort Schema actions by version.
Staging_Detection — Class in namespace WPPF\v1_2_2\Plugin: A Module which registers a site host as an expected host and throws a notification if the expected host differs from the current host and at least one Plugin has registered a notification.
Staging_Detection_Notice — Class in namespace WPPF\v1_2_2\Plugin\Staging_Detection: A Module which registers a site host as an expected host and throws a notification if the expected host differs from the current host and at least one Plugin has registered a notification.
Email::send_email() — Method in class Email: A function for aliasing the email action hook set in the constructor.
Email::set_placeholders() — Method in class Email: An empty function for optionally setting up the email placeholders.
Email::set_recipient() — Method in class Email: A placeholder function for setting the recipient.
Admin_Notices::success() — Method in class Admin_Notices: A function to queue a success admin notice.
$ Meta_Box#screen — Property in class Meta_Box
Meta_Box::save_post() — Method in class Meta_Box: The code to be run after the _save_post hook checks.
Management_Page::submenu_id() — Method in class Management_Page: The inherited function from the abstract returning the submenu ID.
Options_Page::submenu_id() — Method in class Options_Page: The inherited function from the abstract returning the submenu ID.
Page::submenu_id() — Method in class Page: Return the submenu ID for use with the WordPress $submenu global.
Settings_Field — Class in namespace WPPF\v1_2_2\WordPress\Admin\Pages: A class to automate the process of creating a Settings Field under a Settings Section.
$ Settings_Field#Settings_Section — Property in class Settings_Field
Settings_Section — Class in namespace WPPF\v1_2_2\WordPress\Admin\Pages: A class to automate the process of creating a section for a page under the 'settings' menu item.
$ Settings_Section#Settings_Page — Property in class Settings_Section
$ Settings_Section#Settings_Fields — Property in class Settings_Section
$ Settings_Section#section — Property in class Settings_Section
Screens — Class in namespace WPPF\v1_2_2\WordPress\Admin: An extension to the Admin Module that manages code related to particular admin screens, and what code should be run in global or local context.
$ Screens#screen_hook_priority — Property in class Screens
$ Meta#Schema — Property in class Meta
$ Meta#single — Property in class Meta
Meta::save() — Method in class Meta: The function used to save meta data.
Meta::set_data() — Method in class Meta: Set the meta data of this instance.
Meta::set_schema() — Method in class Meta: Set the schema for the Meta data.
Post_Meta::save() — Method in class Post_Meta: Save the instance data to the database.
User_Meta::save() — Method in class User_Meta: Save the instance data to the database.

T

Action::to_array() — Method in class Action: Return the action as an associative array.
Interval_Timer::timer_label() — Method in class Interval_Timer: Get the Timer name.
Interval_Timer::timer_type_id() — Method in class Interval_Timer: Get the Timer type ID.
Simple_Timer::timer_label() — Method in class Simple_Timer: Get the Timer name.
Simple_Timer::timer_type_id() — Method in class Simple_Timer: Get the Timer type ID.
Timer — Class in namespace WPPF\v1_2_2\Plugin\Action_Scheduler: A Timer template for the Action Scheduler system that other timer classes can extend and implement their own settings for.
$ Timer#timer_created — Property in class Timer
$ Timer#timer_type — Property in class Timer
Timer::timer_label() — Method in class Timer: Abstract function for holding a printable timer name for the Form Builder.
Timer::timer_type_id() — Method in class Timer: Abstract function that returns a slug which represents the timer class, this way timers can be reinstantiated from the database across Framework versions.
Timer::to_array() — Method in class Timer: Convert this object into an array for export/import.
Timer_Manager — Class in namespace WPPF\v1_2_2\Plugin\Action_Scheduler: A static class to manage the saving and loading of Timers from the database.
Email::trigger() — Method in class Email: The WC email 'trigger' function expected.
WC_Tab_Navigator::tab_null_render() — Method in class WC_Tab_Navigator: An empty function to call in case a default render was not provided.
$ Admin_Notice#type — Property in class Admin_Notice
$ Settings_Field#type — Property in class Settings_Field
Settings_Field::to_array() — Method in class Settings_Field: Export the public properties of this Field to an array.
$ Meta_Schema#type — Property in class Meta_Schema
$ Plugin#templates_dir — Property in class Plugin

U

Utility — Class in namespace WPPF\v1_2_2\Framework: Utility functions class to hold useful chunks of code we find ourselves often reusing.
Timer_Manager::update_timer() — Method in class Timer_Manager: Update/add a Timer, optionally merge Actions with a previously existing Timer being overwritten.
$ Plugin_Upgrader_Trait#upgrades_dir — Property in class Plugin_Upgrader_Trait
Plugin_Upgrader_Trait::update_current_version() — Method in class Plugin_Upgrader_Trait: Update the current Plugin version in the database.
Upgrader — Class in namespace WPPF\v1_2_2\Plugin: A Module for providing automated access to running tasks on Plugin version updates.
Upgrader_Schema — Class in namespace WPPF\v1_2_2\Plugin: A class to control the basic functionality for an Upgrader Schema (super descriptive, ty me).
User_Meta — Class in namespace WPPF\v1_2_2\WordPress: An abstract for dealing with User Meta.
$ User_Meta#User — Property in class User_Meta

V

$ Settings_Field#value — Property in class Settings_Field
Post_Screens::view_posts() — Method in class Post_Screens: The function which hooks when viewing multiple Posts of the static post type.
Post_Screens::view_post() — Method in class Post_Screens: The function which hooks when viewing a single Post of the static post type.
Meta::validate() — Method in class Meta: Validate the Meta export values based on the current Schema.
Meta_Schema::validate_pattern() — Method in class Meta_Schema: Validate whether or not a passed string is a valid RegExp.
Meta_Schema::validate() — Method in class Meta_Schema: Validate the data based on this Schema.

W

WPPF_Settings_Page — Class in namespace WPPF\v1_2_2\Admin\Screens: The options page configuration for general settings regarding the modules included in this plugin.
WPPF_Settings_Page_Module — Class in namespace WPPF\v1_2_2\Admin: Manage the settings for for this plugin.
WC_Tab_Navigator — Class in namespace WPPF\v1_2_2\WooCommerce: A class to encompass the creation and script handling of the WooCommerce Tabs UI component.
WooCommerce_Plugin — Class in namespace WPPF\v1_2_2\WooCommerce: A super class of the Plugin that includes WooCommerce-specific functionality.
WooCommerce_Plugin::woocommerce_check() — Method in class WooCommerce_Plugin: Check whether WooCommerce is activated and throw an error message if it is not.
WooCommerce_Module — Class in namespace WPPF\v1_2_2: This Module manages the WooCommerce features.
Admin_Notices::warning() — Method in class Admin_Notices: A function to queue a warning admin notice.
WordPress_Module — Class in namespace WPPF\v1_2_2: This Module manages the WordPress-specific features of the framework.

_

Action_Scheduler_Page_Module::_admin_menu() — Method in class Action_Scheduler_Page_Module: WordPress 'admin_menu' hook.
Admin_Notice_Module::_admin_enqueue_scripts() — Method in class Admin_Notice_Module: WordPress 'admin_enqueue_scripts' hook.
Admin_Notice_Module::_admin_notices() — Method in class Admin_Notice_Module: WordPress 'admin_notices' hook.
Action_Scheduler_Page::__construct() — Method in class Action_Scheduler_Page: Construct the parent model. Make sure to call after global $submenu is defined.
WPPF_Settings_Page::__construct() — Method in class WPPF_Settings_Page: Construct the parent model. Make sure to call after global $submenu is defined.
WPPF_Settings_Page_Module::_admin_menu() — Method in class WPPF_Settings_Page_Module: WordPress 'admin_menu' hook.
WPPF_Settings_Page_Module::_admin_init() — Method in class WPPF_Settings_Page_Module: WordPress 'admin_init' hook.
Admin_Module::__construct() — Method in class Admin_Module: A protected constructor to ensure only singleton instances exist.
Autoloader::__construct() — Method in class Autoloader: Protected constructor to prevent more than one instance of autoload directories from being created
Framework::__construct() — Method in class Framework: Protected constructor to prevent multiple Framework instances from being created. Instantiate the Shadow Plugin.
Module::__construct() — Method in class Module: A protected constructor to ensure only singleton instances of plugins exist.
$ Singleton#_instances — Property in class Singleton
Singleton::__construct() — Method in class Singleton: Require a protected constructor so existing instances can be checked against.
Action::__construct() — Method in class Action: Construct this action using the provided and default arguments.
Cron_Manager::_cron_schedules() — Method in class Cron_Manager: The WordPress hook for 'cron_schedules'.
Cron_Manager::_wppf_action_scheduler_update_hook() — Method in class Cron_Manager: Function name matches that of the constant stored in this class, function is the hook function run.
Interval_Timer::__construct() — Method in class Interval_Timer: Construct the Interval Timer.
Simple_Timer::__construct() — Method in class Simple_Timer: Construct the Interval Timer.
Timer::__construct() — Method in class Timer: Construct a Timer given an ID and a set of options.
Staging_Detection_Notice::_admin_notices() — Method in class Staging_Detection_Notice: The WordPress 'admin_notices' action hook.
$ Email#_constructed — Property in class Email
Email::__construct() — Method in class Email: Email contructor. Set mandatory properties.
Email::_woocommerce_mail_content() — Method in class Email: The WooCommerce 'woocommerce_mail_content' action hook. Supply the find/replace functionality.
Email_Traits::_woocommerce_email_classes() — Method in class Email_Traits: The WooCommerce 'woocommerce_email_classes' action hook. Add the registered Emails to the list of WooCommerce Emails.
WC_Tab_Navigator::__construct() — Method in class WC_Tab_Navigator: Construct an instance of the Navigator.
WooCommerce_Plugin::__construct() — Method in class WooCommerce_Plugin: The constructor. Run the trait functions.
WooCommerce_Plugin::_wc_get_template() — Method in class WooCommerce_Plugin: The WooCommerce 'wc_get_template' filter hook.
WooCommerce_Plugin::_wc_get_template_part() — Method in class WooCommerce_Plugin: The WooCommerce 'wc_get_template_part' filter hook.
WooCommerce_Plugin::_woocommerce_locate_core_template() — Method in class WooCommerce_Plugin
Admin_Notice::__construct() — Method in class Admin_Notice: Construct the Notice.
Meta_Box::__construct() — Method in class Meta_Box: Construct the Meta_Box. Set the default properties if they are not set.
Meta_Box::_save_post() — Method in class Meta_Box: WordPress hook for 'save_post', verify autosaving and Meta Box nonce.
Meta_Box::_render() — Method in class Meta_Box: The hook to use when adding the meta box to the WordPress environment. The gets called in { $this->add_meta_box() }.
Management_Page::__construct() — Method in class Management_Page: Construct the parent settings page.
Options_Page::__construct() — Method in class Options_Page: Construct the parent settings page.
Page::__construct() — Method in class Page: Add action for creating submenu page.
Settings_Field::__construct() — Method in class Settings_Field: Construct the Settings Field.
Settings_Section::__construct() — Method in class Settings_Section: Set the initial values for the Settings Section.
Screens::_current_screen() — Method in class Screens: The WordPress hook 'current_screen' which should be used to construct the screen module since that is when the data is available.
Meta::__construct() — Method in class Meta: Construct the Meta. Load the data from the database.
Meta_Schema::__construct() — Method in class Meta_Schema: Construct the Meta Schema with expressions, types, and defaults.
Plugin::__construct() — Method in class Plugin: A protected constructor to ensure only singleton instances of plugins exist.
Post::__construct() — Method in class Post: Construct the Post. Load Post and Post Meta data.
Post_Meta::__construct() — Method in class Post_Meta: Construct construct the Post Meta, instantiate Post if necessary, call parent constructor.
Post_Type::__construct() — Method in class Post_Type: Construct the Post Type Singleton.
Post_Type::_init() — Method in class Post_Type: The WordPress hook for 'init'.
User_Meta::__construct() — Method in class User_Meta: Construct construct the User Meta, instantiate User if necessary, call parent constructor.