Dans cet article, vous obtiendrez une explication détaillée de l'API de shortcode de WordPress et apprendrez à créer un shortcode? le droit chemin. Vous verrez ensuite quelques exemples utiles de codes courts plus avancés et comment coder vos propres variations personnalisées! Prêt à ajouter une nouvelle compétence à votre sac à malice? Commençons!
Les codes courts ont été introduits dans WordPress 2.5. Pour faire simple, un shortcode est un raccourci. Ce sont des morceaux de code spécifiques à WordPress qui vous permettent de gagner du temps et de faire des choses qui autrement nécessiteraient des connaissances techniques et éventuellement de grandes quantités de code. En ajoutant des shortcodes à vos thèmes ou plug-ins, vous pourrez en faire une utilisation beaucoup plus simple et intuitive. Vous pourriez, par exemple, avoir un shortcode [most_popular_post]
que lorsque tapé exactement comme ça afficherait le message le plus populaire sur votre site WordPress. Si vous voulez le faire manuellement, vous devez écrire du code HTML et le modifier manuellement au fur et à mesure que la popularité des publications change. Un shortcode élimine le besoin et simplifie les choses pour vous.
Un shortcode est un code spécifique à WordPress qui vous permet de faire des choses astucieuses avec très peu d'effort. Les codes courts peuvent incorporer des fichiers ou créer des objets qui nécessiteraient normalement beaucoup de code compliqué et laid sur une seule ligne.
Shortcode = raccourci.
-WordPress.com
Les codes courts sont créés à l’aide de l’API shortcode de WordPress. ils fonctionnent beaucoup comme les filtres WordPress. Vous devez définir un gestionnaire fonction qui analyse le shortcode et renvoie une sortie. Vous enregistrez ensuite le shortcode à l'aide du bouton ajouter un raccourci()
une fonction. Une fonction de gestionnaire de raccourcis accepte jusqu'à trois arguments, répertoriés ci-dessous:
$ atts
: Un tableau de tous les attributs de shortcode$ contenu
: Tout contenu que le shortcode peut contenir$ code
: Le nom du shortcode (utilisé habituellement lorsque le même gestionnaire est utilisé pour plusieurs shortcodeJe réalise que cela peut sembler un peu déroutant pour vous. Voici donc quelques exemples de ce que ces arguments pourraient être, en utilisant un shortcode hypothétique. Wptuts
.
[wptuts]
$ atts
= tableau () $ contenu
= null [wptuts] Lorem ipsum dolor sit amet [/ wptuts]
$ atts
= tableau () $ contenu
= Lorem ipsum dolor sit amet [wptuts name = "un nom"]
$ atts
= array ('id' => '555', 'name' => 'quelque nom') $ contenu
= null [wptuts] Lorem ipsum dolor sit amet [/ wptuts]
$ atts
= array ('id' => '555') $ contenu
= Lorem ipsum dolor sit ametCela devrait vous donner une bonne idée de la façon dont les arguments sont passés au gestionnaire de shortcode..
Remarque: Les codes courts sont auto-protégés. Donc,
[wptuts]
est le même que[wptuts /]
. Vous devez uniquement utiliser les balises shortcode d’ouverture et de fermeture lorsque le contenu est entre.
Maintenant que vous avez appris les bases de l’API de shortcode, vous pouvez commencer et créer votre premier shortcode. J'utiliserai le thème TwentyEleven inclus dans WordPress, et les captures d'écran le refléteront, mais vous pouvez utiliser n'importe quel thème de votre choix ou même écrire un plugin..
Pour commencer, ouvrez le functions.php
fichier du thème, et ajoutez cette ligne de code en haut:
include 'shortcodes.php';
Votre functions.php
devrait ressembler à ceci:
Ensuite, créez le fichier que vous venez de référencer - shortcodes.php
. Pour faciliter les choses, tous nos codes courts seront dans ce fichier. Pour commencer, nous allons créer un shortcode très simple qui génère un lien pour tweeter l'URL du message. Créer une fonction wptuts_first_shortcode ()
et remplissez-le avec ce code:
fonction wptuts_first_shortcode ($ atts, $ content = null) $ post_url = get_permalink ($ post-> ID); $ post_title = get_the_title ($ post-> ID); $ tweet = 'Partager sur Twitter'; renvoyer $ tweet; add_shortcode ('twitter', 'wptuts_first_shortcode');
Votre premier shortcode est maintenant prêt à partir! Vous pouvez l'essayer en tapant [gazouillement]
dans un post. Voici un exemple de votre sortie:
Maintenant que vous avez créé un shortcode de base, nous pouvons continuer et créer d’autres shortcodes utilisant les différents arguments tels que $ atts
et $ contenu
.
Un shortcode intégré à YouTube est très utile car l'intégration d'une vidéo nécessite des connaissances en matière de codage; avec un shortcode, l’effort requis est considérablement réduit. De plus, cette technique peut être appliquée pour créer des codes courts pouvant intégrer d'autres vidéos ou même des supports tels que des images ou des fichiers audio. Collez ce code dans shortcodes.php
:
fonction wptuts_youtube ($ atts, $ content = null) extraire (shortcode_atts (array ('id' => "), $ atts));; $ return = $ content; if ($ contenu) $ return. ="
"; $ return. = ''; return $ return; add_shortcode ('youtube', 'wptuts_youtube');
Remarquez ce que nous faisons ici. Le shortcode a un seul attribut: l'ID de la vidéo (qui peut être tiré de l'URL d'une vidéo youtube). La fonction shortcode_atts () (
fonctionne beaucoup comme wp_parse_args ()
. Il analyse les attributs et utilise le tableau spécifié comme valeur par défaut. La valeur renvoyée est un tableau avec toutes les clés du premier tableau, remplacées par les valeurs correspondantes dans le champ. $ atts
tableau, si présent. Si le contenu entre les balises shortcode n'est pas vide, nous le affichons, ajoutons quelques sauts de ligne et intégrons la vidéo. Essayez le! Le code que j'ai utilisé était:
[youtube] Regardez cette vidéo! [/ youtube]
Voici le résultat:
я
Un autre exemple de très bon shortcode est celui qui affiche le dernier article de blog. L'avantage est que, chaque fois qu'un nouveau message est publié, aucune mise à jour manuelle n'est requise. Voici le code:
fonction wptuts_recentpost ($ atts, $ content = null) $ getpost = get_posts (array ('nombre' => 1)); $ getpost = $ getpost [0]; $ return = $ getpost-> post_title. "
". $ getpost-> post_excerpt."? "; $ return. ="
ID). "">Lire la suite ?"; return $ return; add_shortcode ('latestpost', 'wptuts_recentpost');
Ce que nous faisons est d'utiliser le get_posts ()
fonction pour récupérer le post le plus récent et afficher le titre, l'extrait et un lien vers le post. Le shortcode n'a pas d'attribut, mais vous pouvez, par exemple, ajouter des attributs pour afficher les publications d'une catégorie particulière ou afficher un nombre défini par l'utilisateur de publications les plus récentes. Vous pouvez essayer le shortcode avec ce code:
Découvrez notre dernier post:
[article le plus récent]
Voici à quoi ça ressemble:
Il y a encore quelques petites choses qui pourraient vous être utiles si vous vous lancez dans le développement de shortcode plus avancé.
remove_shortcode ()
une fonction. L'utilisation est remove_shortcode ($ nomhôte)
. Vous pouvez également supprimer tout shortcodes en utilisant la fonction remove_all_shortcodes ()
do_shortcode ($ content)
une fonction. Le premier cas concerne les codes courts imbriqués - utilisez simplement do_shortcode
sur le $ contenu
passé à vous c'est-à-dire au lieu de retourne $ contenu;
, utilisation retourne do_shortcode ($ content)
. Cela garantira que les codes courts imbriqués sont traités.add_filter ('widget_text', 'do_shortcode');
(source: Shortcodes In Widgets)
J'espère que vous avez déjà beaucoup appris sur les codes courts de WordPress. Vous pourrez maintenant créer une variété de codes courts qui simplifient et rationalisent WordPress, et vos utilisateurs, que ce soit vous-même ou vos clients, vous en remercieront.!
Consultez notre dernier "Resource Roundup" sur les meilleurs et les plus créatifs codes courts actuellement disponibles!