Cp_Plgn_Drctry

The core plugin class.

Description

This is used to define internationalization, admin-specific hooks, and public-facing site hooks.

Also maintains the unique identifier of this plugin as well as the current version of the plugin.

Tags
since
1.0.0
author

Beda Schmid beda@tukutoi.com

Table of Contents

$loader  : Cp_Plgn_Drctry_Loader
The loader that's responsible for maintaining and registering all hooks that power the plugin.
$plugin_name  : string
The unique identifier of this plugin.
$plugin_prefix  : string
The unique prefix of this plugin.
$version  : string
The current version of the plugin.
__construct()  : mixed
Define the core functionality of the plugin.
get_loader()  : Cp_Plgn_Drctry_Loader
The reference to the class that orchestrates the hooks with the plugin.
get_plugin_name()  : string
The name of the plugin used to uniquely identify it within the context of WordPress and to define internationalization functionality.
get_plugin_prefix()  : string
The unique prefix of the plugin used to uniquely prefix technical functions.
get_version()  : string
Retrieve the version number of the plugin.
run()  : mixed
Run the loader to execute all of the hooks with WordPress.
define_admin_hooks()  : mixed
Register all of the hooks related to the admin area functionality of the plugin.
load_dependencies()  : mixed
Load the required dependencies for this plugin.
set_locale()  : mixed
Define the locale for this plugin for internationalization.

Properties

$loader

The loader that's responsible for maintaining and registering all hooks that power the plugin.

protected Cp_Plgn_Drctry_Loader $loader
Description

Maintains and registers all hooks for the plugin.

Tags
since
1.0.0
access

protected

$plugin_name

The unique identifier of this plugin.

protected string $plugin_name
Description

The string used to uniquely identify this plugin.

Tags
since
1.0.0
access

protected

$plugin_prefix

The unique prefix of this plugin.

protected string $plugin_prefix
Description

The string used to uniquely prefix technical functions of this plugin.

Tags
since
1.0.0
access

protected

$version

The current version of the plugin.

protected string $version
Description

The current version of the plugin.

Tags
since
1.0.0
access

protected

Methods

__construct()

Define the core functionality of the plugin.

public __construct() : mixed
Description

Set the plugin name and the plugin version that can be used throughout the plugin. Load the dependencies, define the locale, and set the hooks for the admin area and the public-facing side of the site.

Tags
since
1.0.0
Return
(mixed)

get_plugin_name()

The name of the plugin used to uniquely identify it within the context of WordPress and to define internationalization functionality.

public get_plugin_name() : string
Tags
since
1.0.0
Return
(string) The name of the plugin.

get_plugin_prefix()

The unique prefix of the plugin used to uniquely prefix technical functions.

public get_plugin_prefix() : string
Tags
since
1.0.0
Return
(string) The prefix of the plugin.

get_version()

Retrieve the version number of the plugin.

public get_version() : string
Tags
since
1.0.0
Return
(string) The version number of the plugin.

run()

Run the loader to execute all of the hooks with WordPress.

public run() : mixed
Tags
since
1.0.0
Return
(mixed)

define_admin_hooks()

Register all of the hooks related to the admin area functionality of the plugin.

private define_admin_hooks() : mixed
Tags
since
1.0.0
access

private

Return
(mixed)

load_dependencies()

Load the required dependencies for this plugin.

private load_dependencies() : mixed
Description

Include the following files that make up the plugin:

  • Cp_Plgn_Drctry_Loader. Orchestrates the hooks of the plugin.
  • Cp_Plgn_Drctry_i18n. Defines internationalization functionality.
  • Cp_Plgn_Drctry_Admin. Defines all hooks for the admin area.
  • Cp_Plgn_Drctry_Public. Defines all hooks for the public side of the site.

Create an instance of the loader which will be used to register the hooks with WordPress.

Tags
since
1.0.0
access

private

Return
(mixed)

set_locale()

Define the locale for this plugin for internationalization.

private set_locale() : mixed
Description

Uses the Cp_Plgn_Drctry_i18n class in order to set the domain and to register the hook with WordPress.

Tags
since
1.0.0
access

private

Return
(mixed)

Search results