class-deprecate.php
2 years ago
class-jetpack-crm-data.php
2 years ago
class-jetpack-modules-overrides.php
3 years ago
class-tracking.php
2 years ago
class-deprecate.php
186 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Place to properly deprecate Jetpack features. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | namespace Automattic\Jetpack\Plugin; |
| 9 | |
| 10 | use Automattic\Jetpack\Assets; |
| 11 | use Automattic\Jetpack\Modules; |
| 12 | use Automattic\Jetpack\Redirect; |
| 13 | use Automattic\Jetpack\Status\Host; |
| 14 | |
| 15 | /** |
| 16 | * Place to properly deprecate Jetpack features. |
| 17 | */ |
| 18 | class Deprecate { |
| 19 | |
| 20 | /** |
| 21 | * The singleton instance. |
| 22 | * |
| 23 | * @var Deprecate |
| 24 | */ |
| 25 | private static $instance; |
| 26 | |
| 27 | /** |
| 28 | * Initialize the class. |
| 29 | */ |
| 30 | private function __construct() { |
| 31 | if ( $this->has_notices() ) { |
| 32 | add_action( 'admin_notices', array( $this, 'render_admin_notices' ) ); |
| 33 | add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) ); |
| 34 | add_filter( 'my_jetpack_red_bubble_notification_slugs', array( $this, 'add_my_jetpack_red_bubbles' ) ); |
| 35 | add_filter( 'jetpack_modules_list_table_items', array( $this, 'remove_masterbar_module_list' ) ); |
| 36 | } |
| 37 | } |
| 38 | |
| 39 | /** |
| 40 | * Create/get the singleton instance. |
| 41 | * |
| 42 | * @return static |
| 43 | */ |
| 44 | public static function instance() { |
| 45 | if ( null === static::$instance ) { |
| 46 | static::$instance = new static(); |
| 47 | } |
| 48 | |
| 49 | return static::$instance; |
| 50 | } |
| 51 | |
| 52 | /** |
| 53 | * Enqueue the scripts. |
| 54 | * |
| 55 | * @return void |
| 56 | */ |
| 57 | public function enqueue_admin_scripts() { |
| 58 | if ( ! $this->has_notices() ) { |
| 59 | return; |
| 60 | } |
| 61 | |
| 62 | if ( ! wp_script_is( 'jetpack-deprecate', 'registered' ) ) { |
| 63 | wp_register_script( |
| 64 | 'jetpack-deprecate', |
| 65 | Assets::get_file_url_for_environment( '_inc/build/deprecate.min.js', '_inc/deprecate.js' ), |
| 66 | array(), |
| 67 | JETPACK__VERSION, |
| 68 | true |
| 69 | ); |
| 70 | } |
| 71 | |
| 72 | wp_enqueue_script( 'jetpack-deprecate' ); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Render deprecation notices for relevant features. |
| 77 | * |
| 78 | * @return void |
| 79 | */ |
| 80 | public function render_admin_notices() { |
| 81 | if ( $this->show_masterbar_notice() ) { |
| 82 | $support_url = Redirect::get_url( 'jetpack-support-masterbar' ); |
| 83 | |
| 84 | $this->render_notice( |
| 85 | 'jetpack-masterbar-admin-removal-notice', |
| 86 | esc_html__( "Jetpack's WordPress.com Toolbar feature has been removed.", 'jetpack' ) |
| 87 | . ' <a href="' . $support_url . '" target="_blank">' . esc_html__( 'To find out more about what this means for you, please refer to this document', 'jetpack' ) . '</a>.' |
| 88 | ); |
| 89 | } |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Add the deprecation notices to My Jetpack. |
| 94 | * |
| 95 | * @param array $slugs Already added bubbles. |
| 96 | * |
| 97 | * @return array |
| 98 | */ |
| 99 | public function add_my_jetpack_red_bubbles( $slugs ) { |
| 100 | if ( $this->show_masterbar_notice() ) { |
| 101 | $slugs['jetpack-masterbar-deprecate-feature'] = array( |
| 102 | 'data' => array( |
| 103 | 'text' => __( "Jetpack's WordPress.com Toolbar feature has been removed.", 'jetpack' ), |
| 104 | 'link' => array( |
| 105 | 'label' => esc_html__( 'See documentation', 'jetpack' ), |
| 106 | 'url' => Redirect::get_url( 'jetpack-support-masterbar' ), |
| 107 | ), |
| 108 | 'id' => 'jetpack-masterbar-admin-removal-notice', |
| 109 | ), |
| 110 | ); |
| 111 | } |
| 112 | |
| 113 | return $slugs; |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Render the notice. |
| 118 | * |
| 119 | * @param string $id The notice ID. |
| 120 | * @param string $text The notice text. |
| 121 | * @param array $params Additional notice params. |
| 122 | * |
| 123 | * @return void |
| 124 | */ |
| 125 | private function render_notice( $id, $text, $params = array() ) { |
| 126 | if ( ! empty( $_COOKIE['jetpack_deprecate_dismissed'][ $id ] ) ) { |
| 127 | return; |
| 128 | } |
| 129 | |
| 130 | $params['id'] = $id; |
| 131 | |
| 132 | if ( empty( $params['type'] ) ) { |
| 133 | $params['type'] = 'warning'; |
| 134 | } |
| 135 | |
| 136 | if ( empty( $params['dismissible'] ) ) { |
| 137 | $params['dismissible'] = true; |
| 138 | } |
| 139 | |
| 140 | if ( $params['dismissible'] ) { |
| 141 | if ( empty( $params['additional_classes'] ) ) { |
| 142 | $params['additional_classes'] = array(); |
| 143 | } |
| 144 | |
| 145 | $params['additional_classes'][] = 'jetpack-deprecate-dismissible'; |
| 146 | } |
| 147 | |
| 148 | wp_admin_notice( $text, $params ); |
| 149 | } |
| 150 | |
| 151 | /** |
| 152 | * Check if there are any notices to be displayed, so we wouldn't load unnecessary JS and run excessive hooks. |
| 153 | * |
| 154 | * @return bool |
| 155 | */ |
| 156 | private function has_notices() { |
| 157 | return $this->show_masterbar_notice(); |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Check if Masterbar notice should show up. |
| 162 | * |
| 163 | * @return bool |
| 164 | */ |
| 165 | private function show_masterbar_notice() { |
| 166 | return ( new Modules() )->is_active( 'masterbar', false ) |
| 167 | && ! ( new Host() )->is_woa_site() |
| 168 | && empty( $_COOKIE['jetpack_deprecate_dismissed']['jetpack-masterbar-admin-removal-notice'] ); |
| 169 | } |
| 170 | |
| 171 | /** |
| 172 | * Remove Masterbar from the old Module list. |
| 173 | * Available at wp-admin/admin.php?page=jetpack_modules |
| 174 | * We only need this function until the Masterbar is fully removed from Jetpack (including notices). |
| 175 | * |
| 176 | * @param array $items Array of Jetpack modules. |
| 177 | * @return array |
| 178 | */ |
| 179 | public function remove_masterbar_module_list( $items ) { |
| 180 | if ( isset( $items['masterbar'] ) && get_option( 'wpcom_admin_interface' ) !== 'wp-admin' ) { |
| 181 | unset( $items['masterbar'] ); |
| 182 | } |
| 183 | return $items; |
| 184 | } |
| 185 | } |
| 186 |