Total hooks: 89Undocumented hooks: 28
Type: filter
No description
Arguments: true
Arguments: false
Type: action
Fires just before the current task processing
Arguments: $task
$task - objectTask instance.
$task
object
Fires just after the current task processing
Arguments: $task, $status
$status - boolDone or not
$status
bool
Whether to actually include this table in migration processing
Arguments: true, $table
$do_process_item - boolInclude item.
$do_process_item
$table - stringTable name.
$table
string
Arguments: 250
Number of file statements to upload in one step
Arguments: 10
$limit - intMaximum number of files.
$limit
int
DEV API service URL
Arguments: $service_url
$service_url - stringShipper DEV API service URL.
$service_url
Pre-process the service call args
Arguments: $args, $endpoint
$args - arrayRemote request arguments.
$args
array
$endpoint - stringRequested endpoint.
$endpoint
Whether we're in import mocking mode, defaults to false.
<p>In files import mocking mode, none of the files will be actually copied over to their final destination.</p>
$is_mock_import - boolWhether we're in mock import mode.
$is_mock_import
Source tables processing list
<p>Used in tests suite.</p>
Arguments: $tables
$tables - arrayList of extracted table names (from SQL files).
$tables
Arguments: 25
<p>In tables import mocking mode, intermediate tables will be created. However, they won't be ported over to the existing tables. As a side-effect of this, the database size <em>will</em> double.</p>
Arguments: \Shipper_Model_Env::is_auth_requiring_env()
Whether the file is deployable
Arguments: true, basename($filepath), $filepath
$deployable - boolWhether the file is deployable.
$deployable
$basename - stringBasename of the file.
$basename
$path - stringFull path to the file.
$path
Dashboard present check filter
Arguments: $present
$result - Whether the dash is present.
$result
Dashboard active check filter
Arguments: $result
$result - Whether the dash is active.
Dashboard API key presence check filter
Arguments: $model->get('api_key')
$result - Whether the dash API key is present.
Arguments: 600, $this->_process
Fires on kickstart attempt
Arguments: none
Fires just before runner tick processing, after locking
Arguments: $this
$runner - objectRunner instance.
$runner
Fires on stale lock removal
Arguments: $lock
$lock - stringProcess lock identifier.
$lock
Arguments: $secure, $user_id
Gets the runner ping timeout
<p>This is a (fractional) number of seconds we're allowing to our self-ping POST request to run.</p> <p>Default is 30s for blocking requests, and 0.5s for non-blocking.</p>
Arguments: $timeout
$timeout - floatPing timeout, in seconds.
$timeout
float
Whether the runner self-ping request is a blocking one
<p>Defaults to false.</p>
$is_blocking - boolWhether the request will be a blocking one.
$is_blocking
Triggers just before cron respawning.
<p>Used in tests</p>
Whether to update the DEV API on migration progress status
Arguments: true, $task
$do_update - boolWhether to send status update.
$do_update
$task - objectOverall task (which can be queried for has_completed_task).
has_completed_task
Fires on remote migration kickstart
Whether to clear the log on migration prep
Arguments: true, $migration
$clear_log - boolWhether to clear the log or not.
$clear_log
$migration - objectShipper_Model_Stored_Migration instance.
$migration
Fires on migration start
Arguments: $migration
Fires on migration complete.
- objectShipper_Model_Stored_Migration instance.
Fires on migration cancel, just before sending out any remote cancel requests
Fires on migration cancel
Fires on each completed tick
Arguments: $migration, $task, $status
$migration - objectMigration model instance.
$task - objectOverall task instance.
$status - boolMigration completion status.
Debug mode filter
<p>Debug mode affects FS storage implementation and cancels out the concealments/obfuscation for easier debugging.</p>
$is_in_debug_mode - bool Defaults to false.
$is_in_debug_mode
Arguments: array()
Arguments: 200, $this
Max number of paths to be processed per step
<p>Number of files processed is directly dependent on this.</p>
Arguments: $limit, $this->is_excludable()
$paths_count - intNumber of paths to process.
$paths_count
$is_excludable - boolWhether we're excluding files (false means preflight).
$is_excludable
Max number of bytes to process per step
$bytes - intNumber of bytes to process.
$bytes
Whether to actually include this item in list processing
Arguments: true, $item
$item - stringItem path.
$item
Gets the working directory root path
<p>Defaults to system temp directory, or best guesstimate.</p>
Arguments: get_temp_dir()
$root_path - stringTemporary working directory.
$root_path
Gets the actual working directory path
Arguments: $shipper_dir
$shipper_dir - stringShipper working directory path.
$shipper_dir
Stale locks cleanup check
<p>This is how we decide whether to clear stale locks. We are doing this because clearing "stale" locks messes up the import process if set_time_limit <em>actually</em> does what it's supposed to do, which might not always be the case :(</p>
$forbid_cleanup - boolIf true, stale locks will not be cleared.
$forbid_cleanup
Gets the site-specific obfuscation key
Arguments: $key, $fallback
$key - stringSite-specific obfuscation key.
$key
$fallback - stringOptional provided fallback.
$fallback
Allows for domain-with-scheme macro opting out
$include_scheme_macro - boolWhether to include the scheme macro.
$include_scheme_macro
Arguments: $this->get_replacements_list()
Arguments: $this->get_original_value($original)
Gets the update interval for Heartbeat API
Arguments: 15
$update_interval - int, stringHeartbeat update interval.
$update_interval
int, string
Returns FS path to shipper icon.
<p>Used in tests.</p>
Arguments: plugin_dir_path(SHIPPER_PLUGIN_FILE) . 'assets/img/anchor.svg'
$icon_path - stringPath to icon.
$icon_path
Arguments: ''
Arguments: $default
Arguments: 5
Max exec time before limit optimization
Arguments: self::$_max_exec_time
$time - intMaximum execution time.
$time
Maximum execution time
Arguments: 180
Whether a function call is disabled.
Arguments: !$callable, $func
$disabled - boolWhether a function call is disabled.
$disabled
$func - stringFunction to check.
$func
Whether an ini key is changeable.
Arguments: wp_is_ini_value_changeable($what), $what
$changeable - boolWhether the key is changeable.
$changeable
$what - stringIni key to check.
$what
Checks whether we're in PHP safe mode.
Arguments: !empty($is_safe_mode) && 'off' !== $is_safe_mode
$is_in_safe_mode - boolWhether we're in safe mode.
$is_in_safe_mode
Resolved table names, according to unpacked files
$tables - arrayResolved table names.
The row values to be updated in the destination table.
Arguments: $dest_row, $row, $table
$dest_row - arrayProcessed row values.
$dest_row
$row - arraySource (unprocessed) row.
$row
$table - stringTable that the row belongs to.
Arguments: $this->get_destination_table()
Arguments: false, $table
Row size limit, in bytes
Arguments: $limit, $table
$limit - intSize, in bytes.
Whether to include transients in migration
Arguments: true, $raw, $table
$include - boolWhether to include transients in export.
$include
$raw - arrayRaw row hash.
$raw
Whether to include this row in migration
Arguments: $include, $raw, $table
$include - boolWhether to include the row in export.
Decide whether we're in an auth-requiring environment.
<p>Used in building ping request arguments to establish runner execution context.</p>
Arguments: \Shipper_Model_Env::is_wp_engine()
$is_auth - boolCheck result this far.
$is_auth
Whether or not we're dealing with Flywheel environment
Arguments: defined('FLYWHEEL_PLUGIN_DIR')
$is_flywheel - boolFlywheel environment detected.
$is_flywheel
Maximum individual file size allowed before issuing a warning
Arguments: $max
$max - intMaximum file size, in bytes.
$max
Maximum raw package size allowed before issuing a warning
$max - intMaximum package size, in bytes.
Arguments: self::THRESHOLD_KICKSTARTS
Cancel await max time
<p>Default 30 secs, in microseconds.</p>
Arguments: (int) ((double) $secs * $micro)
$time - intTime to spend awaiting cancel lock, in microseconds.
Cancel await step
<p>Default 1 sec, in microseconds.</p>
Arguments: (int) ((double) $step * $micro)
$time - intTime to spend hibernating between cancel lock checks, in microseconds.
Gets domain-based unique site identifier
Arguments: preg_replace('/-+/', '-', $id), $prefix
$uniqid - stringSafe-ranged identifier.
$uniqid
$prefix - stringOptional prefix.
$prefix
List of users allowed to access WPMU DEV Dashboard
Arguments: $dash_users
$dash_users - arrayA list of users allowed to access WPMU DEV Dashboard.
$dash_users