WordPress wprowadził API shortcode sześć lat temu wraz z wydaniem WordPress 2.5. Skróty są teraz używane przez dużą liczbę wtyczek WordPress, aby umożliwić użytkownikom dodawanie treści do swoich postów i stron.
interfejs API shortcode umożliwia tworzenie własnych skrótów poprzez dodawanie funkcji do funkcji motywu.szablon php (znajduje się on na www.yourwebsite.com/wp-content/themes/yourtheme
oprócz tworzenia własnych skrótów, WordPress zawiera również pięć domyślnych skrótów z rdzeniem WordPress:
- audio – umożliwia osadzanie plików audio.
- podpis-umożliwia zawijanie napisów wokół treści. Jest powszechnie używany z obrazami.
- embed-umożliwia osadzanie szerokiej gamy treści, takich jak wideo, audio i Tweety.
- Galeria-umożliwia wstawianie galerii zdjęć.
- video – pozwala na osadzanie plików wideo.
chociaż domyślne skróty WordPress są powszechnie używane, bardzo niewielu użytkowników WordPress korzysta z interfejsu API shortcode i projektuje unikalne skróty dla swojej witryny. W tym samouczku chciałbym pokazać, jak prosto jest ulepszyć swoją stronę za pomocą niestandardowych skrótów.
zanim zaczniesz, upewnij się, że wykonujesz kopię zapasową funkcji.php i wszelkie inne pliki, które edytujesz przed wprowadzeniem zmian w Twojej aktywnej witrynie.
Tworzenie Shortcode – podstawowy przykład
aby dobrze zrozumieć, jak działa API Shortcode WordPress, zacznijmy od podstawowej funkcji shortcode.
pamiętaj, że skróty powinny być tworzone dla treści i funkcjonalności, z których często korzystasz. Cały sens korzystania z shortcodes jest, aby zaoszczędzić komuś czas. Jeśli masz zamiar użyć czegoś tylko raz, nie ma sensu tworzyć dla tego krótkiego kodu.
piszę około tuzina artykułów tygodniowo. Jedną z rzeczy, które często robię, jest zachęcanie tych, którym podobały się moje artykuły, do subskrybowania mojego bloga (lub bloga, dla którego piszę). Obecnie piszę to za każdym razem, jednak mogłem zaoszczędzić sobie dużo czasu, tworząc skrót do tekstu.
aby to zrobić, mógłbym dodać taką funkcję do funkcji mojego motywu.szablon php:
Ci z Was, którzy nie mają doświadczenia w kodowaniu, mogą uznać powyższy kod za nieco zniechęcający, jednak łatwo jest go zrozumieć po rozbiciu kodu linia po linii.
pierwszą rzeczą, którą robimy, jest dodanie komentarza nad naszą funkcją. Pomoże nam to szybko zobaczyć, do czego służy nasza funkcja, gdy przeglądamy kod w późniejszym terminie.
// Function to add subscribe text to posts and pages
następnie definiujemy naszą funkcję. Lubię używać nazw, które są oczywiste, więc nazwałem moją funkcję „subscribe_link_shortcode”.
function subscribe_link_shortcode() {
następnie definiujemy naszą wiadomość. Instrukcja return wyświetli nasz komunikat, gdy zostanie wywołana. Przechowuje również wiadomości (w przeciwieństwie do echo, które będzie je drukować, ale nie przechowywać).
funkcja jest następnie zamykana.
}
następnie definiujemy sam shortcode za pomocą funkcji add_shortcode. Pierwsza określona zmienna definiuje skrót, który ma być użyty, a druga zmienna wywołuje naszą funkcję (tzn. tę, którą zdefiniowaliśmy powyżej).
add_shortcode('subscribe', 'subscribe_link_shortcode');
Po zapisaniu funkcji.szablon php, możemy teraz wywołać naszą wiadomość kiedy tylko chcemy za pomocą shortcode subscribe.
użycie krótkiego kodu subskrypcji w poście lub stronie spowoduje wyświetlenie następującego komunikatu:
Jeśli podobał Ci się ten artykuł, zachęcam do subskrybowania bloga Elegant Themes przez RSS.
użyłem prostego komunikatu w moim przykładzie, jednak można go zmodyfikować, aby wyświetlić wiele innych rzeczy. Na przykład możesz utworzyć krótki kod do wyświetlania reklam adsense lub formularz subskrypcji biuletynu; a następnie wstawić je w dowolnym miejscu w swoich artykułach.
Tworzenie Shortcode z atrybutami
atrybuty może rozszerzyć funkcjonalność shortcodes, umożliwiając przekazywanie danych przez skróty.
w poniższym przykładzie pokażę, w jaki sposób można wykorzystać atrybuty do rozszerzenia funkcji, którą stworzyliśmy wcześniej. Jak widać, większość kodu pozostaje taka sama.
$atts jest nazwą naszej tablicy atrybutów. Następnie używamy funkcji extract do importowania zmiennych z naszej tablicy (za pomocą funkcji shortcode_atts WordPress).
definiowane są wtedy dwa atrybuty: subtypeurl oraz subtypeurl. Reprezentują one rodzaj subskrypcji i adres URL subskrypcji. Te atrybuty są następnie nazywane w naszej wiadomości.
naszym domyślnym typem subskrypcji jest RSS, a naszym domyślnym adresem URL subskrypcji jesthttp://feeds.feedburner.com/ElegantThemes. Informacje te będą wyświetlane, gdy nie zostaną zdefiniowane żadne atrybuty.
dlatego, gdy dodasz następujący post:
otrzymamy następujące wyjście:
pamiętaj, aby subskrybować przyszłe aktualizacje eleganckich motywów przez RSS.
jeśli zdefiniujemy atrybuty, wynik będzie inny. Poniższy kod:
wyświetli:
pamiętaj, aby subskrybować przyszłe aktualizacje eleganckich motywów przez RSS.
pamiętaj, aby subskrybować przyszłe aktualizacje eleganckich motywów przez Twittera.
pamiętaj, aby subskrybować przyszłe aktualizacje eleganckich motywów przez Facebooka.
pamiętaj, aby subskrybować przyszłe aktualizacje eleganckich motywów przez Google.
chociaż był to podstawowy przykład działania atrybutów, łatwo jest zobaczyć, jak programiści wtyczek mogą korzystać z API shortcode, aby skomplikowane funkcje były bardziej przyjazne dla użytkowników.
przegląd
jeśli wykonasz kroki opisane w tym samouczku, powinieneś teraz mieć podstawową wiedzę na temat tego, jak możesz tworzyć własne niestandardowe skróty dla swojej witryny. Shortcode to świetny sposób na uproszczenie skomplikowanych zadań, więc zachęcam do pamiętania o WordPress shortcode API w przyszłości.
nie przejmuj się, jeśli ten tutorial był dla ciebie trochę trudny. Wszystkie eleganckie motywy są pakowane z krótkimi kodami, które ułatwiają publikowanie pięknych treści. Skróty mogą być używane do tworzenia pokazów slajdów, kolumn i tabel. Pozwala nawet chronić zawartość hasłem.
mam nadzieję, że podobał Ci się ten samouczek na temat tworzenia unikalnego shortcode dla Twojej witryny WordPress. Jeśli tak, zachęcam do subskrybowania eleganckich motywów, ponieważ mamy kilka świetnych treści w przygotowaniu 🙂
również, po raz kolejny, przypominam, aby wykonać kopię zapasową plików przed ich edycją.