Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* The error handler to suppress error messages from vendor directories.

[2] Fix | Delete

[3] Fix | Delete

[4] Fix | Delete

// phpcs:ignore Generic.Commenting.DocComment.MissingShort

[5] Fix | Delete

/** @noinspection PhpUndefinedClassInspection */

[6] Fix | Delete

[7] Fix | Delete

namespace WPForms;

[8] Fix | Delete

[9] Fix | Delete

use QM_Collectors;

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Class ErrorHandler.

[13] Fix | Delete

[14] Fix | Delete

* @since 1.8.5

[15] Fix | Delete

[16] Fix | Delete

class ErrorHandler {

[17] Fix | Delete

[18] Fix | Delete

/**

[19] Fix | Delete

* Directories from where errors should be suppressed.

[20] Fix | Delete

[21] Fix | Delete

* @since 1.8.5

[22] Fix | Delete

[23] Fix | Delete

* @var string[]

[24] Fix | Delete

[25] Fix | Delete

protected $dirs;

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Previous error handler.

[29] Fix | Delete

[30] Fix | Delete

* @since 1.8.6

[31] Fix | Delete

[32] Fix | Delete

* @var callable|null

[33] Fix | Delete

[34] Fix | Delete

private $previous_error_handler;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Error levels to suppress.

[38] Fix | Delete

[39] Fix | Delete

* @since 1.8.6

[40] Fix | Delete

[41] Fix | Delete

* @var int

[42] Fix | Delete

[43] Fix | Delete

protected $levels;

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Whether the error handler is handling an error.

[47] Fix | Delete

[48] Fix | Delete

* @since 1.9.2

[49] Fix | Delete

[50] Fix | Delete

* @var bool

[51] Fix | Delete

[52] Fix | Delete

private $handling = false;

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Class constructor.

[56] Fix | Delete

[57] Fix | Delete

* @since 1.9.3

[58] Fix | Delete

[59] Fix | Delete

* @param array $dirs Directories from where errors should be suppressed.

[60] Fix | Delete

* @param int $levels Error levels to suppress.

[61] Fix | Delete

[62] Fix | Delete

public function __construct( array $dirs = [], int $levels = 0 ) {

[63] Fix | Delete

[64] Fix | Delete

$this->dirs = $dirs;

[65] Fix | Delete

$this->levels = $levels;

[66] Fix | Delete

}

[67] Fix | Delete

[68] Fix | Delete

/**

[69] Fix | Delete

* Init class.

[70] Fix | Delete

[71] Fix | Delete

* @since 1.8.5

[72] Fix | Delete

[73] Fix | Delete

* @return void

[74] Fix | Delete

* @noinspection PhpUndefinedConstantInspection

[75] Fix | Delete

[76] Fix | Delete

public function init() {

[77] Fix | Delete

[78] Fix | Delete

if ( defined( 'WPFORMS_DISABLE_ERROR_HANDLER' ) && WPFORMS_DISABLE_ERROR_HANDLER ) {

[79] Fix | Delete

return;

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

$this->dirs = [

[83] Fix | Delete

// WPForms.

[84] Fix | Delete

WPFORMS_PLUGIN_DIR . 'vendor/',

[85] Fix | Delete

WPFORMS_PLUGIN_DIR . 'vendor_prefixed/',

[86] Fix | Delete

// Addons.

[87] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-activecampaign/vendor/',

[88] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-authorize-net/vendor/',

[89] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-aweber/deprecated/',

[90] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-aweber/vendor/',

[91] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-calculations/vendor/',

[92] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-campaign-monitor/vendor/',

[93] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-captcha/vendor/',

[94] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-conversational-forms/vendor/',

[95] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-convertkit/vendor/',

[96] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-convertkit/vendor_prefixed/',

[97] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-coupons/vendor/',

[98] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-drip/vendor/',

[99] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-e2e-helpers/vendor/',

[100] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-entry-automation/vendor/',

[101] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-form-abandonment/vendor/',

[102] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-form-locker/vendor/',

[103] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-form-pages/vendor/',

[104] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-geolocation/vendor/',

[105] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-getresponse/vendor/',

[106] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-google-sheets/vendor/',

[107] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-hubspot/vendor/',

[108] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-lead-forms/vendor/',

[109] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-mailchimp/vendor/',

[110] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-mailerlite/vendor/',

[111] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-offline-forms/vendor/',

[112] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-paypal-commerce/vendor/',

[113] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-paypal-standard/vendor/',

[114] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-post-submissions/vendor/',

[115] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-salesforce/vendor/',

[116] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-salesforce/vendor_prefixed/',

[117] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-save-resume/vendor/',

[118] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-sendinblue/vendor/',

[119] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-signatures/vendor/',

[120] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-square/vendor/', // Backward compatibility.

[121] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-stripe/vendor/',

[122] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-surveys-polls/vendor/',

[123] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-user-journey/vendor/',

[124] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-user-registration/vendor/',

[125] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-webhooks/vendor/',

[126] Fix | Delete

WP_PLUGIN_DIR . '/wpforms-zapier/vendor/',

[127] Fix | Delete

];

[128] Fix | Delete

[129] Fix | Delete

/**

[130] Fix | Delete

* Allow modifying the list of dirs to suppress messages from.

[131] Fix | Delete

[132] Fix | Delete

* @since 1.8.6

[133] Fix | Delete

[134] Fix | Delete

* @param array $dirs The list of dirs to suppress messages from.

[135] Fix | Delete

[136] Fix | Delete

$this->dirs = (array) apply_filters( 'wpforms_error_handler_dirs', $this->dirs );

[137] Fix | Delete

[138] Fix | Delete

$this->normalize_dirs();

[139] Fix | Delete

[140] Fix | Delete

/**

[141] Fix | Delete

* Allow modifying the levels of messages to suppress.

[142] Fix | Delete

[143] Fix | Delete

* @since 1.8.6

[144] Fix | Delete

[145] Fix | Delete

* @param int $levels Error levels of messages to suppress.

[146] Fix | Delete

[147] Fix | Delete

$this->levels = (int) apply_filters(

[148] Fix | Delete

'wpforms_error_handler_levels',

[149] Fix | Delete

[150] Fix | Delete

);

[151] Fix | Delete

[152] Fix | Delete

$this->hooks();

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* Add hooks.

[157] Fix | Delete

[158] Fix | Delete

* @since 1.9.1

[159] Fix | Delete

[160] Fix | Delete

* @return void

[161] Fix | Delete

[162] Fix | Delete

protected function hooks() {

[163] Fix | Delete

[164] Fix | Delete

if ( $this->dirs && $this->levels ) {

[165] Fix | Delete

// Set error handler.

[166] Fix | Delete

$this->set_error_handler();

[167] Fix | Delete

[168] Fix | Delete

// Some plugins destroy an error handler chain. Set the error handler again upon loading them.

[169] Fix | Delete

add_action( 'plugins_loaded', [ $this, 'plugins_loaded' ], 1000 );

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

// Suppress the _load_textdomain_just_in_time() notices related the WPForms for WP 6.7+.

[173] Fix | Delete

if ( version_compare( $GLOBALS['wp_version'], '6.7', '>=' ) ) {

[174] Fix | Delete

add_action( 'doing_it_wrong_run', [ $this,'action_doing_it_wrong_run' ], 0, 3 );

[175] Fix | Delete

add_action( 'doing_it_wrong_run', [ $this,'action_doing_it_wrong_run' ], 20, 3 );

[176] Fix | Delete

add_filter( 'doing_it_wrong_trigger_error', [ $this, 'filter_doing_it_wrong_trigger_error' ], 10, 4 );

[177] Fix | Delete

}

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

/**

[181] Fix | Delete

* Set error handler and save original.

[182] Fix | Delete

[183] Fix | Delete

* @since 1.9.1

[184] Fix | Delete

[185] Fix | Delete

public function set_error_handler() {

[186] Fix | Delete

[187] Fix | Delete

// To chain error handlers, we must not specify the second argument and catch all errors in our handler.

[188] Fix | Delete

// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_set_error_handler

[189] Fix | Delete

$this->previous_error_handler = set_error_handler( [ $this, 'error_handler' ] );

[190] Fix | Delete

}

[191] Fix | Delete

[192] Fix | Delete

/**

[193] Fix | Delete

* The 'plugins_loaded' hook.

[194] Fix | Delete

[195] Fix | Delete

* @since 0.32

[196] Fix | Delete

[197] Fix | Delete

* @return void

[198] Fix | Delete

[199] Fix | Delete

public function plugins_loaded() {

[200] Fix | Delete

[201] Fix | Delete

// Constants of plugins that destroy an error handler chain.

[202] Fix | Delete

$constants = [

[203] Fix | Delete

'QM_VERSION', // Query Monitor.

[204] Fix | Delete

'AUTOMATOR_PLUGIN_VERSION', // Uncanny Automator.

[205] Fix | Delete

];

[206] Fix | Delete

[207] Fix | Delete

$found = false;

[208] Fix | Delete

[209] Fix | Delete

foreach ( $constants as $constant ) {

[210] Fix | Delete

if ( defined( $constant ) ) {

[211] Fix | Delete

$found = true;

[212] Fix | Delete

[213] Fix | Delete

break;

[214] Fix | Delete

}

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

if ( ! $found ) {

[218] Fix | Delete

return;

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

// Set this error handler after loading a plugin to chain its error handler.

[222] Fix | Delete

( new self( $this->dirs, $this->levels ) )->set_error_handler();

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Error handler.

[227] Fix | Delete

[228] Fix | Delete

* @since 1.8.5

[229] Fix | Delete

[230] Fix | Delete

* @param int $level Error level.

[231] Fix | Delete

* @param string $message Error message.

[232] Fix | Delete

* @param string $file File produced an error.

[233] Fix | Delete

* @param int $line Line number.

[234] Fix | Delete

[235] Fix | Delete

* @return bool

[236] Fix | Delete

* @noinspection PhpTernaryExpressionCanBeReplacedWithConditionInspection

[237] Fix | Delete

[238] Fix | Delete

public function error_handler( int $level, string $message, string $file, int $line ): bool { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed

[239] Fix | Delete

[240] Fix | Delete

if ( $this->handling ) {

[241] Fix | Delete

$this->handling = false;

[242] Fix | Delete

[243] Fix | Delete

// Prevent infinite recursion and fallback to standard error handler.

[244] Fix | Delete

return false;

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

$this->handling = true;

[248] Fix | Delete

[249] Fix | Delete

if ( ( $level & $this->levels ) === 0 ) {

[250] Fix | Delete

// Not served error level, use fallback error handler.

[251] Fix | Delete

// phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection

[252] Fix | Delete

return $this->fallback_error_handler( func_get_args() );

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

// Process error.

[256] Fix | Delete

$normalized_file = str_replace( DIRECTORY_SEPARATOR, '/', $file );

[257] Fix | Delete

[258] Fix | Delete

foreach ( $this->dirs as $dir ) {

[259] Fix | Delete

if ( strpos( $normalized_file, $dir ) !== false ) {

[260] Fix | Delete

$this->handling = false;

[261] Fix | Delete

[262] Fix | Delete

// Suppress deprecated errors from this directory.

[263] Fix | Delete

return true;

[264] Fix | Delete

}

[265] Fix | Delete

}

[266] Fix | Delete

[267] Fix | Delete

// Not served directory, use fallback error handler.

[268] Fix | Delete

// phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection

[269] Fix | Delete

return $this->fallback_error_handler( func_get_args() );

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Action for _doing_it_wrong() calls.

[274] Fix | Delete

[275] Fix | Delete

* @since 1.9.2.2

[276] Fix | Delete

[277] Fix | Delete

* @param string $function_name The function that was called.

[278] Fix | Delete

* @param string $message A message explaining what has been done incorrectly.

[279] Fix | Delete

* @param string $version The version of WordPress where the message was added.

[280] Fix | Delete

[281] Fix | Delete

* @return void

[282] Fix | Delete

* @noinspection PhpMissingParamTypeInspection

[283] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[284] Fix | Delete

[285] Fix | Delete

public function action_doing_it_wrong_run( $function_name, $message, $version ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed, WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks

[286] Fix | Delete

[287] Fix | Delete

global $wp_filter;

[288] Fix | Delete

[289] Fix | Delete

$function_name = (string) $function_name;

[290] Fix | Delete

$message = (string) $message;

[291] Fix | Delete

[292] Fix | Delete

if ( ! class_exists( 'QM_Collectors' ) || ! $this->is_just_in_time_for_wpforms_domain( $function_name, $message ) ) {

[293] Fix | Delete

return;

[294] Fix | Delete

}

[295] Fix | Delete

[296] Fix | Delete

$qm_collector_doing_it_wrong = QM_Collectors::get( 'doing_it_wrong' );

[297] Fix | Delete

$current_priority = $wp_filter['doing_it_wrong_run']->current_priority();

[298] Fix | Delete

[299] Fix | Delete

if ( $qm_collector_doing_it_wrong === null || $current_priority === false ) {

[300] Fix | Delete

return;

[301] Fix | Delete

}

[302] Fix | Delete

[303] Fix | Delete

switch ( $current_priority ) {

[304] Fix | Delete

case 0:

[305] Fix | Delete

remove_action( 'doing_it_wrong_run', [ $qm_collector_doing_it_wrong, 'action_doing_it_wrong_run' ] );

[306] Fix | Delete

break;

[307] Fix | Delete

[308] Fix | Delete

case 20:

[309] Fix | Delete

add_action( 'doing_it_wrong_run', [ $qm_collector_doing_it_wrong, 'action_doing_it_wrong_run' ], 10, 3 );

[310] Fix | Delete

break;

[311] Fix | Delete

[312] Fix | Delete

default:

[313] Fix | Delete

break;

[314] Fix | Delete

}

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

/**

[318] Fix | Delete

* Filter for _doing_it_wrong() calls.

[319] Fix | Delete

[320] Fix | Delete

* @since 1.9.2.2

[321] Fix | Delete

[322] Fix | Delete

* @param bool|mixed $trigger Whether to trigger the error for _doing_it_wrong() calls. Default true.

[323] Fix | Delete

* @param string $function_name The function that was called.

[324] Fix | Delete

* @param string $message A message explaining what has been done incorrectly.

[325] Fix | Delete

* @param string $version The version of WordPress where the message was added.

[326] Fix | Delete

[327] Fix | Delete

* @return bool

[328] Fix | Delete

* @noinspection PhpMissingParamTypeInspection

[329] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[330] Fix | Delete

[331] Fix | Delete

public function filter_doing_it_wrong_trigger_error( $trigger, $function_name, $message, $version ): bool { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed

[332] Fix | Delete

[333] Fix | Delete

$trigger = (bool) $trigger;

[334] Fix | Delete

$function_name = (string) $function_name;

[335] Fix | Delete

$message = (string) $message;

[336] Fix | Delete

[337] Fix | Delete

return $this->is_just_in_time_for_wpforms_domain( $function_name, $message ) ? false : $trigger;

[338] Fix | Delete

}

[339] Fix | Delete

[340] Fix | Delete

/**

[341] Fix | Delete

* Filter for gettext.

[342] Fix | Delete

[343] Fix | Delete

* @since 1.9.2.2

[344] Fix | Delete

* @deprecated 1.9.3

[345] Fix | Delete

[346] Fix | Delete

* @param string|mixed $translation Translated text.

[347] Fix | Delete

* @param string|mixed $text Text to translate.

[348] Fix | Delete

* @param string|mixed $domain Text domain. Unique identifier for retrieving translated strings.

[349] Fix | Delete

[350] Fix | Delete

* @return string|mixed

[351] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[352] Fix | Delete

[353] Fix | Delete

public function filter_gettext( $translation, $text, $domain ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed

[354] Fix | Delete

[355] Fix | Delete

_deprecated_function( __METHOD__, '1.9.3 of the WPForms plugin' );

[356] Fix | Delete

[357] Fix | Delete

return $translation;

[358] Fix | Delete

}

[359] Fix | Delete

[360] Fix | Delete

/**

[361] Fix | Delete

* Fallback error handler.

[362] Fix | Delete

[363] Fix | Delete

* @since 1.9.2

[364] Fix | Delete

[365] Fix | Delete

* @param array $args Arguments.

[366] Fix | Delete

[367] Fix | Delete

* @return bool

[368] Fix | Delete

* @noinspection PhpTernaryExpressionCanBeReplacedWithConditionInspection

[369] Fix | Delete

[370] Fix | Delete

private function fallback_error_handler( array $args ): bool {

[371] Fix | Delete

[372] Fix | Delete

$result = $this->previous_error_handler === null ?

[373] Fix | Delete

// Use standard error handler.

[374] Fix | Delete

false :

[375] Fix | Delete

(bool) call_user_func_array( $this->previous_error_handler, $args );

[376] Fix | Delete

[377] Fix | Delete

$this->handling = false;

[378] Fix | Delete

[379] Fix | Delete

return $result;

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

/**

[383] Fix | Delete

* Normalize dirs.

[384] Fix | Delete

[385] Fix | Delete

* @since 1.9.2

[386] Fix | Delete

[387] Fix | Delete

* @return void

[388] Fix | Delete

[389] Fix | Delete

private function normalize_dirs() {

[390] Fix | Delete

[391] Fix | Delete

$this->dirs = array_filter(

[392] Fix | Delete

array_map(

[393] Fix | Delete

static function ( $dir ) {

[394] Fix | Delete

[395] Fix | Delete

return str_replace( DIRECTORY_SEPARATOR, '/', trim( $dir ) );

[396] Fix | Delete

[397] Fix | Delete

$this->dirs

[398] Fix | Delete

)

[399] Fix | Delete

);

[400] Fix | Delete

}

[401] Fix | Delete

[402] Fix | Delete

/**

[403] Fix | Delete

* Whether it is the just_in_time_error for WPForms-related domains.

[404] Fix | Delete

[405] Fix | Delete

* @since 1.9.2.2

[406] Fix | Delete

[407] Fix | Delete

* @param string $function_name Function name.

[408] Fix | Delete

* @param string $message Message.

[409] Fix | Delete

[410] Fix | Delete

* @return bool

[411] Fix | Delete

[412] Fix | Delete

protected function is_just_in_time_for_wpforms_domain( string $function_name, string $message ): bool {

[413] Fix | Delete

[414] Fix | Delete

return $function_name === '_load_textdomain_just_in_time' && strpos( $message, '<code>wpforms' ) !== false;

[415] Fix | Delete

}

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete