← All changes
|
includes/core/rest-api/Controllers/DashboardController.php
+50
-1
3.12.13
→
3.13.3
View file →
| @@ -16,8 +16,19 @@ | ||
| 16 | 16 | class DashboardController extends Wpfnl_REST_Controller |
| 17 | 17 | { |
| 18 | 18 | |
| 19 | 19 | /** |
| 20 | + * Transient holding the last known answer to "is the onboarding checklist | |
| 21 | + * on show?", read by the admin page so it can decide whether to hold space | |
| 22 | + * for it while the real status loads. | |
| 23 | + * | |
| 24 | + * @var string | |
| 25 | + * @since 3.13.3 | |
| 26 | + */ | |
| 27 | + const ONBOARDING_VISIBILITY_KEY = 'wpfnl_onboarding_should_show'; | |
| 28 | + | |
| 29 | + | |
| 30 | + /** | |
| 20 | 31 | * Endpoint namespace. |
| 21 | 32 | * |
| 22 | 33 | * @var string |
| 23 | 34 | * @since 3.2.0 |
| @@ -181,8 +192,19 @@ | ||
| 181 | 192 | } |
| 182 | 193 | |
| 183 | 194 | |
| 184 | 195 | /** |
| 196 | + * Cache payload version. Bump whenever the shape or the meaning of a cached | |
| 197 | + * report response changes, so entries written by an older build are ignored | |
| 198 | + * instead of served until they expire. | |
| 199 | + * | |
| 200 | + * @var string | |
| 201 | + * @since 3.13.0 | |
| 202 | + */ | |
| 203 | + const CACHE_VERSION = 'v2'; | |
| 204 | + | |
| 205 | + | |
| 206 | + /** | |
| 185 | 207 | * Build a cache key from a prefix and parameter array. |
| 186 | 208 | * |
| 187 | 209 | * @param string $prefix |
| 188 | 210 | * @param array $params |
| @@ -190,9 +212,9 @@ | ||
| 190 | 212 | * |
| 191 | 213 | * @since 3.9.6 |
| 192 | 214 | */ |
| 193 | 215 | protected function get_cache_key( $prefix, $params ) { |
| 194 | - return 'wpfnl_dash_' . $prefix . '_' . md5( serialize( $params ) ); | |
| 216 | + return 'wpfnl_dash_' . $prefix . '_' . self::CACHE_VERSION . '_' . md5( serialize( $params ) ); | |
| 195 | 217 | } |
| 196 | 218 | |
| 197 | 219 | |
| 198 | 220 | /** |
| @@ -288,8 +310,31 @@ | ||
| 288 | 310 | } |
| 289 | 311 | |
| 290 | 312 | |
| 291 | 313 | /** |
| 314 | + * Remember whether the checklist was on show, for the next page load. | |
| 315 | + * | |
| 316 | + * Working this out costs several queries, so the admin page cannot ask | |
| 317 | + * before it prints — but it can read the last answer. The React dashboard | |
| 318 | + * uses it for one thing: whether to hold space for the checklist while the | |
| 319 | + * real status loads. Someone who is done with onboarding then sees no | |
| 320 | + * placeholder at all, instead of a skeleton that resolves to nothing. | |
| 321 | + * | |
| 322 | + * Short lived on purpose: it only has to outlive the gap between one page | |
| 323 | + * load and the next, and a stale answer costs at most one wrong placeholder. | |
| 324 | + * | |
| 325 | + * @param bool $is_visible Whether the checklist is on show. | |
| 326 | + * | |
| 327 | + * @return void | |
| 328 | + * @since 3.13.3 | |
| 329 | + */ | |
| 330 | + private function remember_onboarding_visibility( $is_visible ) | |
| 331 | + { | |
| 332 | + set_transient( self::ONBOARDING_VISIBILITY_KEY, $is_visible ? 'yes' : 'no', 15 * MINUTE_IN_SECONDS ); | |
| 333 | + } | |
| 334 | + | |
| 335 | + | |
| 336 | + /** | |
| 292 | 337 | * Get onboarding status. |
| 293 | 338 | * |
| 294 | 339 | * Determines whether the onboarding section should be shown on the dashboard. |
| 295 | 340 | * The onboarding is hidden when ALL three conditions are met: |
| @@ -306,8 +351,10 @@ | ||
| 306 | 351 | { |
| 307 | 352 | // ── Check if onboarding has been dismissed ── |
| 308 | 353 | $is_dismissed = get_transient( 'wpfnl_onboarding_dismissed' ); |
| 309 | 354 | if ( $is_dismissed ) { |
| 355 | + $this->remember_onboarding_visibility( false ); | |
| 356 | + | |
| 310 | 357 | return rest_ensure_response( array( |
| 311 | 358 | 'success' => true, |
| 312 | 359 | 'show_onboarding' => false, |
| 313 | 360 | 'steps' => array(), |
| @@ -521,8 +568,10 @@ | ||
| 521 | 568 | } |
| 522 | 569 | |
| 523 | 570 | $total_steps = count($steps_status); |
| 524 | 571 | $progress_percent = $total_steps > 0 ? round(($completed_count / $total_steps) * 100) : 0; |
| 572 | + | |
| 573 | + $this->remember_onboarding_visibility( !$should_hide_onboarding ); | |
| 525 | 574 | |
| 526 | 575 | return rest_ensure_response(array( |
| 527 | 576 | 'success' => true, |
| 528 | 577 | 'show_onboarding' => !$should_hide_onboarding, |