• Home
• WpGears
• Plugin

PHP Class WpGears\Plugin

When run in Client mode it will allow adding new jobs to the Queue. When run in worker mode it will execute jobs on the Queue. Worker mode also allows adding new jobs to the queue just like Mlient mode. ファイルを表示 Open project: 10up/wp-gears Class Usage Examples

Public Properties

Property	Type	Description
$client		The Client object used to enqueue jobs
$client_class		client class
$config_prefix		Configuration constants are prefixed by WP_GEARS by default. ;w Eg:- WP_GEARS_JOBS_PER_WORKER
$did_enable		*
$did_run		*
$instance		Single instance of the plugin
$jobs_per_worker		Number of jobs to execute per worker, Default 1
$worker		The Worker object used to execute jobs
$worker_class		Custom worker class

Public Methods

Method	Description
add ( string $hook, array $args = [], string $priority = 'normal' ) : boolean	Adds a new job to the Client with the specified arguments and priority.
build_client ( ) : Client	Conditionally builds a new Client object. If the constant WP_GEARS_CLIENT_CLASS is defined it will return an instance of that class.
build_worker ( ) : Worker	Conditionally builds a new Worker object. If the constant WP_GEARS_WORKER_CLASS is defined it will return an instance of that class.
enable ( )	Enables the plugin by registering it's clients and workers.
get_client ( ) : Client	Returns the Client object used to add jobs. Creates the instance of the client lazily.
get_config ( string $constant, string $default = '', string $config_prefix = '' ) : mixed	Helper to pickup config options from Constants with fallbacks.
get_instance ( ) : Plugin	Returns the singleton instance of the Plugin. Creates the instance if it is absent.
get_jobs_per_worker ( ) : integer	Returns the jobs to execute per worker instance
get_worker ( )	Returns the Worker object used to execute jobs. Creates the instance of the worker lazily.
get_wp_load ( ) : string	Returns the path to the wp-load.php file.
has_config ( string $constant ) : boolean	Checks if a config option is defined. Empty strings are treated as an undefined config option.
load_wordpress ( )	Tries to load WordPress using wp-load.php. If loading fails an error message is logged and the Script will exit immediately with a status code of 1.
quit ( integer $status_code )	Helper to quit with a status code. When running under PHPUnit it returns the status_code instead of exiting immediately.
run ( ) : integer	Starts processing jobs in the Worker.
work ( ) : integer	Executes jobs on the current Worker. A Worker will taken up only one job by default. If WP_GEARS_JOBS_PER_WORKER is defined that many jobs will be executed before it exits.

Method Details

Property Details