Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms {

[2] Fix | Delete

[3] Fix | Delete

use AllowDynamicProperties;

[4] Fix | Delete

use stdClass;

[5] Fix | Delete

use WPForms\Helpers\DB;

[6] Fix | Delete

use WPForms_Form_Handler;

[7] Fix | Delete

use WPForms_Process;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Main WPForms class.

[11] Fix | Delete

[12] Fix | Delete

* @since 1.0.0

[13] Fix | Delete

[14] Fix | Delete

#[AllowDynamicProperties]

[15] Fix | Delete

final class WPForms {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* One is the loneliest number that you'll ever do.

[19] Fix | Delete

[20] Fix | Delete

* @since 1.0.0

[21] Fix | Delete

[22] Fix | Delete

* @var \WPForms\WPForms

[23] Fix | Delete

[24] Fix | Delete

private static $instance;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Plugin version for enqueueing, etc.

[28] Fix | Delete

* The value is got from WPFORMS_VERSION constant.

[29] Fix | Delete

[30] Fix | Delete

* @since 1.0.0

[31] Fix | Delete

[32] Fix | Delete

* @var string

[33] Fix | Delete

[34] Fix | Delete

public $version = '';

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Classes registry.

[38] Fix | Delete

[39] Fix | Delete

* @since 1.5.7

[40] Fix | Delete

[41] Fix | Delete

* @var array

[42] Fix | Delete

[43] Fix | Delete

private $registry = [];

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* List of legacy public properties.

[47] Fix | Delete

[48] Fix | Delete

* @since 1.6.8

[49] Fix | Delete

[50] Fix | Delete

* @var string[]

[51] Fix | Delete

[52] Fix | Delete

private $legacy_properties = [

[53] Fix | Delete

'form',

[54] Fix | Delete

'entry',

[55] Fix | Delete

'entry_fields',

[56] Fix | Delete

'entry_meta',

[57] Fix | Delete

'frontend',

[58] Fix | Delete

'process',

[59] Fix | Delete

'smart_tags',

[60] Fix | Delete

'license',

[61] Fix | Delete

];

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Paid returns true, free (Lite) returns false.

[65] Fix | Delete

[66] Fix | Delete

* @since 1.3.9

[67] Fix | Delete

* @since 1.7.3 changed to private.

[68] Fix | Delete

[69] Fix | Delete

* @var bool

[70] Fix | Delete

[71] Fix | Delete

private $pro = false;

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Backward compatibility method for accessing the class registry in an old way,

[75] Fix | Delete

* e.g. 'wpforms()->form' or 'wpforms()->entry'.

[76] Fix | Delete

[77] Fix | Delete

* @since 1.5.7

[78] Fix | Delete

[79] Fix | Delete

* @param string $name Name of the object to get.

[80] Fix | Delete

[81] Fix | Delete

* @return mixed|null

[82] Fix | Delete

[83] Fix | Delete

public function __get( $name ) {

[84] Fix | Delete

[85] Fix | Delete

if ( $name === 'smart_tags' ) {

[86] Fix | Delete

_deprecated_argument(

[87] Fix | Delete

'wpforms()->smart_tags',

[88] Fix | Delete

'1.6.7 of the WPForms plugin',

[89] Fix | Delete

"Please use `wpforms()->get( 'smart_tags' )` instead."

[90] Fix | Delete

);

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

if ( $name === 'pro' ) {

[94] Fix | Delete

_deprecated_argument(

[95] Fix | Delete

'wpforms()->pro',

[96] Fix | Delete

'1.8.2.2 of the WPForms plugin',

[97] Fix | Delete

'Please use `wpforms()->is_pro()` instead.'

[98] Fix | Delete

);

[99] Fix | Delete

[100] Fix | Delete

return wpforms()->is_pro();

[101] Fix | Delete

}

[102] Fix | Delete

[103] Fix | Delete

return $this->get( $name );

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Main WPForms Instance.

[108] Fix | Delete

[109] Fix | Delete

* Only one instance of WPForms exists in memory at any one time.

[110] Fix | Delete

* Also prevent the need to define globals all over the place.

[111] Fix | Delete

[112] Fix | Delete

* @since 1.0.0

[113] Fix | Delete

[114] Fix | Delete

* @return WPForms

[115] Fix | Delete

[116] Fix | Delete

public static function instance() {

[117] Fix | Delete

[118] Fix | Delete

if (

[119] Fix | Delete

self::$instance === null ||

[120] Fix | Delete

! self::$instance instanceof self

[121] Fix | Delete

) {

[122] Fix | Delete

[123] Fix | Delete

self::$instance = new self();

[124] Fix | Delete

[125] Fix | Delete

self::$instance->constants();

[126] Fix | Delete

self::$instance->includes();

[127] Fix | Delete

[128] Fix | Delete

// Load Pro or Lite specific files.

[129] Fix | Delete

if ( self::$instance->is_pro() ) {

[130] Fix | Delete

self::$instance->registry['pro'] = require_once WPFORMS_PLUGIN_DIR . 'pro/wpforms-pro.php';

[131] Fix | Delete

} else {

[132] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'lite/wpforms-lite.php';

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

add_action( 'plugins_loaded', [ self::$instance, 'objects' ], 10 );

[136] Fix | Delete

}

[137] Fix | Delete

[138] Fix | Delete

return self::$instance;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Setup plugin constants.

[143] Fix | Delete

* All the path/URL related constants are defined in main plugin file.

[144] Fix | Delete

[145] Fix | Delete

* @since 1.0.0

[146] Fix | Delete

[147] Fix | Delete

private function constants() {

[148] Fix | Delete

[149] Fix | Delete

$this->version = WPFORMS_VERSION;

[150] Fix | Delete

[151] Fix | Delete

// Plugin Slug - Determine plugin type and set slug accordingly.

[152] Fix | Delete

// This filter is documented in \WPForms\WPForms::is_pro.

[153] Fix | Delete

if ( apply_filters( 'wpforms_allow_pro_version', file_exists( WPFORMS_PLUGIN_DIR . 'pro/wpforms-pro.php' ) ) ) {

[154] Fix | Delete

$this->pro = true;

[155] Fix | Delete

[156] Fix | Delete

define( 'WPFORMS_PLUGIN_SLUG', 'wpforms' );

[157] Fix | Delete

} else {

[158] Fix | Delete

define( 'WPFORMS_PLUGIN_SLUG', 'wpforms-lite' );

[159] Fix | Delete

}

[160] Fix | Delete

}

[161] Fix | Delete

[162] Fix | Delete

/**

[163] Fix | Delete

* Include files.

[164] Fix | Delete

[165] Fix | Delete

* @since 1.0.0

[166] Fix | Delete

[167] Fix | Delete

private function includes() {

[168] Fix | Delete

[169] Fix | Delete

$this->error_handler();

[170] Fix | Delete

[171] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-db.php';

[172] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/functions.php';

[173] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/compat.php';

[174] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/fields/class-base.php';

[175] Fix | Delete

[176] Fix | Delete

$this->includes_magic();

[177] Fix | Delete

[178] Fix | Delete

// Global includes.

[179] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-install.php';

[180] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-form.php';

[181] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-fields.php';

[182] Fix | Delete

// TODO: class-templates.php should be loaded in admin area only.

[183] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-templates.php';

[184] Fix | Delete

// TODO: class-providers.php should be loaded in admin area only.

[185] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-providers.php';

[186] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-process.php';

[187] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/class-widget.php';

[188] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/emails/class-emails.php';

[189] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/integrations.php';

[190] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/deprecated.php';

[191] Fix | Delete

[192] Fix | Delete

// Admin/Dashboard only includes, also in ajax.

[193] Fix | Delete

if ( is_admin() ) {

[194] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/admin.php';

[195] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/class-notices.php';

[196] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/class-menu.php';

[197] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/builder/class-builder.php';

[198] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/builder/functions.php';

[199] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/class-settings.php';

[200] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/class-welcome.php';

[201] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/class-editor.php';

[202] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/class-review.php';

[203] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/class-about.php';

[204] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'includes/admin/ajax-actions.php';

[205] Fix | Delete

}

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Include the error handler to suppress deprecated messages from vendor folders.

[210] Fix | Delete

[211] Fix | Delete

* @since 1.8.5

[212] Fix | Delete

[213] Fix | Delete

private function error_handler() {

[214] Fix | Delete

[215] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'src/ErrorHandler.php';

[216] Fix | Delete

[217] Fix | Delete

( new ErrorHandler() )->init();

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Including the new files with PHP 5.3 style.

[222] Fix | Delete

[223] Fix | Delete

* @since 1.4.7

[224] Fix | Delete

[225] Fix | Delete

private function includes_magic() {

[226] Fix | Delete

[227] Fix | Delete

// Action Scheduler requires a special loading procedure.

[228] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'vendor/woocommerce/action-scheduler/action-scheduler.php';

[229] Fix | Delete

[230] Fix | Delete

// Autoload Composer packages.

[231] Fix | Delete

require_once WPFORMS_PLUGIN_DIR . 'vendor/autoload.php';

[232] Fix | Delete

[233] Fix | Delete

// Load the class loader.

[234] Fix | Delete

$this->register(

[235] Fix | Delete

[

[236] Fix | Delete

'name' => 'Loader',

[237] Fix | Delete

'hook' => false,

[238] Fix | Delete

]

[239] Fix | Delete

);

[240] Fix | Delete

[241] Fix | Delete

[242] Fix | Delete

* Load admin components. Exclude from frontend.

[243] Fix | Delete

[244] Fix | Delete

if ( is_admin() ) {

[245] Fix | Delete

add_action( 'wpforms_loaded', [ '\WPForms\Admin\Loader', 'get_instance' ] );

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

[249] Fix | Delete

* Properly init the providers loader, that will handle all the related logic and further loading.

[250] Fix | Delete

[251] Fix | Delete

add_action( 'wpforms_loaded', [ '\WPForms\Providers\Providers', 'get_instance' ] );

[252] Fix | Delete

[253] Fix | Delete

[254] Fix | Delete

* Properly init the integrations loader, that will handle all the related logic and further loading.

[255] Fix | Delete

[256] Fix | Delete

add_action( 'wpforms_loaded', [ '\WPForms\Integrations\Loader', 'get_instance' ] );

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

/**

[260] Fix | Delete

* Setup objects.

[261] Fix | Delete

[262] Fix | Delete

* @since 1.0.0

[263] Fix | Delete

[264] Fix | Delete

public function objects() {

[265] Fix | Delete

[266] Fix | Delete

// Global objects.

[267] Fix | Delete

$this->registry['form'] = new WPForms_Form_Handler();

[268] Fix | Delete

$this->registry['process'] = new WPForms_Process();

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Executes when all the WPForms stuff was loaded.

[272] Fix | Delete

[273] Fix | Delete

* @since 1.4.0

[274] Fix | Delete

[275] Fix | Delete

do_action( 'wpforms_loaded' );

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

/**

[279] Fix | Delete

* Register a class.

[280] Fix | Delete

[281] Fix | Delete

* @since 1.5.7

[282] Fix | Delete

[283] Fix | Delete

* @param array $class_data Class registration info.

[284] Fix | Delete

[285] Fix | Delete

* $class_data array accepts these params: name, id, hook, run, condition.

[286] Fix | Delete

* - name: required -- class name to register.

[287] Fix | Delete

* - id: optional -- class ID to register.

[288] Fix | Delete

* - hook: optional -- hook to register the class on -- default wpforms_loaded.

[289] Fix | Delete

* - run: optional -- method to run on class instantiation -- default init.

[290] Fix | Delete

* - condition: optional -- condition to check before registering the class.

[291] Fix | Delete

[292] Fix | Delete

public function register( $class_data ) { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.MaxExceeded, WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks

[293] Fix | Delete

[294] Fix | Delete

if ( empty( $class_data['name'] ) || ! is_string( $class_data['name'] ) ) {

[295] Fix | Delete

return;

[296] Fix | Delete

}

[297] Fix | Delete

[298] Fix | Delete

if ( isset( $class_data['condition'] ) && empty( $class_data['condition'] ) ) {

[299] Fix | Delete

return;

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

$full_name = $this->is_pro() ? '\WPForms\Pro\\' . $class_data['name'] : '\WPForms\Lite\\' . $class_data['name'];

[303] Fix | Delete

$full_name = class_exists( $full_name ) ? $full_name : '\WPForms\\' . $class_data['name'];

[304] Fix | Delete

[305] Fix | Delete

if ( ! class_exists( $full_name ) ) {

[306] Fix | Delete

return;

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

$id = $class_data['id'] ?? '';

[310] Fix | Delete

$id = $id ? preg_replace( '/[^a-z_]/', '', (string) $id ) : $id;

[311] Fix | Delete

$hook = isset( $class_data['hook'] ) ? (string) $class_data['hook'] : 'wpforms_loaded';

[312] Fix | Delete

$run = $class_data['run'] ?? 'init';

[313] Fix | Delete

$priority = isset( $class_data['priority'] ) && is_int( $class_data['priority'] ) ? $class_data['priority'] : 10;

[314] Fix | Delete

[315] Fix | Delete

$callback = function () use ( $full_name, $id, $run ) {

[316] Fix | Delete

[317] Fix | Delete

// Instantiate class.

[318] Fix | Delete

$instance = new $full_name();

[319] Fix | Delete

[320] Fix | Delete

$this->register_instance( $id, $instance );

[321] Fix | Delete

[322] Fix | Delete

if ( $run && method_exists( $instance, $run ) ) {

[323] Fix | Delete

$instance->{$run}();

[324] Fix | Delete

}

[325] Fix | Delete

};

[326] Fix | Delete

[327] Fix | Delete

if ( $hook ) {

[328] Fix | Delete

add_action( $hook, $callback, $priority );

[329] Fix | Delete

} else {

[330] Fix | Delete

$callback();

[331] Fix | Delete

}

[332] Fix | Delete

}

[333] Fix | Delete

[334] Fix | Delete

/**

[335] Fix | Delete

* Register any class instance.

[336] Fix | Delete

[337] Fix | Delete

* @since 1.8.6

[338] Fix | Delete

[339] Fix | Delete

* @param string $id Class ID.

[340] Fix | Delete

* @param object $instance Any class instance (object).

[341] Fix | Delete

[342] Fix | Delete

public function register_instance( $id, $instance ) {

[343] Fix | Delete

[344] Fix | Delete

if ( $id && is_object( $instance ) && ! array_key_exists( $id, $this->registry ) ) {

[345] Fix | Delete

$this->registry[ $id ] = $instance;

[346] Fix | Delete

}

[347] Fix | Delete

}

[348] Fix | Delete

[349] Fix | Delete

/**

[350] Fix | Delete

* Register classes in bulk.

[351] Fix | Delete

[352] Fix | Delete

* @since 1.5.7

[353] Fix | Delete

[354] Fix | Delete

* @param array $classes Classes to register.

[355] Fix | Delete

[356] Fix | Delete

public function register_bulk( $classes ) {

[357] Fix | Delete

[358] Fix | Delete

if ( ! is_array( $classes ) ) {

[359] Fix | Delete

return;

[360] Fix | Delete

}

[361] Fix | Delete

[362] Fix | Delete

foreach ( $classes as $class ) {

[363] Fix | Delete

$this->register( $class );

[364] Fix | Delete

}

[365] Fix | Delete

}

[366] Fix | Delete

[367] Fix | Delete

/**

[368] Fix | Delete

* Get a class instance from a registry.

[369] Fix | Delete

[370] Fix | Delete

* @since 1.5.7

[371] Fix | Delete

[372] Fix | Delete

* @param string $name Class name or an alias.

[373] Fix | Delete

[374] Fix | Delete

* @return mixed|stdClass|null

[375] Fix | Delete

[376] Fix | Delete

public function get( $name ) {

[377] Fix | Delete

[378] Fix | Delete

if ( ! empty( $this->registry[ $name ] ) ) {

[379] Fix | Delete

return $this->registry[ $name ];

[380] Fix | Delete

}

[381] Fix | Delete

[382] Fix | Delete

// Backward compatibility for old public properties.

[383] Fix | Delete

// Return null to save old condition for these properties.

[384] Fix | Delete

if ( in_array( $name, $this->legacy_properties, true ) ) {

[385] Fix | Delete

return isset( $this->{$name} ) ? $this->{$name} : null;

[386] Fix | Delete

}

[387] Fix | Delete

[388] Fix | Delete

return new stdClass();

[389] Fix | Delete

}

[390] Fix | Delete

[391] Fix | Delete

/**

[392] Fix | Delete

* Get the list of all custom tables starting with `wpforms_*`.

[393] Fix | Delete

[394] Fix | Delete

* @since 1.6.3

[395] Fix | Delete

[396] Fix | Delete

* @return array List of table names.

[397] Fix | Delete

[398] Fix | Delete

public function get_existing_custom_tables(): array {

[399] Fix | Delete

[400] Fix | Delete

// phpcs:ignore WPForms.Formatting.EmptyLineBeforeReturn.RemoveEmptyLineBeforeReturnStatement

[401] Fix | Delete

return DB::get_existing_custom_tables();

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

/**

[405] Fix | Delete

* Whether the current instance of the plugin is a paid version, or free.

[406] Fix | Delete

[407] Fix | Delete

* @since 1.7.3

[408] Fix | Delete

[409] Fix | Delete

* @return bool

[410] Fix | Delete

[411] Fix | Delete

public function is_pro() {

[412] Fix | Delete

[413] Fix | Delete

/**

[414] Fix | Delete

* Filters whether the current plugin version is pro.

[415] Fix | Delete

[416] Fix | Delete

* @since 1.7.3

[417] Fix | Delete

[418] Fix | Delete

* @param bool $pro Whether the current plugin version is pro.

[419] Fix | Delete

[420] Fix | Delete

return (bool) apply_filters( 'wpforms_allow_pro_version', $this->pro );

[421] Fix | Delete

}

[422] Fix | Delete

}

[423] Fix | Delete

}

[424] Fix | Delete

[425] Fix | Delete

namespace {

[426] Fix | Delete

[427] Fix | Delete

/**

[428] Fix | Delete

* The function which returns the one WPForms instance.

[429] Fix | Delete

[430] Fix | Delete

* @since 1.0.0

[431] Fix | Delete

[432] Fix | Delete

* @return WPForms\WPForms

[433] Fix | Delete

[434] Fix | Delete

function wpforms() {

[435] Fix | Delete

[436] Fix | Delete

return WPForms\WPForms::instance();

[437] Fix | Delete

}

[438] Fix | Delete

[439] Fix | Delete

/**

[440] Fix | Delete

* Adding an alias for backward-compatibility with plugins

[441] Fix | Delete

* that still use class_exists( 'WPForms' )

[442] Fix | Delete

* instead of function_exists( 'wpforms' ), which is preferred.

[443] Fix | Delete

[444] Fix | Delete

* In 1.5.0 we removed support for PHP 5.2

[445] Fix | Delete

* and moved former WPForms class to a namespace: WPForms\WPForms.

[446] Fix | Delete

[447] Fix | Delete

* @since 1.5.1

[448] Fix | Delete

[449] Fix | Delete

class_alias( 'WPForms\WPForms', 'WPForms' );

[450] Fix | Delete

}

[451] Fix | Delete

[452] Fix | Delete