En route pour la #BuddyPress REST API !

Publié le

par

Eleonora au sommet d'une montagne
Crédits Photo Eleonora Patricola

Après 2 années de contribution à l’organisation du WordCamp de Paris : des moments magiques et aussi un investissement personnel important qui a amoindri ma disponibilité auprès de l’équipe de développement du projet open source BuddyPress, j’ai récemment et progressivement « ré-accroché » mon wagon à la locomotive qui motorise vos sites WordPress communautaires.

Nous travaillons actuellement sur la 5e version majeure de l’extension et en particulier sur l’intégration d’une nouvelle API REST.

À quoi ça SERT REST ?

Comme l’explique cette excellente introduction de la documentation de la REST API de WordPress, la BP REST API facilitera, fiabilisera et standardisera la manière, pour les codeur·euse·s d’extensions, d’interagir avec les données des différents composants et objets de BuddyPress.

En particulier nous pourrons nous affranchir de la partie « serveur » (PHP) pour nous concentrer sur la partie « client » (JavaScript) et proposer aux utilisateur·rice·s des interfaces plus intuitives et rapides pour accéder aux fonctionnalités communautaires apportées par BuddyPress dans WordPress.

Notons qu’au fur et à mesure que nous remplacerons ce que nous faisions en AJAX jusqu’à présent par le recours à cette API nous gagnerons en fiabilité et en performance.

BuddyPress 5.0.0 : une première bêta dés la mi-août.

Nous espérons une belle participation des codeur·euse·s d’extensions BuddyPress lors de cette phase importante de notre 5e cycle de développement majeur. Nous avons en effet besoin d’éprouver avec des mises en pratique concrètes cette nouvelle API afin de confirmer le bon fonctionnement démontré par nos tests unitaires. Cette période nous permettra par ailleurs de compléter la documentation de la BP REST API : une ressource essentielle pour vous aider à l’exploiter dans les meilleures conditions.

Tâtonnons pour contribuer!

La BP REST API est d’ores et déjà intégrable par anticipation dans la mesure où, comme ce fut le cas pour celle de WordPress, nous avons choisi un modèle de développement « fonctionnalité élaborée en tant qu’extension autonome ». J’ai moi-même pas mal tâtonner en embarquant le contrôleur REST des activités dans une de mes extensions personnelles : « Activités de publication ».

Cette opération m’a notamment permis de contribuer concrètement à cette BP REST API en partageant une demande de modification (ou « pull request ») pour implémenter la fonctionnalité de mise en favoris des activités. Elle a d’ailleurs été fusionnée depuis ☺️.

Je crois que si une majorité d’auteur·e·s d’extensions BuddyPress m’imitaient nous mettrions collectivement toutes les chances de notre côté pour que nos utilisateur·rice·s finaux·ales puissent grandement en profiter.

Découvrez la version 2.0.0 des « Activités de Publication ».

J’ai poursuivi mon évaluation de cette REST API en apportant des évolutions à cette extension. La vidéo (English sous titrée en français) ci-dessus vous les présente et vous retrouverez plus bas un lien vers sa version bêta.

Liste des extensions activées d'un site WordPress.

Notez que vous aurez besoin, jusqu’à la sortie de la 5.0.0, de la version de développement de BuddyPress pour tester cette prochaine version des « Activités de publication ».

Pour vous aider dans l’installation de cette version particulière de BuddyPress sur votre environnement de test (surtout pas sur un site en production !), je vous propose de télécharger le fichier buddypress.zip de la section « Downloads » de cette page de pre-release perso.

Aperçu de conversations attachées à une page WordPress

Comme l’illustre la capture d’écran ci-dessus, les deux nouveautés par rapport à la première version de l’extension sont l’intégration de la fonction de commentaires et de mise en favoris des activités de publication postées.

Version bêta, ne pas utiliser sur un site en production. Nécessite BuddyPress 5.0.0

Afficher la page GitHub de la version

Bons tests !