Как добавить пользовательскую кнопку в карточку профиля пользователя?

Я рекомендую вам прочитать Using Plugin Outlet Connectors from a Theme or Plugin; это ответит на ваш вопрос!

По сути, плагин-аутлет — это способ внедрить код в определённое место.

Рекомендуется создать компонент темы с помощью CLI для тем и использовать отдельные файлы, как я сделал в своём компоненте темы здесь (не стесняйтесь клонировать мой репозиторий, чтобы вы могли протестировать или изменить его):

Однако вы всё ещё можете протестировать это, используя тег <script>:

В вашем случае вы напишете:

<script type='text/x-handlebars' data-template-name='/connectors/user-profile-controls/my_connector_name'>
  Содержимое шаблона здесь
</script>

Обратите внимание на первую строку. Мы используем user-profile-controls как имя коннектора, а my_connector_name может быть любым именем, которое вы хотите.