Websource Marques pour WordPress — référence développeur

Vue d'ensemble

• Slug : websource-brands · espace de noms PHP : Websource\Brands · domaine de traduction : websource-brands.
• Données : taxonomie native product_brand de WooCommerce ; logo = méta de terme thumbnail_id.
• Réglages : une option wsx_brands_settings (tableau). Aucune table.
• Sans WooCommerce, l'extension est inerte : le code court renvoie une chaîne vide, le bloc et les routes REST ne sont pas enregistrés.

Bloc websource/brands

Bloc à rendu serveur (blocks/brands/block.json), catégorie WooCommerce, alignements wide et full.

Le choix des marques (selection, brand_ids, only_with_products) et l'apparence viennent des réglages enregistrés.

<!-- wp:websource/brands {"title":"Nos marques","layout":"carousel","limit":10,"align":"wide"} /-->

Code court [websource_brands]

Sans attribut, il reprend les réglages enregistrés. Chaque attribut remplace le réglage du même nom.

[websource_brands layout="carousel" limit="10" grayscale="0" title="Nos partenaires"]
[websource_brands layout="list" limit="0" only_with_products="0" show_count="1"]
[websource_brands brands="16,17,19" sort="manual" manual_order="19,16,17"]

Fonction PHP

websource_brands_render( array $options = [] ): string

Mêmes clés que le code court (en snake_case ou camelCase). Renvoie le HTML, ou une chaîne vide s'il n'y a aucune marque à afficher ou si WooCommerce est absent.

<?php echo websource_brands_render( [ 'layout' => 'list', 'limit' => 0 ] ); ?>

Accès aux services : \Websource\Brands\Plugin::instance() expose store() (réglages), cache(), viewBuilder(), render(), flushCache().

Emplacements automatiques

Réglés dans l'administration (12 au plus). Chaque emplacement = une position + un type de page.

Types de page : all, home, shop, category, product, brand, cms, blog, search, cart, notfound. Une position n'est rendue qu'une fois par page. Dans un modèle de blocs sans groupe <main>, page_top se replie après l'en-tête et page_bottom avant le pied de page.

Filtres

// Ajouter l'emplacement « sous l'en-tête » d'un thème classique maison.
add_filter( 'websource_brands_position_hooks', function ( $actions, $position ) {
    if ( 'under_header' === $position ) {
        $actions[] = 'mon_theme_after_header';
    }
    return $actions;
}, 10, 2 );

Actions

Le cache est invalidé à la création, modification ou suppression d'un terme product_brand, au changement de son logo, à l'affectation d'une marque à un produit, au changement de statut d'un produit, à la modification des permaliens et à l'enregistrement des réglages.

Gabarit surchargeable

Copiez templates/brands.php vers votre-theme/websource-brands/brands.php. Le gabarit reçoit $view : uid, layout, classes, style, title, show_title, show_name, show_count, autoplay, brands, groups, letters, schema.

Routes REST

Espace de noms : websource-brands/v1.

GET /wp-json/websource-brands/v1/brands

Publique. Renvoie les marques telles que les réglages les sélectionnent.

curl "https://exemple.fr/wp-json/websource-brands/v1/brands?limit=2&sort=products"

{
  "count": 2,
  "brands": [
    {
      "id": 16,
      "name": "Atelier Lagon",
      "slug": "atelier-lagon",
      "url": "https://exemple.fr/marque/atelier-lagon/",
      "products": 4,
      "logo": { "src": "https://exemple.fr/wp-content/uploads/2026/10/atelier-lagon-300x180.png", "width": 300, "height": 180 }
    },
    {
      "id": 18,
      "name": "Maison Verte",
      "slug": "maison-verte",
      "url": "https://exemple.fr/marque/maison-verte/",
      "products": 4,
      "logo": null
    }
  ]
}

Une valeur de sort inconnue renvoie une erreur 400.

POST /wp-json/websource-brands/v1/preview

Réservée aux utilisateurs ayant la capacité manage_woocommerce (nonce REST X-WP-Nonce). Sert à l'aperçu de l'écran de réglages : rend des réglages non enregistrés.

curl -X POST "https://exemple.fr/wp-json/websource-brands/v1/preview" \
  -H "X-WP-Nonce: <nonce>" --cookie "<cookies de session>" \
  -d "wsbr[layout]=carousel" -d "wsbr[limit]=6" -d "wsbr[show_title]=1"

{ "html": "<section class=\"wsbr wsbr--carousel wsbr--themed\" …>…</section>" }

html est vide quand aucune marque ne correspond. Sans droits : erreur 401 (visiteur) ou 403.

Données structurées

• Section (bloc, code court, emplacement) : un ItemList de Brand par page, sauf sur les pages de marque.
• Page d'une marque : nœud Brand dans le <head> (@id = <url de la marque>#brand, name, url, logo, description).
• Fiche produit : le nœud brand des données structurées de WooCommerce reçoit le même @id et l'url de la marque.
• Le réglage « Aider Google à comprendre la liste de vos marques » désactive les trois.

Variables CSS

Feuille assets/css/front.css (handle wsx-brands), script assets/js/front.js (handle wsx-brands, chargé seulement pour le carrousel et la liste, sans jQuery). window.WSBR.init(element) initialise les sections ajoutées après coup.

Variables du thème lues, dans l'ordre --wst-*, puis --color-* / --radius-*, puis valeur de repli :

Variables propres à la section, surchargeables sur .wsbr : --wsbr-bg, --wsbr-title, --wsbr-ink, --wsbr-line, --wsbr-radius, --wsbr-tile-radius, --wsbr-shadow, --wsbr-accent, --wsbr-tint, --wsbr-cols.

Classes : .wsbr, .wsbr--grid|carousel|list, .wsbr--gray, .wsbr--themed|custom, .wsbr--box|wide, .wsbr--placed (emplacement hors contenu), .wsbr--placed-in (emplacement dans le contenu).

Export / import des réglages

Fichier JSON produit par l'écran de réglages :

{
  "plugin": "websource-brands",
  "plugin_version": "1.3.0",
  "sections": {
    "brands": {
      "version": 1,
      "data": { "layout": "list", "selection": "only", "brand_ids": ["brand:atelier-lagon"], "manual_order": [], "placements": [] }
    }
  }
}

Les marques sont désignées par brand:<slug>. À l'import, les références introuvables sont ignorées et comptées. En PHP : \Websource\Brands\ThemePackage\ThemePackage::export( array $settings ) et ::import( array $section ).

Traductions

Chaînes sources en anglais, languages/websource-brands-fr_FR.po|mo et le fichier JSON de l'éditeur de blocs. Le titre saisi dans les réglages est déclaré à Polylang (pll_register_string, groupe « Websource Brands ») et à WPML (wpml-config.xml, chaîne « Section title » du domaine websource-brands).

Désinstallation

uninstall.php supprime wsx_brands_settings, wsx_brands_cache_version et les transients wsx_brands_*. Les termes product_brand et leurs métas ne sont pas touchés.