• Home
• WPDKWordPressPlugin

PHP Class WPDKWordPressPlugin

## Overview The WPDKWordPressPlugin class provides the fundamental startup of plugin. You rarely (never) instantiate WPDKWordPressPlugin object directly. Instead, you instantiate subclasses of the WPDKWordPressPlugin class. ### Subclassing This class **must** be used to extend the main class of your plugin. Its function is to initialize the environment will operate on the plugin itself and record the Plugin for updates from WPX Store. ### Benefits In addition to initializing and recording, WPDKWordPressPlugin class performs for us a whole series of standard procedures in the writing of Plugin, in addition to providing a lot of properties and methods really comfortable. * Gets directly from standard WordPress comments prior information as to the description of the Plugin: plugin name, version, the text and the text domain domain path * Prepare a set of standard properties with paths and urls most commonly used * Provides a lot of hook to wrap (filters and actions) of most used WordPress * Prepare an instance of WPDKWatchDog object for own log ### Useful properties The path propertis are the filesystem unix path. The URL properties are the HTTP protocol URI. See below for detail ### Useful methods See below for detail Show file Open project: wpxtreme/wpdk Class Usage Examples

Public Properties

Property	Type	Description
$assetsURL	string	The Plugin URL more assets/. This property is very useful for read style sheet and Javascript file in the 'assets' folder.
$classesPath	string	The Filesystem plugin path more classes/
$cssURL	string	The Plugin URL more assets/css/
$databasePath	string	The Filesystem plugin path more database/
$folderName	string	The plugin folder, Eg. wpx-smartshop/
$imagesURL	string	The Plugin URL more assets/css/images/
$javascriptURL	string	The Plugin URL more assets/js/
$path	string	Filesystem plugin path
$pluginBasename	string	The Plugin folder and main file, Eg. wpx-smartshop/main.php This is used as unique code id.
$protocol	string	The Protocol http:// or https://
$slug	string	The plugin slug build with WordPress sanitize_title()
$url	string	The Plugin URL
$urlAjax	string	The Default WordPress admin Ajax URL gateway
$url_images	string	The Plugin URL more assets/css/images/
$url_javascript	string	The Plugin URL more assets/js/

Public Methods

Method	Description
__construct ( string $file = null ) : WPDKWordPressPlugin	Create a WPDKWordPressPlugin instance
activation ( )	Called when a plugin is activate; register_activation_hook()
admin ( )	See _init()
admin_init ( )	Called by action hook 'admin_init'
ajax ( )	This method is to override and it is called when an Ajax request is performed.
autoloadEnvironment ( string $sClassName )	This function performs runtime autoloading of a class specifically related to this instance; this autoloading is based on previous class registering that has to be executed before.
currentURL ( ) : string	Return the current complete URL with protocol (http or https), server name, port and URI
deactivation ( )	Called when a plugin is deactivate; register_deactivation_hook()
preferences ( )	Called after load_plugin_textdomain() in _init
protocol ( ) : string	Return the current web site protocol. The protocol property is set too.
registerAutoloadClass ( string | array $sLoadingPath, string $mClassName = '' )	This function records a WPX plugin class into autoloading register, joined with its loading path.
reloadTextDomain ( )	Reload the text domain for multilingual. This method is useful when the loading procedure for the text domain (which occurs in plugins_loaded()) is not complete for some reason.
theme ( )	See _init()``
urlAjax ( ) : string	Returns the standard URL used by WordPress Ajax request.
widgets ( )	Fires after all default WordPress widgets have been registered.

Method Details

Property Details