Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* @package Freemius

[2] Fix | Delete

[3] Fix | Delete

* @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3

[4] Fix | Delete

* @since 1.0.7

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* - Each instance of Freemius class represents a single plugin

[14] Fix | Delete

* install by a single user (the installer of the plugin).

[15] Fix | Delete

[16] Fix | Delete

* - Each website can only have one install of the same plugin.

[17] Fix | Delete

[18] Fix | Delete

* - Install entity is only created after a user connects his account with Freemius.

[19] Fix | Delete

[20] Fix | Delete

* Class Freemius_Abstract

[21] Fix | Delete

[22] Fix | Delete

abstract class Freemius_Abstract {

[23] Fix | Delete

[24] Fix | Delete

#----------------------------------------------------------------------------------

[25] Fix | Delete

#region Identity

[26] Fix | Delete

#----------------------------------------------------------------------------------

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Check if user has connected his account (opted-in).

[30] Fix | Delete

[31] Fix | Delete

* Note:

[32] Fix | Delete

* If the user opted-in and opted-out on a later stage,

[33] Fix | Delete

* this will still return true. If you want to check if the

[34] Fix | Delete

* user is currently opted-in, use:

[35] Fix | Delete

* `$fs->is_registered() && $fs->is_tracking_allowed()`

[36] Fix | Delete

[37] Fix | Delete

* @since 1.0.1

[38] Fix | Delete

[39] Fix | Delete

* @param bool $ignore_anonymous_state Since 2.5.1

[40] Fix | Delete

[41] Fix | Delete

* @return bool

[42] Fix | Delete

[43] Fix | Delete

abstract function is_registered( $ignore_anonymous_state = false );

[44] Fix | Delete

[45] Fix | Delete

/**

[46] Fix | Delete

* Check if the user skipped connecting the account with Freemius.

[47] Fix | Delete

[48] Fix | Delete

* @since 1.0.7

[49] Fix | Delete

[50] Fix | Delete

* @return bool

[51] Fix | Delete

[52] Fix | Delete

abstract function is_anonymous();

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Check if the user currently in activation mode.

[56] Fix | Delete

[57] Fix | Delete

* @since 1.0.7

[58] Fix | Delete

[59] Fix | Delete

* @return bool

[60] Fix | Delete

[61] Fix | Delete

abstract function is_activation_mode();

[62] Fix | Delete

[63] Fix | Delete

#endregion

[64] Fix | Delete

[65] Fix | Delete

#----------------------------------------------------------------------------------

[66] Fix | Delete

#region Module Type

[67] Fix | Delete

#----------------------------------------------------------------------------------

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Checks if the plugin's type is "plugin". The other type is "theme".

[71] Fix | Delete

[72] Fix | Delete

* @author Leo Fajardo (@leorw)

[73] Fix | Delete

* @since 1.2.2

[74] Fix | Delete

[75] Fix | Delete

* @return bool

[76] Fix | Delete

[77] Fix | Delete

abstract function is_plugin();

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Checks if the module type is "theme". The other type is "plugin".

[81] Fix | Delete

[82] Fix | Delete

* @author Leo Fajardo (@leorw)

[83] Fix | Delete

* @since 1.2.2

[84] Fix | Delete

[85] Fix | Delete

* @return bool

[86] Fix | Delete

[87] Fix | Delete

function is_theme() {

[88] Fix | Delete

return ( ! $this->is_plugin() );

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

#endregion

[92] Fix | Delete

[93] Fix | Delete

#----------------------------------------------------------------------------------

[94] Fix | Delete

#region Permissions

[95] Fix | Delete

#----------------------------------------------------------------------------------

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* Check if plugin must be WordPress.org compliant.

[99] Fix | Delete

[100] Fix | Delete

* @since 1.0.7

[101] Fix | Delete

[102] Fix | Delete

* @return bool

[103] Fix | Delete

[104] Fix | Delete

abstract function is_org_repo_compliant();

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* Check if plugin is allowed to install executable files.

[108] Fix | Delete

[109] Fix | Delete

* @author Vova Feldman (@svovaf)

[110] Fix | Delete

* @since 1.0.5

[111] Fix | Delete

[112] Fix | Delete

* @return bool

[113] Fix | Delete

[114] Fix | Delete

function is_allowed_to_install() {

[115] Fix | Delete

return ( $this->is_premium() || ! $this->is_org_repo_compliant() );

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

#endregion

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Check if user in trial or in free plan (not paying).

[122] Fix | Delete

[123] Fix | Delete

* @author Vova Feldman (@svovaf)

[124] Fix | Delete

* @since 1.0.4

[125] Fix | Delete

[126] Fix | Delete

* @return bool

[127] Fix | Delete

[128] Fix | Delete

function is_not_paying() {

[129] Fix | Delete

return ( $this->is_trial() || $this->is_free_plan() );

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Check if the user has an activated and valid paid license on current plugin's install.

[134] Fix | Delete

[135] Fix | Delete

* @since 1.0.9

[136] Fix | Delete

[137] Fix | Delete

* @return bool

[138] Fix | Delete

[139] Fix | Delete

abstract function is_paying();

[140] Fix | Delete

[141] Fix | Delete

/**

[142] Fix | Delete

* Check if the user is paying or in trial.

[143] Fix | Delete

[144] Fix | Delete

* @since 1.0.9

[145] Fix | Delete

[146] Fix | Delete

* @return bool

[147] Fix | Delete

[148] Fix | Delete

function is_paying_or_trial() {

[149] Fix | Delete

return ( $this->is_paying() || $this->is_trial() );

[150] Fix | Delete

}

[151] Fix | Delete

[152] Fix | Delete

/**

[153] Fix | Delete

* Check if user in a trial or have feature enabled license.

[154] Fix | Delete

[155] Fix | Delete

* @author Vova Feldman (@svovaf)

[156] Fix | Delete

* @since 1.1.7

[157] Fix | Delete

[158] Fix | Delete

* @return bool

[159] Fix | Delete

[160] Fix | Delete

abstract function can_use_premium_code();

[161] Fix | Delete

[162] Fix | Delete

#----------------------------------------------------------------------------------

[163] Fix | Delete

#region Premium Only

[164] Fix | Delete

#----------------------------------------------------------------------------------

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* All logic wrapped in methods with "__premium_only()" suffix will be only

[168] Fix | Delete

* included in the premium code.

[169] Fix | Delete

[170] Fix | Delete

* Example:

[171] Fix | Delete

* if ( freemius()->is__premium_only() ) {

[172] Fix | Delete

* ...

[173] Fix | Delete

* }

[174] Fix | Delete

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Returns true when running premium plugin code.

[178] Fix | Delete

[179] Fix | Delete

* @since 1.0.9

[180] Fix | Delete

[181] Fix | Delete

* @return bool

[182] Fix | Delete

[183] Fix | Delete

function is__premium_only() {

[184] Fix | Delete

return $this->is_premium();

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Check if the user has an activated and valid paid license on current plugin's install.

[189] Fix | Delete

[190] Fix | Delete

* @since 1.0.9

[191] Fix | Delete

[192] Fix | Delete

* @return bool

[193] Fix | Delete

[194] Fix | Delete

[195] Fix | Delete

function is_paying__premium_only() {

[196] Fix | Delete

return ( $this->is__premium_only() && $this->is_paying() );

[197] Fix | Delete

}

[198] Fix | Delete

[199] Fix | Delete

/**

[200] Fix | Delete

* All code wrapped in this statement will be only included in the premium code.

[201] Fix | Delete

[202] Fix | Delete

* @since 1.0.9

[203] Fix | Delete

[204] Fix | Delete

* @param string $plan Plan name.

[205] Fix | Delete

* @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.

[206] Fix | Delete

[207] Fix | Delete

* @return bool

[208] Fix | Delete

[209] Fix | Delete

function is_plan__premium_only( $plan, $exact = false ) {

[210] Fix | Delete

return ( $this->is_premium() && $this->is_plan( $plan, $exact ) );

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Check if plan matches active license' plan or active trial license' plan.

[215] Fix | Delete

[216] Fix | Delete

* All code wrapped in this statement will be only included in the premium code.

[217] Fix | Delete

[218] Fix | Delete

* @since 1.0.9

[219] Fix | Delete

[220] Fix | Delete

* @param string $plan Plan name.

[221] Fix | Delete

* @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.

[222] Fix | Delete

[223] Fix | Delete

* @return bool

[224] Fix | Delete

[225] Fix | Delete

function is_plan_or_trial__premium_only( $plan, $exact = false ) {

[226] Fix | Delete

return ( $this->is_premium() && $this->is_plan_or_trial( $plan, $exact ) );

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Check if the user is paying or in trial.

[231] Fix | Delete

[232] Fix | Delete

* All code wrapped in this statement will be only included in the premium code.

[233] Fix | Delete

[234] Fix | Delete

* @since 1.0.9

[235] Fix | Delete

[236] Fix | Delete

* @return bool

[237] Fix | Delete

[238] Fix | Delete

function is_paying_or_trial__premium_only() {

[239] Fix | Delete

return $this->is_premium() && $this->is_paying_or_trial();

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

/**

[243] Fix | Delete

* Check if the user has an activated and valid paid license on current plugin's install.

[244] Fix | Delete

[245] Fix | Delete

* @since 1.0.4

[246] Fix | Delete

[247] Fix | Delete

* @return bool

[248] Fix | Delete

[249] Fix | Delete

* @deprecated Method name is confusing since it's not clear from the name the code will be removed.

[250] Fix | Delete

* @using Alias to is_paying__premium_only()

[251] Fix | Delete

[252] Fix | Delete

function is_paying__fs__() {

[253] Fix | Delete

return $this->is_paying__premium_only();

[254] Fix | Delete

}

[255] Fix | Delete

[256] Fix | Delete

/**

[257] Fix | Delete

* Check if user in a trial or have feature enabled license.

[258] Fix | Delete

[259] Fix | Delete

* All code wrapped in this statement will be only included in the premium code.

[260] Fix | Delete

[261] Fix | Delete

* @author Vova Feldman (@svovaf)

[262] Fix | Delete

* @since 1.1.9

[263] Fix | Delete

[264] Fix | Delete

* @return bool

[265] Fix | Delete

[266] Fix | Delete

function can_use_premium_code__premium_only() {

[267] Fix | Delete

return $this->is_premium() && $this->can_use_premium_code();

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

#endregion

[271] Fix | Delete

[272] Fix | Delete

#----------------------------------------------------------------------------------

[273] Fix | Delete

#region Trial

[274] Fix | Delete

#----------------------------------------------------------------------------------

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Check if the user in a trial.

[278] Fix | Delete

[279] Fix | Delete

* @since 1.0.3

[280] Fix | Delete

[281] Fix | Delete

* @return bool

[282] Fix | Delete

[283] Fix | Delete

abstract function is_trial();

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* Check if trial already utilized.

[287] Fix | Delete

[288] Fix | Delete

* @since 1.0.9

[289] Fix | Delete

[290] Fix | Delete

* @return bool

[291] Fix | Delete

[292] Fix | Delete

abstract function is_trial_utilized();

[293] Fix | Delete

[294] Fix | Delete

#endregion

[295] Fix | Delete

[296] Fix | Delete

#----------------------------------------------------------------------------------

[297] Fix | Delete

#region Plans

[298] Fix | Delete

#----------------------------------------------------------------------------------

[299] Fix | Delete

[300] Fix | Delete

/**

[301] Fix | Delete

* Check if the user is on the free plan of the product.

[302] Fix | Delete

[303] Fix | Delete

* @since 1.0.4

[304] Fix | Delete

[305] Fix | Delete

* @return bool

[306] Fix | Delete

[307] Fix | Delete

abstract function is_free_plan();

[308] Fix | Delete

[309] Fix | Delete

/**

[310] Fix | Delete

* @since 1.0.2

[311] Fix | Delete

[312] Fix | Delete

* @param string $plan Plan name.

[313] Fix | Delete

* @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.

[314] Fix | Delete

[315] Fix | Delete

* @return bool

[316] Fix | Delete

[317] Fix | Delete

abstract function is_plan( $plan, $exact = false );

[318] Fix | Delete

[319] Fix | Delete

/**

[320] Fix | Delete

* Check if plan based on trial. If not in trial mode, should return false.

[321] Fix | Delete

[322] Fix | Delete

* @since 1.0.9

[323] Fix | Delete

[324] Fix | Delete

* @param string $plan Plan name.

[325] Fix | Delete

* @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.

[326] Fix | Delete

[327] Fix | Delete

* @return bool

[328] Fix | Delete

[329] Fix | Delete

abstract function is_trial_plan( $plan, $exact = false );

[330] Fix | Delete

[331] Fix | Delete

/**

[332] Fix | Delete

* Check if plan matches active license' plan or active trial license' plan.

[333] Fix | Delete

[334] Fix | Delete

* @since 1.0.9

[335] Fix | Delete

[336] Fix | Delete

* @param string $plan Plan name.

[337] Fix | Delete

* @param bool $exact If true, looks for exact plan. If false, also check "higher" plans.

[338] Fix | Delete

[339] Fix | Delete

* @return bool

[340] Fix | Delete

[341] Fix | Delete

function is_plan_or_trial( $plan, $exact = false ) {

[342] Fix | Delete

return $this->is_plan( $plan, $exact ) ||

[343] Fix | Delete

$this->is_trial_plan( $plan, $exact );

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

/**

[347] Fix | Delete

* Check if plugin has any paid plans.

[348] Fix | Delete

[349] Fix | Delete

* @author Vova Feldman (@svovaf)

[350] Fix | Delete

* @since 1.0.7

[351] Fix | Delete

[352] Fix | Delete

* @return bool

[353] Fix | Delete

[354] Fix | Delete

abstract function has_paid_plan();

[355] Fix | Delete

[356] Fix | Delete

/**

[357] Fix | Delete

* Check if plugin has any free plan, or is it premium only.

[358] Fix | Delete

[359] Fix | Delete

* Note: If no plans configured, assume plugin is free.

[360] Fix | Delete

[361] Fix | Delete

* @author Vova Feldman (@svovaf)

[362] Fix | Delete

* @since 1.0.7

[363] Fix | Delete

[364] Fix | Delete

* @return bool

[365] Fix | Delete

[366] Fix | Delete

abstract function has_free_plan();

[367] Fix | Delete

[368] Fix | Delete

/**

[369] Fix | Delete

* Check if plugin is premium only (no free plans).

[370] Fix | Delete

[371] Fix | Delete

* NOTE: is__premium_only() is very different method, don't get confused.

[372] Fix | Delete

[373] Fix | Delete

* @author Vova Feldman (@svovaf)

[374] Fix | Delete

* @since 1.1.9

[375] Fix | Delete

[376] Fix | Delete

* @return bool

[377] Fix | Delete

[378] Fix | Delete

abstract function is_only_premium();

[379] Fix | Delete

[380] Fix | Delete

/**

[381] Fix | Delete

* Check if module has a premium code version.

[382] Fix | Delete

[383] Fix | Delete

* Serviceware module might be freemium without any

[384] Fix | Delete

* premium code version, where the paid features

[385] Fix | Delete

* are all part of the service.

[386] Fix | Delete

[387] Fix | Delete

* @author Vova Feldman (@svovaf)

[388] Fix | Delete

* @since 1.2.1.6

[389] Fix | Delete

[390] Fix | Delete

* @return bool

[391] Fix | Delete

[392] Fix | Delete

abstract function has_premium_version();

[393] Fix | Delete

[394] Fix | Delete

/**

[395] Fix | Delete

* Check if module has any release on Freemius,

[396] Fix | Delete

* or all plugin's code is on WordPress.org (Serviceware).

[397] Fix | Delete

[398] Fix | Delete

* @return bool

[399] Fix | Delete

[400] Fix | Delete

function has_release_on_freemius() {

[401] Fix | Delete

return ! $this->is_org_repo_compliant() ||

[402] Fix | Delete

$this->has_premium_version();

[403] Fix | Delete

}

[404] Fix | Delete

[405] Fix | Delete

/**

[406] Fix | Delete

* Checks if it's a freemium plugin.

[407] Fix | Delete

[408] Fix | Delete

* @author Vova Feldman (@svovaf)

[409] Fix | Delete

* @since 1.1.9

[410] Fix | Delete

[411] Fix | Delete

* @return bool

[412] Fix | Delete

[413] Fix | Delete

function is_freemium() {

[414] Fix | Delete

return $this->has_paid_plan() &&

[415] Fix | Delete

$this->has_free_plan();

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

/**

[419] Fix | Delete

* Check if module has only one plan.

[420] Fix | Delete

[421] Fix | Delete

* @author Vova Feldman (@svovaf)

[422] Fix | Delete

* @since 1.2.1.7

[423] Fix | Delete

[424] Fix | Delete

* @return bool

[425] Fix | Delete

[426] Fix | Delete

abstract function is_single_plan();

[427] Fix | Delete

[428] Fix | Delete

#endregion

[429] Fix | Delete

[430] Fix | Delete

/**

[431] Fix | Delete

* Check if running payments in sandbox mode.

[432] Fix | Delete

[433] Fix | Delete

* @since 1.0.4

[434] Fix | Delete

[435] Fix | Delete

* @return bool

[436] Fix | Delete

[437] Fix | Delete

abstract function is_payments_sandbox();

[438] Fix | Delete

[439] Fix | Delete

/**

[440] Fix | Delete

* Check if running test vs. live plugin.

[441] Fix | Delete

[442] Fix | Delete

* @since 1.0.5

[443] Fix | Delete

[444] Fix | Delete

* @return bool

[445] Fix | Delete

[446] Fix | Delete

abstract function is_live();

[447] Fix | Delete

[448] Fix | Delete

/**

[449] Fix | Delete

* Check if running premium plugin code.

[450] Fix | Delete

[451] Fix | Delete

* @since 1.0.5

[452] Fix | Delete

[453] Fix | Delete

* @return bool

[454] Fix | Delete

[455] Fix | Delete

abstract function is_premium();

[456] Fix | Delete

[457] Fix | Delete

/**

[458] Fix | Delete

* Get upgrade URL.

[459] Fix | Delete

[460] Fix | Delete

* @author Vova Feldman (@svovaf)

[461] Fix | Delete

* @since 1.0.2

[462] Fix | Delete

[463] Fix | Delete

* @param string $period Billing cycle.

[464] Fix | Delete

[465] Fix | Delete

* @return string

[466] Fix | Delete

[467] Fix | Delete

abstract function get_upgrade_url( $period = WP_FS__PERIOD_ANNUALLY );

[468] Fix | Delete

[469] Fix | Delete

/**

[470] Fix | Delete

* Check if Freemius was first added in a plugin update.

[471] Fix | Delete

[472] Fix | Delete

* @author Vova Feldman (@svovaf)

[473] Fix | Delete

* @since 1.1.5

[474] Fix | Delete

[475] Fix | Delete

* @return bool

[476] Fix | Delete

[477] Fix | Delete

function is_plugin_update() {

[478] Fix | Delete

return ! $this->is_plugin_new_install();

[479] Fix | Delete

}

[480] Fix | Delete

[481] Fix | Delete

/**

[482] Fix | Delete

* Check if Freemius was part of the plugin when the user installed it first.

[483] Fix | Delete

[484] Fix | Delete

* @author Vova Feldman (@svovaf)

[485] Fix | Delete

* @since 1.1.5

[486] Fix | Delete

[487] Fix | Delete

* @return bool

[488] Fix | Delete

[489] Fix | Delete

abstract function is_plugin_new_install();

[490] Fix | Delete

[491] Fix | Delete

#----------------------------------------------------------------------------------

[492] Fix | Delete

#region Marketing

[493] Fix | Delete

#----------------------------------------------------------------------------------

[494] Fix | Delete

[495] Fix | Delete

/**

[496] Fix | Delete

* Check if current user purchased any other plugins before.

[497] Fix | Delete

[498] Fix | Delete

* @author Vova Feldman (@svovaf)

[499] Fix | Delete