pNet
Table of Contents
Classes
- Admin
- The general admin-specific functionality of the plugin.
- Assets
- Register and enqueue the admin-specific stylesheets and JavaScript.
- Form_Send_Email
- Admin send email form functionality.
- Manage_Debug_Log
- Manage the WordPress debug log.
- Manage_Log
- Manage the system logs.
- Manage_PHP_Log
- Manage the system PHP error log.
- Related_Posts
- Handle the related posts admin functionality.
- Send_Email
- Send email from pNet admin tools page.
- Settings_Export
- Functionality to export site settings as a json file.
- Settings_Import_Export
- Functionality to support json settings file import/export.
- Settings_Import
- Functionality to import site settings from a json file.
- Settings
- Manage the pfeifferNet site(s) settings.
- Tax_Meta
- Taxonomy common extended meta data functionality.
- Tool
- Basic functionality for a pfeifferNet administration page tool.
- Tools
- Defines the admin page for pfeifferNet tools.
- Update_Plugin
- Plugin updater using GitHub repository as the update host.
- Update_Theme
- Theme updater using GitHub repository as the update host.
- Updater
- Plugin and theme updater using GitHub repository as update source.
- Users
- Extended user admin functionality.
- Views
- Display page and post views on admin pages.
- Word_Count
- Handle the word count functionality.
- Assets
- Register and enqueue the stylesheets and JavaScript used in both backend and public facing.
- Date_Time
- Date and time formatting and handling.
- Email_Contact_Request
- Handle sending contact requests to administrator.
- Email_Reset_Email_Confirm
- Handle changed email address confirmation email.
- Email_Reset_Email_Request
- Send email to request email address change.
- Email_Sent_Notice
- Class to send notice of sent emails to site administrator.
- Email_Welcome_User
- Base class to handle new user welcome email.
- Class for creating and sending emails.
- Form
- Basic form functionality.
- Helper
- Content helper functionality
- HTML_Email
- Class to provide HTML email messages and settings.
- HTTP_Handler
- HTTP request sanitisation.
- Icons
- Provides SVG icon support.
- Media_Selector
- WP media selector functionality.
- Media
- Provides enhanced media functionality.
- Optimise
- Site optimisation.
- Progress_Indicator
- Progress indicator functionality.
- Related_Posts
- Handle the common related posts functionality.
- Secure
- Site security.
- Settings
- Handle requests for site settings values.
- SMTP_Mailer
- Set use of SMTP mail.
- System_Email
- Base class for system generated emails.
- Users
- Common user functionality.
- Activator
- Fired by the plugin activation process.
- Deactivator
- Fired by the plugin deactivation process.
- I18n
- Define the internationalization functionality.
- Loader
- Register all actions and filters for the plugin.
- pNet
- The core plugin class.
- Updater
- Plugin updater.
- Assets
- Enqueue the stylesheet and JavaScript for the frontend of the site.
- Captcha
- Provides functionality to use Google reCAPTCHA V3.
- Comment
- Comment functionality.
- Follow_Author
- Display links to the author's social sites.
- Follow_Site
- Display links to the site's social media.
- Follow
- Display icon links to the author's social sites.
- Form_Contact
- Contact form functionality.
- Form_Register
- User registration request form functionality.
- Form_User_Account
- User account edit profile form functionality.
- Grid
- Display a grid of cards.
- Lightbox
- Set the simplelightbox options and enqueue the scripts.
- Link_Buttons
- Provide list of anchor link buttons, including text
- Link_Icons
- Provide list of anchor link icons.
- Link_List
- Provides text-only list of anchor links.
- Links
- Abstract class to handle links.
- Messages
- Provide messages for frontend display.
- Publication
- Post and page publication data.
- Register
- Handle subscriber registration.
- Related_Posts
- Handle the related posts frontend functionality.. - Given a post ID, return an array of related post IDs.
- RSS
- Site RSS functionality.
- Search
- Basic search functionality.
- Share
- Share post to social media.
- Social
- Basic social media functionality.
- Taxonomy
- Provide additional taxonomy functions.
- Term_Archive
- Term archive functionality.
- Term_Grid
- Taxonomy terms grid functionality.
- Term
- Provide additional taxonomy terms functions.
- User_Account
- User account profile maintenance functionality.
- User_Login_History
- Site users login history display.
- User_Notifications
- User notifications functionality.
- User
- Site users functionality.
- View
- Counts page and post views.
- Archive_Filter
- Display a form to filter an archive.
- Contact_Form
- Display a contact form.
- Follow_Author
- Display list of links to social media for the post author.
- Follow_Site
- Display list of links to social media for the site.
- Hero_Image
- Display the featured hero image.
- List_Terms
- Display a list of taxonomy links.
- Login_History
- Display the user login history.
- Publication_History
- Display the created and updated dates for a post or page.
- Register_Form
- Display a registration form.
- Share_List
- Display a list of social sharing links.
- Shortcode
- Abstract base class for shortcodes.
- Term_Grid
- Display a grid of taxonomy cards.
- User_Notifications
- Display user notification messages.
Functions
- autoloader() : void
- Dynamically load the referenced class.
- get_plugin_metadata() : string
- Return a metadata value.
- get_asset_version() : string
- Return the asset version.
- get_asset_path() : string
- Return the fully qualified path to an asset.
- get_asset_url() : string
- Return the asset URL.
- get_vendor_asset_path() : string
- Return the fully qualified path to a vendor asset.
- get_vendor_asset_url() : string
- Return the vendor asset URL.
- run_plugin() : void
- Plugin execution.
- delete_post_meta() : void
- Delete post metadata added by this plugin.
- delete_user_meta() : void
- Delete user metadata added by this plugin.
- delete_term_meta() : void
- Delete taxonomy term metadata added by this plugin.
- delete_options() : void
- Delete wp_options entries.
Functions
autoloader()
Dynamically load the referenced class.
autoloader(string $required_class) : void
This is the recommended WordPress approach, so if/else is OK.
Parameters
- $required_class : string
-
The fully-qualified name of the class to load.
Tags
get_plugin_metadata()
Return a metadata value.
get_plugin_metadata(string $field) : string
Parameters
- $field : string
-
The field to search for.
Tags
Return values
string —The metadata value.
get_asset_version()
Return the asset version.
get_asset_version(string $asset) : string
- Production uses plugin version. Non-production uses resource file last modified time.
- Use for scripts and styles.
Parameters
- $asset : string
-
The fully qualified file path of the target asset.
Tags
Return values
string —The asset version.
get_asset_path()
Return the fully qualified path to an asset.
get_asset_path([string $asset = '' ]) : string
An empty string returns the assets folder path.
Parameters
- $asset : string = ''
-
The partial path of the target asset. A leading slash is required.
Tags
Return values
string —The asset path.
get_asset_url()
Return the asset URL.
get_asset_url([string $asset = '' ]) : string
An empty string returns the assets folder URL.
Parameters
- $asset : string = ''
-
The partial path of the target asset. A leading slash is required.
Tags
Return values
string —The asset URL.
get_vendor_asset_path()
Return the fully qualified path to a vendor asset.
get_vendor_asset_path([string $asset = '' ]) : string
An empty string returns the vendor folder path.
Parameters
- $asset : string = ''
-
The partial path of the target asset. A leading slash is required.
Tags
Return values
string —The asset path.
get_vendor_asset_url()
Return the vendor asset URL.
get_vendor_asset_url([string $asset = '' ]) : string
An empty string returns the vendor folder URL.
Parameters
- $asset : string = ''
-
The partial path of the target asset. A leading slash is required.
Tags
Return values
string —The asset URL.
run_plugin()
Plugin execution.
run_plugin() : void
Tags
delete_post_meta()
Delete post metadata added by this plugin.
delete_post_meta() : void
Tags
delete_user_meta()
Delete user metadata added by this plugin.
delete_user_meta() : void
Tags
delete_term_meta()
Delete taxonomy term metadata added by this plugin.
delete_term_meta() : void
Tags
delete_options()
Delete wp_options entries.
delete_options() : void