Octany-widgetar i WordPress.
Octanys plugin lägger till ett block och en shortcode som bäddar in valfri Octany-widget — gåvoflöden, 1-klick Swish, insamlingsmål, aktivitetsflöden, Pulse, hälsningar, givarportaler och formulär — på sidor och i inlägg. Redaktörer behöver inte behörighet att lägga in skript: pluginet skriver själv embed-snutten och laddar den bara från Octanys egna servrar.
§ 01.7.1 Ladda ner #
| Version | 0.1.0 |
| Kräver WordPress | 6.5 eller senare (testad upp till 7.1) |
| Kräver PHP | 7.4 eller senare |
| Språk | Engelska, svenska |
| Licens | GPLv2 eller senare |
| SHA-256 | 4741f6a830acf3287bb5c94f68a06b342b2f37858954f9e1d9ea0f26339502fe |
§ 01.7.2 Installera och uppdatera #
- Gå till Tillägg → Lägg till nytt tillägg → Ladda upp tillägg i WordPress-admin.
- Välj zip-filen du laddade ner och klicka på Installera nu.
- Klicka på Aktivera.
Pluginet finns inte på WordPress.org, så uppdateringar dyker inte upp i adminpanelen. Ladda ner den nya zip-filen här och ladda upp den på samma sätt när du vill uppdatera — WordPress frågar om den ska ersätta den installerade versionen. Block och shortcodes som redan ligger på dina sidor fortsätter att fungera.
§ 01.7.3 Block #
- Öppna widgeten i Octany-admin och kopiera dess inbäddningskod.
- Lägg till blocket Octany-widget i blockredigeraren (under Inbäddningar, eller sök på "octany", "donera" eller "swish").
- Klistra in inbäddningskoden och klicka på Bädda in.
Blocket läser ut widgettyp, konto, widget-ID, språk och referenser ur inbäddningskoden, så du behöver aldrig skriva in dem för hand. Sedan kan allt ändras i blockets inställningspanel: Typ, Konto-ID och Widget-ID under Widget; Octany-URL, Språk, Referens-ID och Referensnamn under Avancerat. Använd Byt ut i blockets verktygsfält för att klistra in en annan inbäddningskod.
I redigeraren visas en platshållare — själva widgeten renderas när sidan besöks. Blocket stöder bred och full justering samt marginaler.
§ 01.7.4 Shortcode #
För den klassiska redigeraren, sidbyggare, widgetområden eller var som helst där shortcodes fungerar:
[octany type="donate-v1" account="1234" widget="01HXXXXXXXXXXXXXXXXXXXXXXX"]
| Attribut | Obligatoriskt | Beskrivning |
|---|---|---|
| type | Ja | Widgettypen, se Widgettyper. |
| account | Ja | Ditt konto-ID i Octany. Bara siffror. |
| widget | Ja | Widgetens ID, 26 tecken. För formulär är det formulärets ID. |
| url | Nej | Octany-appen som widgeten pratar med. Standard är https://app.octany.com. |
| lang | Nej | Språkkod med två bokstäver, t.ex. sv eller en. Tomt ger widgetens eget språk. |
| reference_id | Nej | Skickas till loadern som referenceId och sparas på ordrar från widgeten. Se Attribution. |
| reference_name | Nej | Skickas som referenceName: en läsbar etikett för referensen. |
En shortcode som klistras in i blockredigeraren kan göras om till ett Octany-widget-block via blockets meny Omvandla till — alla attribut följer med.
§ 01.7.5 Widgettyper #
| type | Widget | Loader-sökväg | Container-klass |
|---|---|---|---|
| donate-v1 | Gåvoflöde | donate-v1 | .octany-donate |
| swish-v1 | 1-klick Swish | swish-v1 | .octany-swish-widget |
| target-v1 | Insamlingsmål | target-v1 | .octany-target-widget |
| feed-v1 | Aktivitetsflöde | feed-v1 | .octany-feed-widget |
| pulse-v1 | Pulse | pulse-v1 | .octany-pulse-widget |
| greeting-v1 | Hälsning | greeting-v1 | .octany-greeting-widget |
| portal-v1 | Givarportal | portal-v1 | .octany-portal-widget |
| form-v1 | Formulär | registration-v1 | .octany-registration-widget |
Formulär är det enda undantaget i namngivningen: shortcode-typen är form-v1, loadern heter registration-v1 och api-URL:en får suffixet /forms.
§ 01.7.6 Output och validering #
Blocket och shortcoden renderar samma markup som Octany-admin ger dig — en container och ett modulskript, på plats:
<!-- [octany type="donate-v1" account="1234" widget="01HXXXXXXXXXXXXXXXXXXXXXXX" lang="sv"] --> <div class="octany-donate" data-widget="01HXXXXXXXXXXXXXXXXXXXXXXX"></div> <script type="module" src="https://give.octany.com/donate-v1/loader.js?api=https%3A%2F%2Fapp.octany.com%2Fwidget%2F1234&widget=01HXXXXXXXXXXXXXXXXXXXXXXX&lang=sv" ></script>
Ingenting renderas — inget felmeddelande, ingen tom container — när ett värde saknas eller är ogiltigt:
typemåste vara en av widgettyperna.accountfår bara innehålla siffror.widgetmåste vara 26 bokstäver och siffror.urlmåste, om den anges, varahttps://påoctany.comeller en subdomän, utan sökväg, query eller inloggningsuppgifter.localhostär också tillåtet för utveckling.
Ett ogiltigt lang tas bort i stället för att stoppa hela embeden. Referensvärden saneras som ren text.
give.-hosten bredvid app-URL:en: https://app.octany.com laddar från https://give.octany.com. Givaruppgifter och data-terms-accepted från Insamling finns inte som blockinställningar — behöver du dem renderar du snutten själv i ditt tema.
§ 01.7.7 Filter för utvecklare #
| Filter | Standard | Använd det för att |
|---|---|---|
| octany_domains | ['octany.com', 'localhost'] | Ändra vilka hostar url får peka på. Subdomäner till varje post är tillåtna. |
| octany_loader_origin | https://give.{host} | Hämta loaders från någon annanstans. Får origin och den validerade app-URL:en. |
// Tillåt en staging-miljö av Octany utöver produktion. add_filter('octany_domains', function (array $domains) { $domains[] = 'octany.test'; return $domains; });