Help:Growth/Mentorship/Integrating mentorship/en

Context
Some projects have already some sort of mentorship system in place. A common example are bots that post welcome messages on the talk pages of newcomers, signed by a random experienced user from a list. The Growth features also assign a random mentor to newcomers from a list. Therefore, enabling the Growth features on such projects can duplicate mentorship for newcomers, with newcomers seeing that they have different mentors from different places. It makes sense to allow such projects to retrieve the Growth Team mentor assigned to each user, so they can integrate it with their own mentorship systems, and give the newcomer the same mentor in all places.

Magic word
This is now possible via a magic word, which was introduced in February 2021. The magic word takes one parameter, the username of the mentee, and returns raw username of the mentor. The magic word will return an empty string in case the mentee does not have any mentor assigned (for instance, because they don't have the newcomer homepage enabled).

Usage
For example, to get the mentor of User:Martin Urbanec (WMF), one would write, which would return the raw username of the mentor.

You can use the magic word together with the  parser function, to incorporate a fallback mechanism into your project's templates.


 * Examples :

The examples below assume that the mentee is User:Mentee, who is mentored by User:Mentor.


 * – will output Mentor
 * – will output User:Mentor
 * – used in a welcome message on the mentee's talk page, will output Mentor
 * – used on the mentee's draft page, will output Mentor
 * – will ping Mentor. Important: the  part is required; pinging will not work without it.