Octany. for/devs
§ 01 — Insamling · WordPress

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 #

Octany för WordPress
v0.1.0 · zip · 14 kB
Ladda ner pluginet
Version0.1.0
Kräver WordPress6.5 eller senare (testad upp till 7.1)
Kräver PHP7.4 eller senare
SpråkEngelska, svenska
LicensGPLv2 eller senare
SHA-2564741f6a830acf3287bb5c94f68a06b342b2f37858954f9e1d9ea0f26339502fe

§ 01.7.2 Installera och uppdatera #

  1. Gå till Tillägg → Lägg till nytt tillägg → Ladda upp tillägg i WordPress-admin.
  2. Välj zip-filen du laddade ner och klicka på Installera nu.
  3. 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 #

  1. Öppna widgeten i Octany-admin och kopiera dess inbäddningskod.
  2. Lägg till blocket Octany-widget i blockredigeraren (under Inbäddningar, eller sök på "octany", "donera" eller "swish").
  3. 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"]
AttributObligatorisktBeskrivning
typeJaWidgettypen, se Widgettyper.
accountJaDitt konto-ID i Octany. Bara siffror.
widgetJaWidgetens ID, 26 tecken. För formulär är det formulärets ID.
urlNejOctany-appen som widgeten pratar med. Standard är https://app.octany.com.
langNejSpråkkod med två bokstäver, t.ex. sv eller en. Tomt ger widgetens eget språk.
reference_idNejSkickas till loadern som referenceId och sparas på ordrar från widgeten. Se Attribution.
reference_nameNejSkickas 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 #

typeWidgetLoader-sökvägContainer-klass
donate-v1Gåvoflödedonate-v1.octany-donate
swish-v11-klick Swishswish-v1.octany-swish-widget
target-v1Insamlingsmåltarget-v1.octany-target-widget
feed-v1Aktivitetsflödefeed-v1.octany-feed-widget
pulse-v1Pulsepulse-v1.octany-pulse-widget
greeting-v1Hälsninggreeting-v1.octany-greeting-widget
portal-v1Givarportalportal-v1.octany-portal-widget
form-v1Formulärregistration-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:

Ett ogiltigt lang tas bort i stället för att stoppa hela embeden. Referensvärden saneras som ren text.

Loaderns ursprung Loaders hämtas från 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 #

FilterStandardAnvä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_originhttps://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;
});