Podczas zgłaszania wtyczki Cart Weight for WooCommerce do oficjalnego repozytorium wtyczek WordPress, dowiedziałem się, że zmieniły się nieco zasady nazewnictwa wtyczek.
Na początek mały słowniczek, bo zanim sam wszystko zrozumiałem to trochę czasu musiałem poświęcić na naukę sformułowań :)
W repozytorium WP wyróżnia się 3 „nazwy” wtyczki:
- name – nazwa wtyczki, z której jest generowany slug, tę nazwę wpisujemy przy zgłaszaniu wtyczki, ale nie jest ona później używana, np. Moja Super Wtyczka,
- slug – czyli URL wtyczki, generowany automatycznie z powyższej nazwy, np. moja-super-wtyczka,
- display name – nazwa wyświetlana na stronie wtyczki na cover photo, np. Wyświetlana Nazwa Wtyczki WP – może być taka sama jak name, ale nie musi; ta nazwa jest pobierana z pliku readme.txt, który musi być dołączony do wtyczki.
Mimo, że nie jest to zbyt ładne, będę się posługiwać angielskimi pojęciami, bo tak będzie łatwiej.
Jeśli chcemy umieścić wtyczkę w repozytorium to nie możemy w name i slugu wtyczki użyć zastrzeżonej nazwy dowolnej marki (np. WordPress, WooCommerce, ale jak zrozumiałem również nie związanej z WP, np. Google). Dodatkowo nie możemy na początku name i slug używać nazwy innej wtyczki. Na przykład, jeśli robimy rozszerzenie do wtyczki Easy Digital Downloads to nie możemy nazwać Easy Digital Downloads Booster. Ale możemy już użyć name Booster for Easy Digital Downloads (o ile oczywiście nie jest to zastrzeżony znak handlowy, ale skoro w WP podają taki przykład to pewnie nie jest ;)).
Powyższe zasady nie obowiązują natomiast do display name, choć tutaj też nie jest już tak różowo. W display name powinniśmy się teraz trzymać zasady, że nawet jeśli używamy nazwy innej wtyczki lub zastrzeżonego znaku handlowego to umieszczamy go na końcu nazwy, np. Booster for WooCommerce lub Booster for Gravity Forms.
Dlatego dodając wtyczkę Cart Weight for WooCommerce musiałem zmodyfikować jej name i display name, które pierwotnie brzmiały WooCommerce Cart Weight. Teraz jest tak:
- name – Woo Cart Weight („Woo” nie jest zastrzeżone),
- slug – woo-cart-weight,
- display name – Cart Weight for WooCommerce.
Takie zmiany zafundowała nam ekipa WP repo. Ciekawe czy zacznie się również szeroko zakrojona akcja zmian w istniejących wtyczkach, bo przez lata nagromadziło się już bardzo wtyczek, które nie są zgodne z nowymi zasadami.
Jeśli masz jakieś pytania lub wątpliwości do nowych zasad, napisz komentarz – postaram się pomóc.
Ignet napisał
Dobry tekst. Nie mam pytań :)
Kuba Mikita napisał
Mi się wydaje, że jest już tak co najmniej od roku
Maciek Swoboda napisał
Jeszcze w maju 2015 można było dodać wtyczkę z nazwą WooCommerce na początku: https://wordpress.org/plugins/woocommerce-smsapipl/
Jan Kamiński napisał
A ja i nie zwracałem na to uwagi :) A wygląda, że tak jest :)