Dla programistów

Dla programistów

Wtyczka Kocuj Sitemap zawiera zestaw filtrów, ktore pozwalają na zmianę niektórych jej zachowań. Pozwala to na przystosowanie wtyczki do wymagań programistycznych innej wtyczki lub motywu bez dokonywania zmian w kodzie wtyczki Kocuj Sitemap.

Wtyczka Kocuj Sitemap zawiera następujące filtry:

kocujsitemap_additional_multiple_languages_php_classes

Parametry:

1. tablica (array) - lista dodatkowych klas PHP, które obsługują wielojęzyczne wtyczki i nie są wbudowane we wtyczkę Kocuj Sitemap

Zwracana wartość:

1. tablica (array) - lista klas PHP, które obsługują wielojęzyczne wtyczki i nie są wbudowane we wtyczkę Kocuj Sitemap

Opis:

Ten filtr dodaje klasę PHP obsługującą wielojęzyczne strony internetowe. Aby dodać nową klasę PHP, powinieneś dodać nowy element do tablicy, która zawiera następujące pola:

• filename

  - pełna ścieżka do pliku z nową klasą PHP,

• class

  - nazwa klasy PHP.

Więcej informacji o tej funkcjonalności możesz znaleźć zaglądając do pliku classes/multiple-languages/template-for-developers/some-plugin.class.php, który może być dobrym punktem startowym do zaprogramowania innej klasy PHP. Pamiętaj, że ta klasa PHP powinna implementować interfejs \KocujSitemapPlugin\Interfaces\Language.

kocujsitemap_default_custom

Parametry:

1. tablica (array) - lista uproszczonych nazw własnych typów wpisów

Zwracana wartość:

1. tablica (array) - lista uproszczonych nazw własnych typów wpisów

Opis:

Ten filtr ustawia domyślną listę własnych typów wpisów, które są wyświetlanie w mapie strony jeżeli lista "opcje listy wpisów własnych typów" w panelu administracyjnym jest pusta.

kocujsitemap_default_exclude_author

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów autorów do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów autorów do wykluczenia

Opis:

Ten filtr ustawia domyślną listę autorów do wykluczenia dla krótkiego kodu [KocujSitemap].

kocujsitemap_default_exclude_category

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów kategorii wpisów do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów kategorii wpisów do wykluczenia

Opis:

Ten filtr ustawia domyślną listę kategorii wpisów do wykluczenia dla krótkiego kodu [KocujSitemap].

kocujsitemap_default_exclude_post

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów wpisów, stron i wpisów własnych typów do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów wpisów, stron i wpisów własnych typów do wykluczenia

Opis:

Ten filtr ustawia domyślną listę wpisów do wykluczenia dla krótkiego kodu [KocujSitemap].

kocujsitemap_default_exclude_term

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów tagów i własnych taksonomii do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów tagów i własnych taksonomii do wykluczenia

Opis:

Ten filtr ustawia domyślną listę tagów i własnych taksonomii do wykluczenia dla krótkiego kodu [KocujSitemap].

kocujsitemap_default_home_link_text

Parametry:

1. tekst (string) - tekst z domyślnym tekstem dla odnośnika do głównej strony
2. tekst (string) - kod aktualnego języka

Zwracana wartość:

1. tekst (string) - tekst z domyślnym tekstem dla odnośnika do głównej strony

Opis:

Ten filtr ustawia domyślny tekst, który jest używany dla odnośnika do głównej strony w mapie strony. Używany on jest jeżeli nie określono parametru homelinktext w krótkim kodzie [KocujSitemap] lub gdy nie określono parametru $homeLinkText w funkcji PHP kocujsitemap_show_sitemap.

kocujsitemap_default_main_css_class

Parametry:

1. tekst (string) - tekst z wszystkimi domyślnymi klasami CSS dla kontenera mapy strony (elementu blokowego div lub nav)

Zwracana wartość:

1. tekst (string) - tekst z wszystkimi domyślnymi klasami CSS dla kontenera mapy strony (elementu blokowego div lub nav)

Opis:

Ten filtr ustawia domyślną klasę CSS, która jest używana w blokowym elemencie mapy strony. Filtr ten jest używany, gdy nie podano parametru class w krótkim kodzie [KocujSitemap] lub gdy nie podano parametru $class w funkcji PHP kocujsitemap_show_sitemap.

kocujsitemap_default_menus

Parametry:

1. tablica (array) - lista identyfikatorów menu

Zwracana wartość:

1. tablica (array) - lista identyfikatorów menu

Opis:

Ten filtr ustawia domyślną listę menu, która jest wyświetlana w mapie strony jeżeli lista "opcje listy menu" w panelu administracyjnym jest pusta.

kocujsitemap_element

Parametry:

1. tekst (string) - tekst dla odnośnika do aktualnego elementu (cały znacznik HTML <a>)
2. liczba całkowita (int) - identyfikator elementu lub 0 dla odnośnika do głównej strony
3. tekst (string) - typ elementu; dostępne wartości: "post" dla wpisu, "page" dla strony, "menu" dla elementu menu, "category" dla kategorii wpisów, "author" dla autora, "tag" dla tagu wpisów, "custom" dla wpisu własnego typu, "taxonomy" dla własnej taksonomii i "home" dla odnośnika do głównej strony.
4. tekst (string) - kod aktualnego języka

Zwracana wartość:

1. tekst (string) - tekst dla odnośnika do aktualnego elementu (cały znacznik HTML <a>)

Opis:

Ten filtr ustawia tekst dla odnośnika do aktualnego elementu.

kocujsitemap_element_home_link_text_position

Parametry:

1. liczba całkowita (int) - pozycja tekstu w odnośniku do głównej strony
2. tekst (string) - tekst dla odnośnika do aktualnego elementu (cały znacznik HTML <a>)
3. tekst (string) - kod aktualnego języka

Zwracana wartość:

1. liczba całkowita (int) - pozycja tekstu w odnośniku do głównej strony

Opis:

Ten filtr ustawia pozycję tekstu w odnośniku do głównej strony. Np. jeżeli odnośnik jest w postaci <a href="mainpage.html">Main page</a>, pozycja tekstu odnośnika do głównej strony będzie ustawiona na 14.

kocujsitemap_first_element_css_class

Parametry:

1. tekst (string) - tekst z klasą CSS dla pierwszego elementu mapy strony

Zwracana wartość:

1. tekst (string) - tekst z klasą CSS dla pierwszego elementu mapy strony

Opis:

Ten filtr ustawia klasę CSS, która jest używana w pierwszym elemencie mapy strony.

kocujsitemap_link_text

Parametry:

1. tekst (string) - tekst z tekstem odnośnika
2. liczba całkowita (int) - identyfikator elementu lub 0 dla odnośnika do głównej strony
3. tekst (string) - typ elementu; dostępne wartości: "post" dla wpisu, "page" dla strony, "menu" dla elementu menu, "category" dla kategorii wpisów, "author" dla autora, "tag" dla tagu wpisów, "custom" dla wpisu własnego typu, "taxonomy" dla własnej taksonomii i "home" dla odnośnika do głównej strony.
4. tekst (string) - kod aktualnego języka

Zwracana wartość:

1. tekst (string) - tekst z tekstem odnośnika

Opis:

Ten filtr ustawia tekst odnośnika.

kocujsitemap_widget_default_exclude_author

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów autorów do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów autorów do wykluczenia

Opis:

Ten filtr ustawia domyślną listę autorów do wykluczenia dla widgetu.

kocujsitemap_widget_default_exclude_category

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów kategorii wpisów do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów kategorii wpisów do wykluczenia

Opis:

Ten filtr ustawia domyślną listę kategorii wpisów do wykluczenia dla widgetu.

kocujsitemap_widget_default_exclude_post

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów wpisów, stron i wpisów własnych typów do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów wpisów, stron i wpisów własnych typów do wykluczenia

Opis:

Ten filtr ustawia domyślną listę wpisów do wykluczenia dla widgetu.

kocujsitemap_widget_default_exclude_term

Parametry:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów tagów i własnych taksonomii do wykluczenia

Zwracana wartość:

1. tekst (string) - oddzielona przecinkami lista identyfikatorów tagów i własnych taksonomii do wykluczenia

Opis:

Ten filtr ustawia domyślną listę tagów i własnych taksonomii do wykluczenia dla widgetu.

shortcode_atts_kocujsitemap

Parametry:

1. tablica (array) - wyjściowa tablica z atrybutami krótkiego kodu
2. tablica (array) - akceptowane parametry i ich wartości domyślne
3. tablica (array) - wejściowa tablica z atrybutami krótkiego kodu

Zwracana wartość:

1. tablica (array) - wyjściowa tablica z atrybutami krótkiego kodu

Opis:

Ten filtr zmienia atrybuty dla krókiego kodu [KocujSitemap].