PUM_Abstract_Upgrade_Settings
Implements a batch processor for updating settings after new version.
Description Description
See also See also
- PUM_Abstract_Upgrade
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/Abstract/Upgrade/Settings.php
abstract class PUM_Abstract_Upgrade_Settings extends PUM_Abstract_Upgrade { /** * Batch process ID. * * @var string */ public $batch_id = ''; /** * Executes a single step in the batch process. * * @return int|string|WP_Error Next step number, 'done', or a WP_Error object. */ public function process_step() { // Allows sending a start & success message separately. if ( $this->step > 1 ) { return 'done'; } $settings = pum_get_options(); $this->process_settings( $settings ); return ++ $this->step; } /** * Retrieves a message for the given code. * * @param string $code Message code. * * @return string Message. */ public function get_message( $code ) { switch ( $code ) { case 'start': $message = sprintf( __( 'Updating settings for v%s compatibility.', 'popup-maker' ), '1.7' ); break; case 'done': $message = __( 'Settings updated successfully.', 'popup-maker' ); break; default: $message = ''; break; } return $message; } /** * Process needed upgrades on Popup Maker settings * * You need to handle saving!!! * * @param array $settings */ abstract public function process_settings( $settings = array() ); }
Expand full source code Collapse full source code View on Trac
Changelog Changelog
Version | Description |
---|---|
1.7.0 | Introduced. |
Methods Methods
- get_message — Retrieves a message for the given code.
- process_settings — Process needed upgrades on Popup Maker settings
- process_step — Executes a single step in the batch process.