Edit File by line

# Introductions

[0] Fix | Delete

[1] Fix | Delete

Is for showing introductions to a user, on Yoast admin pages.

[2] Fix | Delete

Based on plugin version, page, user capabilities and whether the user has seen it already.

[3] Fix | Delete

[4] Fix | Delete

- `Introduction_Interface` defines what data is needed

[5] Fix | Delete

- `id` as unique identifier

[6] Fix | Delete

- `plugin` and `version` to determine if the introduction is new (version > plugin version)

[7] Fix | Delete

- `pages` to be able to only show on certain Yoast admin pages

[8] Fix | Delete

- `capabilities` to be able to only show for certain users

[9] Fix | Delete

- `Introductions_Collector` uses that data to determine whether an introduction should be "shown" to a user

[10] Fix | Delete

- uses the `wpseo_introductions` filter to be extendable from our other plugins

[11] Fix | Delete

- uses `Introductions_Seen_Repository` to get the data to determine if the user saw an introduction already

[12] Fix | Delete

- `Introductions_Seen_Repository` is the doorway whether a user has seen an introduction or not

[13] Fix | Delete

- uses the `_yoast_introductions` user metadata

[14] Fix | Delete

- `Introduction_Bucket` and `Introduction_Item` are used by the collector to get an array

[15] Fix | Delete

- `Introductions_Integration` runs on the Yoast Admin pages and loads the assets

[16] Fix | Delete

- only loads on our Yoast admin pages, but never on our installation success pages as to not disturb onboarding

[17] Fix | Delete

- only loads assets if there is an introduction to show

[18] Fix | Delete

- `js/src/introductions` holds the JS

[19] Fix | Delete

- `wpseoIntroductions` is the localized script to transfer data from PHP to JS

[20] Fix | Delete

- `css/src/ai-generator.css` holds the CSS

[21] Fix | Delete

[22] Fix | Delete

Inside JS, register the modal content via `window.YoastSEO._registerIntroductionComponent`, which takes a

[23] Fix | Delete

`id` and a `Component`. The id needs to be the same as the id in the `Introduction_Interface`.

[24] Fix | Delete

The action `yoast.introductions.ready` can be used to know whether the registration function is available and ready for

[25] Fix | Delete

use.

[26] Fix | Delete

[27] Fix | Delete