Uitleg en rondleidingen voor je eigen schermen

Sinds versie 2.9.0 kun je je eigen schermen uitleggen met een kaart bij het eerste bezoek en een rondleiding langs de onderdelen van het scherm.

Een module implementeert AddoBack\Modules\ProvidesGuides (guides(): array). Een plugin of thema zonder module gebruikt de filter adba_guides:

add_filter( 'adba_guides', static function ( array $guides ) {
	$guides[] = array(
		'id'      => 'myplugin-intro',          // Stable; the seen state per user is keyed on it.
		'version' => 1,                         // Raise it to show the guide again, marked New.
		'screens' => array( 'toplevel_page_myplugin' ), // Screen ids or bases, 'post_type:slug' or '*'.
		'title'   => __( 'My plugin', 'myplugin' ),
		'body'    => '<p>' . esc_html__( 'Two or three sentences.', 'myplugin' ) . '</p>', // wp_kses_post.
		'steps'   => array(
			array( 'target' => '#myplugin-box', 'title' => __( 'The box', 'myplugin' ), 'body' => __( 'What it does.', 'myplugin' ), 'placement' => 'bottom' ),
		),
	);
	return $guides;
} );

Velden

• id is stabiel. De gezien-status van elke gebruiker wordt eronder bewaard.
• version is een getal. Verhoog het om de uitleg opnieuw te tonen; hij krijgt dan het label Nieuw.
• screens noemt de schermen: scherm-id's of bases, post_type:slug of *.
• body gaat door wp_kses_post.
• Elke stap heeft een target (een CSS-selector), een title, een body en een placement.
• Een stap kan met open een menu noemen dat eerst geopend wordt, bijvoorbeeld 'open' => '#wp-admin-bar-my-account' voor een item in het accountmenu. De rondleiding sluit het weer bij de volgende stap.
• Stappen waarvan het doel niet op de pagina staat, worden overgeslagen.

Uitleg aan en uit zetten

Gebruikers zetten uitleg uit in het accountmenu. De site stelt guide_mode in (auto of on_demand); de filter adba_guide_mode wijzigt dat in code.

Om alle uitleg opnieuw te tonen, draai je:

wp adba guides reset <id|login>
wp adba guides reset --all

Events

De JavaScript-events guide:open ({ id, type }, met type card of tour) en guide:done ({ id, completed }) laten je weten wanneer een uitleg openging en sloot. completed is waar als elke stap van de rondleiding gezien is. Zie de JavaScript-API.

Gerelateerd

• Hooks voor shell, adminbalk en voorkeuren