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.1.3

[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

class FS_Admin_Menu_Manager {

[12] Fix | Delete

[13] Fix | Delete

#region Properties

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* @since 1.2.2

[17] Fix | Delete

[18] Fix | Delete

* @var string

[19] Fix | Delete

[20] Fix | Delete

protected $_module_unique_affix;

[21] Fix | Delete

[22] Fix | Delete

/**

[23] Fix | Delete

* @since 1.2.2

[24] Fix | Delete

[25] Fix | Delete

* @var number

[26] Fix | Delete

[27] Fix | Delete

protected $_module_id;

[28] Fix | Delete

[29] Fix | Delete

/**

[30] Fix | Delete

* @since 1.2.2

[31] Fix | Delete

[32] Fix | Delete

* @var string

[33] Fix | Delete

[34] Fix | Delete

protected $_module_type;

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* @since 1.0.6

[38] Fix | Delete

[39] Fix | Delete

* @var string

[40] Fix | Delete

[41] Fix | Delete

private $_menu_slug;

[42] Fix | Delete

/**

[43] Fix | Delete

* @since 1.1.3

[44] Fix | Delete

[45] Fix | Delete

* @var string

[46] Fix | Delete

[47] Fix | Delete

private $_parent_slug;

[48] Fix | Delete

/**

[49] Fix | Delete

* @since 1.1.3

[50] Fix | Delete

[51] Fix | Delete

* @var string

[52] Fix | Delete

[53] Fix | Delete

private $_parent_type;

[54] Fix | Delete

/**

[55] Fix | Delete

* @since 1.1.3

[56] Fix | Delete

[57] Fix | Delete

* @var string

[58] Fix | Delete

[59] Fix | Delete

private $_type;

[60] Fix | Delete

/**

[61] Fix | Delete

* @since 1.1.3

[62] Fix | Delete

[63] Fix | Delete

* @var bool

[64] Fix | Delete

[65] Fix | Delete

private $_is_top_level;

[66] Fix | Delete

/**

[67] Fix | Delete

* @since 1.1.3

[68] Fix | Delete

[69] Fix | Delete

* @var bool

[70] Fix | Delete

[71] Fix | Delete

private $_is_override_exact;

[72] Fix | Delete

/**

[73] Fix | Delete

* @since 1.1.3

[74] Fix | Delete

[75] Fix | Delete

* @var array<string,bool>

[76] Fix | Delete

[77] Fix | Delete

private $_default_submenu_items;

[78] Fix | Delete

/**

[79] Fix | Delete

* @since 1.1.3

[80] Fix | Delete

[81] Fix | Delete

* @var string

[82] Fix | Delete

[83] Fix | Delete

private $_first_time_path;

[84] Fix | Delete

/**

[85] Fix | Delete

* @since 1.2.2

[86] Fix | Delete

[87] Fix | Delete

* @var bool

[88] Fix | Delete

[89] Fix | Delete

private $_menu_exists;

[90] Fix | Delete

/**

[91] Fix | Delete

* @since 2.0.0

[92] Fix | Delete

[93] Fix | Delete

* @var bool

[94] Fix | Delete

[95] Fix | Delete

private $_network_menu_exists;

[96] Fix | Delete

[97] Fix | Delete

#endregion Properties

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* @var FS_Logger

[101] Fix | Delete

[102] Fix | Delete

protected $_logger;

[103] Fix | Delete

[104] Fix | Delete

#region Singleton

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* @var FS_Admin_Menu_Manager[]

[108] Fix | Delete

[109] Fix | Delete

private static $_instances = array();

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* @param number $module_id

[113] Fix | Delete

* @param string $module_type

[114] Fix | Delete

* @param string $module_unique_affix

[115] Fix | Delete

[116] Fix | Delete

* @return FS_Admin_Menu_Manager

[117] Fix | Delete

[118] Fix | Delete

static function instance( $module_id, $module_type, $module_unique_affix ) {

[119] Fix | Delete

$key = 'm_' . $module_id;

[120] Fix | Delete

[121] Fix | Delete

if ( ! isset( self::$_instances[ $key ] ) ) {

[122] Fix | Delete

self::$_instances[ $key ] = new FS_Admin_Menu_Manager( $module_id, $module_type, $module_unique_affix );

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

return self::$_instances[ $key ];

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

protected function __construct( $module_id, $module_type, $module_unique_affix ) {

[129] Fix | Delete

$this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_' . $module_id . '_admin_menu', WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );

[130] Fix | Delete

[131] Fix | Delete

$this->_module_id = $module_id;

[132] Fix | Delete

$this->_module_type = $module_type;

[133] Fix | Delete

$this->_module_unique_affix = $module_unique_affix;

[134] Fix | Delete

}

[135] Fix | Delete

[136] Fix | Delete

#endregion Singleton

[137] Fix | Delete

[138] Fix | Delete

#region Helpers

[139] Fix | Delete

[140] Fix | Delete

private function get_option( &$options, $key, $default = false ) {

[141] Fix | Delete

return ! empty( $options[ $key ] ) ? $options[ $key ] : $default;

[142] Fix | Delete

}

[143] Fix | Delete

[144] Fix | Delete

private function get_bool_option( &$options, $key, $default = false ) {

[145] Fix | Delete

return isset( $options[ $key ] ) && is_bool( $options[ $key ] ) ? $options[ $key ] : $default;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

#endregion Helpers

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* @param array $menu

[152] Fix | Delete

* @param bool $is_addon

[153] Fix | Delete

[154] Fix | Delete

function init( $menu, $is_addon = false ) {

[155] Fix | Delete

$this->_menu_exists = ( isset( $menu['slug'] ) && ! empty( $menu['slug'] ) );

[156] Fix | Delete

$this->_network_menu_exists = ( ! empty( $menu['network'] ) && true === $menu['network'] );

[157] Fix | Delete

[158] Fix | Delete

$this->_menu_slug = ( $this->_menu_exists ? $menu['slug'] : $this->_module_unique_affix );

[159] Fix | Delete

[160] Fix | Delete

$this->_default_submenu_items = array();

[161] Fix | Delete

// @deprecated

[162] Fix | Delete

$this->_type = 'page';

[163] Fix | Delete

$this->_is_top_level = true;

[164] Fix | Delete

$this->_is_override_exact = false;

[165] Fix | Delete

$this->_parent_slug = false;

[166] Fix | Delete

// @deprecated

[167] Fix | Delete

$this->_parent_type = 'page';

[168] Fix | Delete

[169] Fix | Delete

if ( isset( $menu ) ) {

[170] Fix | Delete

if ( ! $is_addon ) {

[171] Fix | Delete

$this->_default_submenu_items = array(

[172] Fix | Delete

'contact' => $this->get_bool_option( $menu, 'contact', true ),

[173] Fix | Delete

'support' => $this->get_bool_option( $menu, 'support', true ),

[174] Fix | Delete

'affiliation' => $this->get_bool_option( $menu, 'affiliation', true ),

[175] Fix | Delete

'account' => $this->get_bool_option( $menu, 'account', true ),

[176] Fix | Delete

'pricing' => $this->get_bool_option( $menu, 'pricing', true ),

[177] Fix | Delete

'addons' => $this->get_bool_option( $menu, 'addons', true ),

[178] Fix | Delete

);

[179] Fix | Delete

[180] Fix | Delete

// @deprecated

[181] Fix | Delete

$this->_type = $this->get_option( $menu, 'type', 'page' );

[182] Fix | Delete

}

[183] Fix | Delete

[184] Fix | Delete

$this->_is_override_exact = $this->get_bool_option( $menu, 'override_exact' );

[185] Fix | Delete

[186] Fix | Delete

if ( isset( $menu['parent'] ) ) {

[187] Fix | Delete

$this->_parent_slug = $this->get_option( $menu['parent'], 'slug' );

[188] Fix | Delete

// @deprecated

[189] Fix | Delete

$this->_parent_type = $this->get_option( $menu['parent'], 'type', 'page' );

[190] Fix | Delete

[191] Fix | Delete

// If parent's slug is different, then it's NOT a top level menu item.

[192] Fix | Delete

$this->_is_top_level = ( $this->_parent_slug === $this->_menu_slug );

[193] Fix | Delete

} else {

[194] Fix | Delete

/**

[195] Fix | Delete

* If no parent then top level if:

[196] Fix | Delete

* - Has custom admin menu ('page')

[197] Fix | Delete

* - CPT menu type ('cpt')

[198] Fix | Delete

[199] Fix | Delete

// $this->_is_top_level = in_array( $this->_type, array(

[200] Fix | Delete

// 'cpt',

[201] Fix | Delete

// 'page'

[202] Fix | Delete

// ) );

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

$first_path = $this->get_option( $menu, 'first-path', false );

[206] Fix | Delete

[207] Fix | Delete

if ( ! empty( $first_path ) && is_string( $first_path ) ) {

[208] Fix | Delete

$this->_first_time_path = $first_path;

[209] Fix | Delete

}

[210] Fix | Delete

}

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

/**

[214] Fix | Delete

* Check if top level menu.

[215] Fix | Delete

[216] Fix | Delete

* @author Vova Feldman (@svovaf)

[217] Fix | Delete

* @since 1.1.3

[218] Fix | Delete

[219] Fix | Delete

* @return bool False if submenu item.

[220] Fix | Delete

[221] Fix | Delete

function is_top_level() {

[222] Fix | Delete

return $this->_is_top_level;

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Check if the page should be override on exact URL match.

[227] Fix | Delete

[228] Fix | Delete

* @author Vova Feldman (@svovaf)

[229] Fix | Delete

* @since 1.1.3

[230] Fix | Delete

[231] Fix | Delete

* @return bool False if submenu item.

[232] Fix | Delete

[233] Fix | Delete

function is_override_exact() {

[234] Fix | Delete

return $this->_is_override_exact;

[235] Fix | Delete

}

[236] Fix | Delete

[237] Fix | Delete

[238] Fix | Delete

/**

[239] Fix | Delete

* Get the path of the page the user should be forwarded to after first activation.

[240] Fix | Delete

[241] Fix | Delete

* @author Vova Feldman (@svovaf)

[242] Fix | Delete

* @since 1.1.3

[243] Fix | Delete

[244] Fix | Delete

* @param bool $is_network Since 2.4.5

[245] Fix | Delete

[246] Fix | Delete

* @return string

[247] Fix | Delete

[248] Fix | Delete

function get_first_time_path( $is_network = false ) {

[249] Fix | Delete

if ( empty ( $this->_first_time_path ) ) {

[250] Fix | Delete

return $this->_first_time_path;

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

if ( $is_network ) {

[254] Fix | Delete

return network_admin_url( $this->_first_time_path );

[255] Fix | Delete

} else {

[256] Fix | Delete

return admin_url( $this->_first_time_path );

[257] Fix | Delete

}

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

/**

[261] Fix | Delete

* Check if plugin's menu item is part of a custom top level menu.

[262] Fix | Delete

[263] Fix | Delete

* @author Vova Feldman (@svovaf)

[264] Fix | Delete

* @since 1.1.3

[265] Fix | Delete

[266] Fix | Delete

* @return bool

[267] Fix | Delete

[268] Fix | Delete

function has_custom_parent() {

[269] Fix | Delete

return ! $this->_is_top_level && is_string( $this->_parent_slug );

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* @author Leo Fajardo (@leorw)

[274] Fix | Delete

* @since 1.2.2

[275] Fix | Delete

[276] Fix | Delete

* @return bool

[277] Fix | Delete

[278] Fix | Delete

function has_menu() {

[279] Fix | Delete

return $this->_menu_exists;

[280] Fix | Delete

}

[281] Fix | Delete

[282] Fix | Delete

/**

[283] Fix | Delete

* @author Vova Feldman (@svovaf)

[284] Fix | Delete

* @since 2.0.0

[285] Fix | Delete

[286] Fix | Delete

* @return bool

[287] Fix | Delete

[288] Fix | Delete

function has_network_menu() {

[289] Fix | Delete

return $this->_network_menu_exists;

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* @author Leo Fajardo (@leorw)

[294] Fix | Delete

[295] Fix | Delete

* @param string $menu_slug

[296] Fix | Delete

[297] Fix | Delete

* @since 2.1.3

[298] Fix | Delete

[299] Fix | Delete

function set_slug_and_network_menu_exists_flag($menu_slug ) {

[300] Fix | Delete

$this->_menu_slug = $menu_slug;

[301] Fix | Delete

$this->_network_menu_exists = false;

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* @author Vova Feldman (@svovaf)

[306] Fix | Delete

* @since 1.1.3

[307] Fix | Delete

[308] Fix | Delete

* @param string $id

[309] Fix | Delete

* @param bool $default

[310] Fix | Delete

* @param bool $ignore_menu_existence Since 1.2.2.7 If true, check if the submenu item visible even if there's no parent menu.

[311] Fix | Delete

[312] Fix | Delete

* @return bool

[313] Fix | Delete

[314] Fix | Delete

function is_submenu_item_visible( $id, $default = true, $ignore_menu_existence = false ) {

[315] Fix | Delete

if ( ! $ignore_menu_existence && ! $this->has_menu() ) {

[316] Fix | Delete

return false;

[317] Fix | Delete

}

[318] Fix | Delete

[319] Fix | Delete

return fs_apply_filter(

[320] Fix | Delete

$this->_module_unique_affix,

[321] Fix | Delete

'is_submenu_visible',

[322] Fix | Delete

$this->get_bool_option( $this->_default_submenu_items, $id, $default ),

[323] Fix | Delete

$id

[324] Fix | Delete

);

[325] Fix | Delete

}

[326] Fix | Delete

[327] Fix | Delete

/**

[328] Fix | Delete

* Calculates admin settings menu slug.

[329] Fix | Delete

* If plugin's menu slug is a file (e.g. CPT), uses plugin's slug as the menu slug.

[330] Fix | Delete

[331] Fix | Delete

* @author Vova Feldman (@svovaf)

[332] Fix | Delete

* @since 1.1.3

[333] Fix | Delete

[334] Fix | Delete

* @param string $page

[335] Fix | Delete

[336] Fix | Delete

* @return string

[337] Fix | Delete

[338] Fix | Delete

function get_slug( $page = '' ) {

[339] Fix | Delete

return ( ( false === strpos( $this->_menu_slug, '.php?' ) ) ?

[340] Fix | Delete

$this->_menu_slug :

[341] Fix | Delete

$this->_module_unique_affix ) . ( empty( $page ) ? '' : ( '-' . $page ) );

[342] Fix | Delete

}

[343] Fix | Delete

[344] Fix | Delete

/**

[345] Fix | Delete

* @author Vova Feldman (@svovaf)

[346] Fix | Delete

* @since 1.1.3

[347] Fix | Delete

[348] Fix | Delete

* @return string

[349] Fix | Delete

[350] Fix | Delete

function get_parent_slug() {

[351] Fix | Delete

return $this->_parent_slug;

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

/**

[355] Fix | Delete

* @author Vova Feldman (@svovaf)

[356] Fix | Delete

* @since 1.1.3

[357] Fix | Delete

[358] Fix | Delete

* @return string

[359] Fix | Delete

[360] Fix | Delete

function get_type() {

[361] Fix | Delete

return $this->_type;

[362] Fix | Delete

}

[363] Fix | Delete

[364] Fix | Delete

/**

[365] Fix | Delete

* @author Vova Feldman (@svovaf)

[366] Fix | Delete

* @since 1.1.3

[367] Fix | Delete

[368] Fix | Delete

* @return bool

[369] Fix | Delete

[370] Fix | Delete

function is_cpt() {

[371] Fix | Delete

return ( 0 === strpos( $this->_menu_slug, 'edit.php?post_type=' ) ||

[372] Fix | Delete

// Back compatibility.

[373] Fix | Delete

'cpt' === $this->_type

[374] Fix | Delete

);

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete

/**

[378] Fix | Delete

* @author Vova Feldman (@svovaf)

[379] Fix | Delete

* @since 1.1.3

[380] Fix | Delete

[381] Fix | Delete

* @return string

[382] Fix | Delete

[383] Fix | Delete

function get_parent_type() {

[384] Fix | Delete

return $this->_parent_type;

[385] Fix | Delete

}

[386] Fix | Delete

[387] Fix | Delete

/**

[388] Fix | Delete

* @author Vova Feldman (@svovaf)

[389] Fix | Delete

* @since 1.1.3

[390] Fix | Delete

[391] Fix | Delete

* @return string

[392] Fix | Delete

[393] Fix | Delete

function get_raw_slug() {

[394] Fix | Delete

return $this->_menu_slug;

[395] Fix | Delete

}

[396] Fix | Delete

[397] Fix | Delete

/**

[398] Fix | Delete

* Get plugin's original menu slug.

[399] Fix | Delete

[400] Fix | Delete

* @author Vova Feldman (@svovaf)

[401] Fix | Delete

* @since 1.1.3

[402] Fix | Delete

[403] Fix | Delete

* @return string

[404] Fix | Delete

[405] Fix | Delete

function get_original_menu_slug() {

[406] Fix | Delete

if ( 'cpt' === $this->_type ) {

[407] Fix | Delete

return add_query_arg( array(

[408] Fix | Delete

'post_type' => $this->_menu_slug

[409] Fix | Delete

), 'edit.php' );

[410] Fix | Delete

}

[411] Fix | Delete

[412] Fix | Delete

if ( false === strpos( $this->_menu_slug, '.php?' ) ) {

[413] Fix | Delete

return $this->_menu_slug;

[414] Fix | Delete

} else {

[415] Fix | Delete

return $this->_module_unique_affix;

[416] Fix | Delete

}

[417] Fix | Delete

}

[418] Fix | Delete

[419] Fix | Delete

/**

[420] Fix | Delete

* @author Vova Feldman (@svovaf)

[421] Fix | Delete

* @since 1.1.3

[422] Fix | Delete

[423] Fix | Delete

* @return string

[424] Fix | Delete

[425] Fix | Delete

function get_top_level_menu_slug() {

[426] Fix | Delete

return $this->has_custom_parent() ?

[427] Fix | Delete

$this->get_parent_slug() :

[428] Fix | Delete

$this->get_raw_slug();

[429] Fix | Delete

}

[430] Fix | Delete

[431] Fix | Delete

/**

[432] Fix | Delete

* Is user on plugin's admin activation page.

[433] Fix | Delete

[434] Fix | Delete

* @author Vova Feldman (@svovaf)

[435] Fix | Delete

* @since 1.0.8

[436] Fix | Delete

[437] Fix | Delete

* @param bool $show_opt_in_on_themes_page Since 2.3.1

[438] Fix | Delete

[439] Fix | Delete

* @return bool

[440] Fix | Delete

[441] Fix | Delete

* @deprecated Please use is_activation_page() instead.

[442] Fix | Delete

[443] Fix | Delete

function is_main_settings_page( $show_opt_in_on_themes_page = false ) {

[444] Fix | Delete

return $this->is_activation_page( $show_opt_in_on_themes_page );

[445] Fix | Delete

}

[446] Fix | Delete

[447] Fix | Delete

/**

[448] Fix | Delete

* Is user on product's admin activation page.

[449] Fix | Delete

[450] Fix | Delete

* @author Vova Feldman (@svovaf)

[451] Fix | Delete

* @since 2.3.1

[452] Fix | Delete

[453] Fix | Delete

* @param bool $show_opt_in_on_themes_page Since 2.3.1

[454] Fix | Delete

[455] Fix | Delete

* @return bool

[456] Fix | Delete

[457] Fix | Delete

function is_activation_page( $show_opt_in_on_themes_page = false ) {

[458] Fix | Delete

if ( $show_opt_in_on_themes_page ) {

[459] Fix | Delete

/**

[460] Fix | Delete

* In activation only when show_optin query string param is given.

[461] Fix | Delete

[462] Fix | Delete

* @since 1.2.2

[463] Fix | Delete

[464] Fix | Delete

return (

[465] Fix | Delete

( WP_FS__MODULE_TYPE_THEME === $this->_module_type ) &&

[466] Fix | Delete

Freemius::is_themes_page() &&

[467] Fix | Delete

fs_request_get_bool( $this->_module_unique_affix . '_show_optin' )

[468] Fix | Delete

);

[469] Fix | Delete

}

[470] Fix | Delete

[471] Fix | Delete

if ( $this->_menu_exists &&

[472] Fix | Delete

( fs_is_plugin_page( $this->_menu_slug ) || fs_is_plugin_page( $this->_module_unique_affix ) )

[473] Fix | Delete

) {

[474] Fix | Delete

/**

[475] Fix | Delete

* Module has a settings menu and the context page is the main settings page, so assume it's in

[476] Fix | Delete

* activation (doesn't really check if already opted-in/skipped or not).

[477] Fix | Delete

[478] Fix | Delete

* @since 1.2.2

[479] Fix | Delete

[480] Fix | Delete

return true;

[481] Fix | Delete

}

[482] Fix | Delete

[483] Fix | Delete

return false;

[484] Fix | Delete

}

[485] Fix | Delete

[486] Fix | Delete

#region Submenu Override

[487] Fix | Delete

[488] Fix | Delete

/**

[489] Fix | Delete

* Override submenu's action.

[490] Fix | Delete

[491] Fix | Delete

* @author Vova Feldman (@svovaf)

[492] Fix | Delete

* @since 1.1.0

[493] Fix | Delete

[494] Fix | Delete

* @param string $parent_slug

[495] Fix | Delete

* @param string $menu_slug

[496] Fix | Delete

* @param callable $function

[497] Fix | Delete

[498] Fix | Delete

* @return false|string If submenu exist, will return the hook name.

[499] Fix | Delete

12 3