PUM_Batch_Process_Registry
Implements a batch process registry class.
Description Description
See also See also
- PUM_Abstract_Registry
Warning: preg_match(): Compilation failed: invalid range in character class at offset 24 in /mnt/data/home/502433.cloudwaysapps.com/rhbymdevka/public_html/wp-content/themes/wporg-developer/inc/formatting.php on line 207
Source Source
File: classes/Batch/Process/Registry.php
class PUM_Batch_Process_Registry extends PUM_Abstract_Registry { /** * @var PUM_Batch_Process_Registry */ public static $instance; /** * @return PUM_Batch_Process_Registry */ public static function instance() { if ( ! isset( self::$instance ) ) { self::$instance = new self(); self::$instance->init(); } return self::$instance; } /** * Initializes the batch registry. */ public function init() { $this->register_core_processes(); /** * Fires during instantiation of the batch processing registry. * * @param PUM_Batch_Process_Registry $this Registry instance. */ do_action( 'pum_batch_process_init', $this ); } /** * Registers core batch processes. */ protected function register_core_processes() { } /** * Registers a new batch process. * * @param string $batch_id Unique batch process ID. * @param array $process_args { * Arguments for registering a new batch process. * * @type string $class Batch processor class to use. * @type string $file File containing the batch processor class. * } * * @return WP_Error|true True on successful registration, otherwise a WP_Error object. */ public function register_process( $batch_id, $process_args ) { $process_args = wp_parse_args( $process_args, array_fill_keys( array( 'class', 'file' ), '' ) ); if ( empty( $process_args['class'] ) ) { return new WP_Error( 'invalid_batch_class', __( 'A batch process class must be specified.', 'popup-maker' ) ); } if ( empty( $process_args['file'] ) ) { return new WP_Error( 'missing_batch_class_file', __( 'No batch class handler file has been supplied.', 'popup-maker' ) ); } // 2 if Windows path. if ( ! in_array( validate_file( $process_args['file'] ), array( 0, 2 ), true ) ) { return new WP_Error( 'invalid_batch_class_file', __( 'An invalid batch class handler file has been supplied.', 'popup-maker' ) ); } return $this->add_item( $batch_id, $process_args ); } /** * Removes a batch process from the registry by ID. * * @param string $batch_id Batch process ID. */ public function remove_process( $batch_id ) { $this->remove_item( $batch_id ); } }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
1.7.0 | Introduced. |
Methods Methods
- init — Initializes the batch registry.
- instance
- register_core_processes — Registers core batch processes.
- register_process — Registers a new batch process.
- remove_process — Removes a batch process from the registry by ID.