Plugin.php
168 lines
| 1 | <?php |
| 2 | |
| 3 | namespace EmbedPress\Plugins; |
| 4 | |
| 5 | (defined('ABSPATH') && defined('EMBEDPRESS_IS_LOADED')) or die("No direct script access allowed."); |
| 6 | |
| 7 | /** |
| 8 | * Entity that represents a model to EmbedPress plugins. |
| 9 | * |
| 10 | * @package EmbedPress |
| 11 | * @author EmbedPress <help@embedpress.com> |
| 12 | * @copyright Copyright (C) 2023 WPDeveloper. All rights reserved. |
| 13 | * @license GPLv3 or later |
| 14 | * @since 1.4.0 |
| 15 | * @abstract |
| 16 | */ |
| 17 | abstract class Plugin |
| 18 | { |
| 19 | const VERSION = '0.0.0'; |
| 20 | |
| 21 | /** |
| 22 | * Method that register all EmbedPress events. |
| 23 | * |
| 24 | * @since 1.4.0 |
| 25 | * @static |
| 26 | * |
| 27 | * @return void |
| 28 | */ |
| 29 | public static function registerEvents() |
| 30 | { |
| 31 | // do nothing |
| 32 | } |
| 33 | |
| 34 | /** |
| 35 | * Method that checks if EmbedPress is active or not. |
| 36 | * |
| 37 | * @since 1.4.0 |
| 38 | * @access protected |
| 39 | * @static |
| 40 | * |
| 41 | * @return boolean |
| 42 | */ |
| 43 | protected static function isEmbedPressActive() |
| 44 | { |
| 45 | return is_plugin_active(EMBEDPRESS_PLG_NAME . '/' . EMBEDPRESS_PLG_NAME . '.php'); |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Retrieve an error message based on its code. |
| 50 | * |
| 51 | * @since 1.4.0 |
| 52 | * @access protected |
| 53 | * @static |
| 54 | * |
| 55 | * @param string $err The error code. |
| 56 | * |
| 57 | * @return string |
| 58 | */ |
| 59 | protected static function getErrorMessage($err = '') |
| 60 | { |
| 61 | if ($err === 'ERR_MISSING_DEPENDENCY') { |
| 62 | return __('Please, <strong>install</strong> and <strong>activate <a href="https://wordpress.org/plugins/' . EMBEDPRESS_PLG_NAME . '" target="_blank" rel="noopener noreferrer">' . EMBEDPRESS . '</a></strong> plugin in order to make <em>' . EMBEDPRESS . ' - ' . static::NAME . '</em> to work.'); |
| 63 | } |
| 64 | |
| 65 | return $err; |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * Callback triggered by WordPress' 'admin_init' default action. |
| 70 | * |
| 71 | * @since 1.4.0 |
| 72 | * @static |
| 73 | * |
| 74 | * @return void |
| 75 | */ |
| 76 | public static function onLoadAdminCallback() |
| 77 | { |
| 78 | $pluginSignature = EMBEDPRESS_PLG_NAME . '-' . static::SLUG . '/' . EMBEDPRESS_PLG_NAME . '-' . static::SLUG . '.php'; |
| 79 | if (is_admin() && ! self::isEmbedPressActive() && is_plugin_active($pluginSignature)) { |
| 80 | deactivate_plugins($pluginSignature); |
| 81 | } |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Callback triggered by WordPress' 'register_activation_hook' function. |
| 86 | * @return bool |
| 87 | *@since 1.4.0 |
| 88 | * @static |
| 89 | */ |
| 90 | public static function onActivationCallback() |
| 91 | { |
| 92 | return true; |
| 93 | } |
| 94 | |
| 95 | /** |
| 96 | * Callback triggered by WordPress' 'register_deactivation_hook' function. |
| 97 | * |
| 98 | * @since 1.4.0 |
| 99 | * @static |
| 100 | * |
| 101 | * @return void |
| 102 | */ |
| 103 | public static function onDeactivationCallback() |
| 104 | { |
| 105 | delete_option(EMBEDPRESS_PLG_NAME . ':' . static::SLUG); |
| 106 | } |
| 107 | |
| 108 | |
| 109 | /** |
| 110 | * Retrieve user defined options. |
| 111 | * |
| 112 | * @since 1.4.0 |
| 113 | * @static |
| 114 | * |
| 115 | * @return array |
| 116 | */ |
| 117 | public static function getOptions() |
| 118 | { |
| 119 | $options = (array)get_option(EMBEDPRESS_PLG_NAME . ':' . static::SLUG); |
| 120 | if (empty($options) || (count($options) === 1 && empty($options[0]))) { |
| 121 | $options = []; |
| 122 | $schema = static::getOptionsSchema(); |
| 123 | foreach ($schema as $fieldSlug => $field) { |
| 124 | $value = isset($field['default']) ? $field['default'] : ""; |
| 125 | |
| 126 | settype($value, isset($field['type']) && in_array(strtolower($field['type']), |
| 127 | ['bool', 'boolean', 'int', 'integer', 'float', 'string']) ? $field['type'] : 'string'); |
| 128 | |
| 129 | if ($fieldSlug === "license_key") { |
| 130 | $options['license'] = [ |
| 131 | 'key' => true, |
| 132 | 'status' => "missing", |
| 133 | ]; |
| 134 | } else { |
| 135 | $options[$fieldSlug] = $value; |
| 136 | } |
| 137 | } |
| 138 | } |
| 139 | |
| 140 | $options['license'] = [ |
| 141 | 'key' => true, |
| 142 | 'status' => "missing", |
| 143 | ]; |
| 144 | |
| 145 | return $options; |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Handle links displayed below the plugin name in the WordPress Installed Plugins page. |
| 150 | * |
| 151 | * @since 1.4.0 |
| 152 | * @static |
| 153 | * |
| 154 | * @return array |
| 155 | */ |
| 156 | public static function handleActionLinks($links, $file) |
| 157 | { |
| 158 | $settingsLink = '<a href="' . admin_url('admin.php?page=' . EMBEDPRESS_PLG_NAME . '&page_type=' . static::SLUG) . '" aria-label="' . __('Open settings page', |
| 159 | 'embedpress') . '">' . __('Settings', 'embedpress') . '</a>'; |
| 160 | |
| 161 | array_unshift($links, $settingsLink); |
| 162 | if ( !apply_filters('embedpress/is_allow_rander', false) ) { |
| 163 | $links[] = '<a href="https://wpdeveloper.com/in/upgrade-embedpress" target="_blank" class="embedpress-go-pro-action" style="color: green">'.__('Go Pro', 'embedpress').'</a>'; |
| 164 | } |
| 165 | return $links; |
| 166 | } |
| 167 | } |
| 168 |