is_setup_screen()) {
return;
}
foreach (['admin_notices', 'all_admin_notices', 'network_admin_notices', 'user_admin_notices'] as $action) {
remove_all_actions($action);
}
}
/**
* Admin URL of the guided-setup screen.
*/
public static function setupUrl()
{
return admin_url('edit.php?post_type=bp3d-model-viewer&page=' . self::SETUP_SLUG);
}
/**
* Whether the setup screen exists; the class is absent when an older
* build is running. A licensed site can open it, but is never sent there.
*/
private static function onboarding_available()
{
return class_exists('\BP3D\Base\Onboarding');
}
/**
* Whether the current request is the guided-setup screen.
*/
private function is_setup_screen()
{
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Read-only screen check, no state change.
return isset($_GET['page']) && self::SETUP_SLUG === sanitize_key(wp_unslash($_GET['page']));
}
/**
* Send the pre-1.9.4 slug and the admin.php form of the URL (used by Pro
* and old docs) to the real screen instead of WordPress' access error.
*/
public function redirect_legacy_setup_url()
{
global $pagenow;
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Read-only redirect, no state change.
$page = isset($_GET['page']) ? sanitize_key(wp_unslash($_GET['page'])) : '';
$is_legacy = self::LEGACY_SETUP_SLUG === $page;
$is_admin_php = self::SETUP_SLUG === $page && 'admin.php' === $pagenow;
if (!self::onboarding_available() || !($is_legacy || $is_admin_php) || !current_user_can('manage_options')) {
return;
}
wp_safe_redirect(self::setupUrl());
exit;
}
/**
* Enqueue dashboard scripts and styles on relevant admin pages.
*/
public function enqueue_admin_scripts($hook)
{
// Checked before the slug guard below: the setup screen's hook also
// contains '3d-viewer', but it loads its own bundle.
if (self::onboarding_available() && $this->is_setup_screen()) {
$this->enqueue_setup_scripts();
return;
}
if (strpos($hook, '3d-viewer') === false) {
return;
}
// The stylesheet keeps its old scope: it also hides admin notices on these screens.
wp_enqueue_style(
'bp3d-dashboard',
BP3D_DIR . 'build/dashboard.css',
[],
\BP3D\Base\EnqueueAssets::styleVersion('build/dashboard.css')
);
if (!$this->dashboard_hook || $hook !== $this->dashboard_hook) {
return;
}
$asset = \BP3D\Base\EnqueueAssets::buildAsset('dashboard');
$deps = array_values(array_unique(array_merge(
(array) ($asset['dependencies'] ?? ['react', 'wp-api-fetch', 'wp-data', 'wp-i18n']),
['react-dom', 'wp-util']
)));
// Not 'bp3d-admin-script': EnqueueAssets registers build/admin.js under that handle.
wp_enqueue_script(
'bp3d-dashboard',
BP3D_DIR . 'build/dashboard.js',
$deps,
// The build hash, so a rebuilt bundle is never served from the browser cache.
$asset['version'] ?? BP3D_VERSION,
true
);
wp_set_script_translations('bp3d-dashboard', '3d-viewer', BP3D_PATH . 'languages');
wp_localize_script('bp3d-dashboard', 'bp3dDashboard', [
'dir' => BP3D_DIR,
]);
}
/**
* Assets for the guided-setup screen.
*
* A separate bundle from the dashboard so the wizard doesn't pull in
* demos, pricing, and the router it never uses.
*/
private function enqueue_setup_scripts()
{
// Build hash busts the browser cache between releases, not just on a version bump.
$asset = \BP3D\Base\EnqueueAssets::buildAsset('onboarding');
$version = $asset['version'] ?? BP3D_VERSION;
wp_enqueue_style(
'bp3d-onboarding',
BP3D_DIR . 'build/onboarding.css',
[],
$version
);
// Fallback for notices injected after load (JS or late hooks) that suppress_setup_notices() can't reach.
// The footer goes too, with the padding wp-admin reserves for it.
wp_add_inline_style('bp3d-onboarding', '#wpbody-content > :not(#bp3dOnboarding), #wpfooter { display: none !important; } #wpbody-content { padding-bottom: 0; }');
wp_enqueue_script(
'bp3d-onboarding-script',
BP3D_DIR . 'build/onboarding.js',
['react', 'react-dom', 'wp-i18n', 'wp-util'],
$version,
true
);
wp_set_script_translations('bp3d-onboarding-script', '3d-viewer', BP3D_PATH . 'languages');
}
/**
* Register admin submenu pages.
*/
public function register_admin_menus()
{
$this->dashboard_hook = (string) add_submenu_page(
'edit.php?post_type=bp3d-model-viewer',
__('Help & Demos - 3D Viewer', '3d-viewer'),
'' . __('Help & Demos', '3d-viewer') . '',
'edit_posts',
'3d-viewer',
[$this, 'render_dashboard_page'],
9
);
if (!self::onboarding_available()) {
return;
}
// Registered so the screen is reachable by URL, then hidden from the
// menu. add_submenu_page( null, ... ) would do the same but is
// deprecated as of PHP 8.1.
$setup_hook = add_submenu_page(
'edit.php?post_type=bp3d-model-viewer',
__('Guided Setup - 3D Viewer', '3d-viewer'),
__('Guided Setup', '3d-viewer'),
'manage_options',
self::SETUP_SLUG,
[$this, 'render_setup_page']
);
remove_submenu_page('edit.php?post_type=bp3d-model-viewer', self::SETUP_SLUG);
// get_admin_page_title() derives $title by scanning the $submenu
// global, and we just removed our entry from it. Without this the
// global stays null and admin-header.php trips PHP 8.1's
// "strip_tags(): passing null" deprecation.
if ($setup_hook) {
add_action("load-{$setup_hook}", function () {
$GLOBALS['title'] = __('Guided Setup - 3D Viewer', '3d-viewer');
});
}
}
/**
* Render the main dashboard/help page.
*/
public function render_dashboard_page()
{
$info = wp_json_encode([
'version' => BP3D_VERSION,
'adminUrl' => rtrim(admin_url(), '/'),
'setupUrl' => self::setupUrl(),
// Drives the "Guided Setup" nav entry: shown with the progress
// so far until the wizard has been run to the end.
'onboarding' => class_exists('\BP3D\Base\Onboarding')
? \BP3D\Base\Onboarding::state()
: ['completed' => true, 'percent' => 100],
'canManageOptions' => current_user_can('manage_options'),
// Our Plugins hides Install/Activate for users the REST plugins route would refuse.
'canInstallPlugins' => current_user_can('install_plugins'),
'canActivatePlugins' => current_user_can('activate_plugins'),
'extensions' => $this->extensions_data(),
], JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT);
?>
get_manager('3d-viewer');
return $manager && $manager->extensions_enabled() ? $manager : null;
}
/**
* What the dashboard's Extensions screen needs: the same list as BPEM's REST route, preloaded so
* the cards paint at once. Null when BPEM is absent or the user cannot manage extensions.
*/
private function extensions_data()
{
$manager = $this->extension_manager();
if (!$manager || !current_user_can($manager->get_config('capability', 'manage_options'))) {
return null;
}
$slug = $manager->get_slug();
$user = wp_get_current_user();
try {
$items = array_values((array) $manager->catalog()->get_merged($manager));
} catch (\Throwable $e) {
$items = [];
}
return [
'items' => $items,
'restPath' => '/bpem/' . $slug . '/v1',
'ajaxUrl' => admin_url('admin-ajax.php'),
'ajaxNonce' => wp_create_nonce('bpem_' . $slug . '_admin'),
'licenseAction' => 'bpem_' . $slug . '_license',
'isMaxPlan' => (bool) $manager->is_max_plan(),
'canInstall' => current_user_can('install_plugins'),
'checkoutEnabled' => (bool) $manager->freemius_checkout_enabled(),
'buyer' => [
'email' => $user->user_email,
'first' => $user->user_firstname,
'last' => $user->user_lastname,
],
];
}
/**
* Render the guided setup wizard.
*/
public function render_setup_page()
{
if (!self::onboarding_available()) {
return;
}
$info = wp_json_encode([
'isPremium' => !\BP3D\Base\Onboarding::is_available(),
'ajaxAction' => \BP3D\Base\Onboarding::AJAX_ACTION,
// Must be created for the same action the handler verifies.
'nonce' => wp_create_nonce(\BP3D\Base\Onboarding::AJAX_ACTION),
'dir' => BP3D_DIR,
'userName' => wp_get_current_user()->display_name,
'hasElementor' => did_action('elementor/loaded') > 0,
'urls' => [
'addModel' => admin_url('post-new.php?post_type=bp3d-model-viewer'),
'addPage' => admin_url('post-new.php?post_type=page'),
'dashboard' => admin_url('edit.php?post_type=bp3d-model-viewer&page=3d-viewer'),
'upgrade' => admin_url('edit.php?post_type=bp3d-model-viewer&page=3d-viewer#/pricing'),
'tutorial' => 'https://youtu.be/Tno8LiebxaI',
],
]);
?>