Utilisez efficacement les métadonnées des publications WordPress-tutoriel php-php.cn

Dans le premier article de cette série, j'ai donné un aperçu de tous les différents types de métadonnées fournies par WordPress, de l'endroit où les métadonnées sont enregistrées et de ce que nous aborderons dans cette série.

De plus, je définis ce que sont les métadonnées ; leur rôle dans WordPress et comment elles nous concernent en tant que développeurs. Mais c'est le but de l'introduction : un aperçu de ce que nous aborderons dans le reste de cette série.

À partir de cet article, nous commencerons à explorer l'API WordPress Post Meta, à comprendre pourquoi elle est utile, ce que nous pouvons en faire et comment profiter des méthodes disponibles via l'application WordPress.

Avertissement pour tout le monde

Tout d’abord, si vous êtes un développeur avancé, il est peu probable que cette série de tutoriels vous soit d’une grande aide. Au lieu de cela, il convient mieux à ceux qui ont travaillé sur le thème, ont peut-être modifié le code du plugin et sont prêts à aller plus loin en ajoutant des informations supplémentaires aux publications (ou types de publications) qui composent leur projet.

Deuxièmement, veuillez noter que les exemples de code de ce tutoriel ne sont pas destinés aux environnements de production. Au lieu de cela, le code que nous examinons n’est pas destiné à être utilisé partout où le site est accessible publiquement à tous.

Maintenant, je prévois d'aborder des techniques plus avancées sur ce sujet après avoir terminé cette série. Mais pour l’instant, nous nous préoccupons uniquement de l’utilisation de l’API.

Pourquoi ? Quel est le délai de signalement des extensions ? En termes simples, cela concerne la sécurité du site Web. Plus précisément, chaque fois que nous écrivons des informations dans une base de données, nous devons supposer que les données sont stockées dans un format non sécurisé et nous devons les nettoyer.

Nous devons explorer un ensemble complètement différent d'API pour nettoyer les données qui seront utilisées conjointement avec l'API de métadonnées, mais ce n'est pas un tutoriel pour le faire.

Je sais, parler de ces API et ne pas pouvoir en profiter peut paraître un peu frustrant. Mais n'oubliez pas qu'il ne s'agit que d'une introduction à l'API. Ces didacticiels devraient vous donner suffisamment d'informations pour commencer à utiliser les métadonnées de publication sur votre ordinateur, mais devraient également vous laisser suffisamment de questions pour que nous puissions explorer le sujet plus en profondeur dans une future série d'articles.

Cela étant dit, allons-y et commençons à utiliser l’API WordPress Post Meta. Attention : il s'agit d'un long tutoriel.

Présentation de l'API

Avant d'examiner le code, assurez-vous toujours de disposer des outils nécessaires pour parcourir la base de données exécutant votre installation WordPress. Certains des outils disponibles incluent :

phpMonAdmin
Suite Pro
MySQL Workbench
Administrateur

Mais n'hésitez pas à utiliser ce que vous préférez. Tant que vous pouvez afficher les données dans la base de données, vous êtes prêt à partir.

Ensuite, comprenons comment WordPress définit les métadonnées de publication. Selon le Code :

WordPress a la possibilité de permettre aux auteurs de publications d'attribuer des champs personnalisés aux publications. Ces informations supplémentaires arbitraires sont appelées métadonnées.

Les métadonnées sont gérées via des paires clé/valeur. La clé est le nom de l'élément de métadonnées. Cette valeur correspond aux informations qui apparaîtront dans la liste des métadonnées pour chaque publication associée à ces informations.

En termes simples, WordPress nous permet d'écrire des informations personnalisées dans la base de données, de les associer à n'importe quelle publication de notre choix, puis de les récupérer si nécessaire. De plus, les informations sont stockées à l’aide de paires clé/valeur uniques.

Écrivez nos propres métadonnées

Si c'est nouveau pour vous, ne vous inquiétez pas. L’idée est que pour chaque valeur que vous stockez, elle est associée à une clé unique (tout comme une poignée de porte a une clé unique qui sert à la déverrouiller).

La clé est de savoir comment nous récupérons la valeur de la publication. Mais cela soulève une question : que se passe-t-il si un article est associé à plusieurs métadonnées ? Autrement dit, si une publication donnée peut stocker plusieurs métadonnées simultanément, comment pouvons-nous récupérer des métadonnées uniques ?

Lorsque nous commencerons à examiner certains exemples de code ci-dessous, nous verrons qu'en plus d'utiliser la clé utilisée lors du stockage des données, nous devons également transmettre l'ID unique de la publication à la fonction.

Mais rien ne vaut de le voir en action. Donc, en supposant que WordPress soit configuré sur votre ordinateur local et que vous puissiez éditer au cœur du thème par défaut functions.php, commençons.

Pour référence

J'utiliserai les outils suivants :

WordPress 4.4
Vingt-six sujets
Atomes
Suite Pro

Le plus important est que vous utilisiez WordPress et le thème mentionné ci-dessus.

Enfin, si vous préférez d’autres IDE et frontaux de bases de données, c’est tout à fait correct.

Nous avons couvert de nombreuses informations dans l'introduction de cet article, mais ces informations nous seront utiles lorsque nous commencerons à examiner non seulement l'API Post Meta, mais également d'autres API. Alors gardez cette mentalité. Je ferai également référence à cet article dans un prochain article.

Plongeons dans l'API.

Instructions très importantes

La façon dont nous avons fusionné le code n'est pas une manière professionnelle de changer le thème, d'implémenter cette fonctionnalité ou d'interagir avec l'API. Nous faisons cela comme une première étape dans le développement WordPress pour les débutants.

Dans les séries suivantes, nous extrairons le travail effectué dans cette série dans un plug-in plus maintenable qui accorde également plus d'attention à la maintenabilité, à la sécurité, etc.

Actuellement, nous nous concentrons sur les bases des API.

Préparez le thème

N'oubliez pas que j'utilise une installation de base de WordPress avec Twenty Six Themes pour les démos que nous allons voir tout au long de ce tutoriel et du reste des tutoriels de la série.

Deuxièmement, nous apporterons les modifications dans functions.php. Ce n'est généralement pas le meilleur endroit pour effectuer cette modification. Cependant, assurez-vous de lire la note ci-dessus avant de continuer.

Cela étant dit, nous supposons que votre serveur est en cours d'exécution, que votre IDE est opérationnel et prêt et que l'éditeur existe déjà functions.php. Même si votre capture d'écran peut être un peu différente, elle devrait ressembler à :

高效地使用 WordPress 帖子元数据

Le défi lié à l'utilisation de functions.php est qu'il contient déjà beaucoup de code qui permet d'améliorer les fonctionnalités d'un thème existant. Bien que nous finirons par déplacer le code dans un plugin dans une prochaine série, nous souhaitons au moins faire la première étape de la création d'un fichier afin de pouvoir inclure notre code de manière indépendante.

Utilisez l'IDE de votre choix :

Créez un nouveau fichier dans le répertoire racine de vingt-six thèmes.
Nommez le fichier tutsplus-metadata.php.

Une fois terminé, vous devriez avoir ce qui suit sur votre système de fichiers :

高效地使用 WordPress 帖子元数据

Enfin, nous devons nous assurer de l'inclure dans functions.php. Pour ce faire, ajoutez les lignes de code suivantes sous la balise de démarrage PHP.

<?php

include_once( 'tutsplus-metadata.php' );

Copier après la connexion

Rechargez votre navigateur. Si tout se passe bien, vous devriez voir exactement le même thème qu'avant d'ajouter les fichiers à functions.php.

Maintenant, mettons-nous au travail.

Commencer

Rappelez-vous notre discussion précédente, nous avons besoin de trois choses pour ajouter des métadonnées à la base de données :

Identifiant de publication
La clé unique que nous pouvons utiliser pour identifier les métadonnées
La valeur que nous voulons stocker et récupérer plus tard

Dans ce tutoriel, tout ce que nous avons à faire est d'ajouter des métadonnées qui afficheront le message Hello World par défaut fourni en standard avec chaque installation WordPress. dans le post.

Supposons que nous souhaitions ajouter des métadonnées contenant notre nom. La clé méta que nous allons utiliser est donc my_name et la valeur que nous allons utiliser est votre nom. Dans mon cas, c'est "Tom McFarlin".

La première chose que nous devons faire est de définir une fonction qui s'accroche à the_content. Cela nous permettra d'afficher du texte pendant que la fonction est en cours d'exécution. Si vous êtes nouveau dans les hooks, lisez cette série.

Votre code initial devrait ressembler à ceci :

<?php

add_filter( 'the_content', 'tutsplus_metadata' );
function tutsplus_metadata( $content ) {

  if ( 1 === get_the_ID() ) {
    echo "[We are here.]"
  }

  return $content;

}

Copier après la connexion

Lorsque vous exécutez ce code, la chaîne "[Nous sommes ici.]" doit apparaître au-dessus du contenu de la publication et avant tout autre contenu, et elle ne doit apparaître que sur Bonjour tout le monde ! poste. En effet, nous vérifions avant la chaîne echo pour nous assurer que l'ID est 1.

Veuillez noter que la version finale du code partagée à la fin de cet article contiendra des commentaires. En attendant, je vais vous expliquer ce que fait le code au fur et à mesure que nous y ajoutons chaque nouvelle section.

Ajouter des métadonnées

Ajoutons maintenant quelques métadonnées réelles. Pour ce faire, ajoutez ce code au corps de la condition afin que nous sachions avec certitude que nous faisons cela pour Hello World. Puisque nous avons déjà vérifié l'ID 1 dans la condition, nous pouvons supprimer le code que nous avons ajouté dans la section précédente et le mettre à jour.

Dans le corps de l'instruction conditionnelle, nous appellerons la fonction add_post_metaAPI comme suit :

<?php add_filter( 'the_content', 'tutsplus_metadata' ); function tutsplus_metadata( $content ) { if ( 1 === get_the_ID() ) { add_post_meta( get_the_ID(), 'my_name', 'Tom McFarlin' ); } return $content; }
Copier après la connexion

Ce serait formidable si nous pouvions faire quelque chose avec ces informations. Mais avant que cela se produise, nous devons en savoir plus. Cela dit, il existe certaines nuances concernant la mise à jour des métadonnées (et en quoi elles diffèrent de l'ajout de métadonnées) et d'autres auxquelles vous n'avez peut-être pas pensé lorsqu'il s'agit d'API.

Mettre à jour les métadonnées

Il existe une différence subtile entre l'ajout de métadonnées et la mise à jour des métadonnées. Savez-vous comment une clé identifie de manière unique la valeur qui lui est associée ? Eh bien, c'est partiellement exact.

Lorsque vous appelez add_post_meta, vous créez une entrée à chaque fois que vous effectuez cet appel. Donc dans notre code ci-dessus, si vous actualisez la page trois fois, vous verrez quelque chose comme ceci :

Curieux, non ? Rappelez-vous le contenu du code :

请注意，如果指定帖子的自定义字段中已存在给定键，则会添加具有相同键的另一个自定义字段，除非 $unique 参数设置为 true，在这种情况下，不会进行任何更改。

啊，该函数接受一个可选参数。这是一个名为 $unique 的布尔值，如果我们只想确保添加的值是唯一的，它允许我们传递 true 。

此时您可能想要删除现有记录。如果没有，也没关系，只需为 my_name 键使用不同的值即可。

这意味着我们可以将代码更新为如下所示：

<?php add_filter( 'the_content', 'tutsplus_metadata' ); function tutsplus_metadata( $content ) { if ( 1 === get_the_ID() ) { add_post_meta( get_the_ID(), 'my_name', 'Tom McFarlin', true ); } return $content; }
Copier après la connexion

现在您只创建一个条目。此外，如果您尝试更改代码中该键的值，那么它在数据库中将不会被覆盖。。一旦写入帖子元数据完成，它就会像第一次一样存储。

但事实并非一定如此，这就是 update_post_meta 发挥作用的地方。事实上，update_post_meta 可能比 add_post_meta 更常用，具体取决于您的用例。

在查看代码之前，请先查看 Codex 的内容：

函数 update_post_meta() 更新指定帖子的现有元键（自定义字段）的值。

这可以用来代替 add_post_meta() 函数。该函数要做的第一件事是确保 $meta_key 已经存在于 $post_id 上。如果没有，则调用 add_post_meta($post_id, $meta_key, $meta_value) 并返回其结果。

你明白了吗？它可以“用来代替 add_post_meta”，这很有用，因为这意味着：

如果给定键的帖子元数据已存在，

如果您使用 update_post_meta，

您将覆盖之前的值。

此时，您可能想要删除数据库中的信息，或创建一对新的键和值。这意味着我们可以将代码更新为如下所示：

<?php add_filter( 'the_content', 'tutsplus_metadata' ); function tutsplus_metadata( $content ) { if ( 1 === get_the_ID() ) { update_post_meta( get_the_ID(), 'my_name', 'Tom McFarlin' ); } return $content; }
Copier après la connexion

不过，这也带来了一些固有的危险。

也就是说，如果您覆盖了一个您从未打算覆盖的值，那么该值就会消失，并且无法回收（除非您做了超出本系列范围的更出色的工作）。

不过， update_post_meta 有一个可选的最后一个参数，那就是 $prev_value 参数。也就是说，您可以指定要覆盖哪个值。

例如，您有使用 add_post_meta 创建的具有相同密钥的多条记录，并且您只想更新其中一条记录。要更新该数据，您需要传入与该一条记录对应的值。

有什么区别？

add_post_meta 和 update_post_meta 之间的区别可能被认为很微妙，但这取决于您的用例。

在这里，我将尝试尽可能简单地分解它们，因为尽管考虑到我们上面看到的示例，它可能看起来很复杂，但当您将其全部展开时，它会更简单。

当您想要将记录引入数据库时，add_post_meta 非常有用。如果该值已经存在，则可能会或不会写入新值。如果您为函数的 $unique 参数传递 true ，则只会创建第一条记录，并且不会覆盖该 >除了 update_post_meta。

update_post_meta 可以用来代替 add_post_meta 并且将始终覆盖以前存在的值。如果您正在处理由 add_post_meta 创建的多条记录，那么您可能需要指定要覆盖的先前值。

这就是一切。当然，我们仍然需要处理从数据库中检索记录并将其显示在屏幕上的问题。

检索元数据

在检索帖子元数据时，您需要记住两件事：

元数据可以字符串形式检索。

元数据可以作为数组检索。

有时这取决于您存储原始信息的方式；有时它取决于您想要如何使用它。

在了解检索信息的各种方法之前，让我们首先了解一下执行此操作的基本 API 调用。具体来说，我说的是 get_post_meta。如果您到目前为止一直在关注，那么理解 API 应该相对容易。

该函数接受三个参数：

帖子 ID

元数据键

如果您想要以字符串或数组形式检索值（如果未指定任何内容，则数组是默认值），则为可选布尔值

来自法典：

检索帖子的帖子元字段。如果 $single 为 false，则将是一个数组。如果 $single 为 true，则为元数据字段的值。

看起来很简单。因此，考虑到我们源代码的最后一部分现在所在的位置，我想说我们可以通过调用 get_post_meta( get_the_ID(), 'my_name' ); 来检索信息。
上面的代码将返回一个数组。

多个值

每当您听到“多个值”这个短语时，想象一下您正在使用的编程语言中的数组或某种类型的数据集合会很有帮助。

在我们的示例中，考虑一下我们使用 add_post_meta 多次存储相同密钥的情况。作为回顾，数据库如下所示：

如果我通过密钥检索信息，我会得到什么？由于我没有指定我想要一个字符串，因此我将返回所有记录的数组。这将使我能够迭代它们中的每一个。

另一方面，如果我指定 true 来获取字符串，那么我只会获取使用 add_post_meta 创建的第一行。

为此，如果您希望获取给定键的多个值，那么您的代码将如下所示：

<?php add_filter( 'the_content', 'tutsplus_metadata' ); function tutsplus_metadata( $content ) { if ( 1 === get_the_ID() ) { var_dump( get_post_meta( get_the_ID(), 'my_name' ) ); } return $content; }
Copier après la connexion

请注意，我使用 var_dump 是为了更轻松地在浏览器中查看从 WordPress 返回的信息；然而，我更喜欢使用调试器，我们可能会在以后的文章中讨论这一点。

单一值

现在假设您想要为一篇文章存储单个值。在这种情况下，您仍然需要帖子 ID 和元数据密钥；但是，您还需要提供 true 作为 get_post_meta 的第三个参数。

如上所述，如果您正在处理使用 add_post_meta 创建多行的情况，那么您将取回创建的第一行；但是，如果您将此函数与 update_post_meta 一起使用，那么您将返回存储的数据的字符串值。

由于我们已经介绍了前者但没有介绍后者，所以代码如下：

<?php add_filter( 'the_content', 'tutsplus_metadata' ); function tutsplus_metadata( $content ) { if ( 1 === get_the_ID() ) { var_dump( get_post_meta( get_the_ID(), 'my_name', true ) ); } return $content; }
Copier après la connexion

然后，您将在调用该函数时返回您保存为元值的任何值。与必须使用一组可能包含也可能不包含类似信息的记录和数组相比，这非常简单。

删除元数据

使用帖子元数据的最后一点与删除它有关。这很简单，但我们需要了解一些细微差别，以确保我们有效地做到这一点。

但首先，这是 Codex 的定义：

此函数从指定帖子中删除具有指定键或键和值的所有自定义字段。

简短、甜蜜、切中要点。该函数接受三个参数：

帖子 ID

元键

元值

meta 值是可选的，但如果您一直在使用 add_post_meta 并希望删除多次调用该函数创建的特定条目之一（正如我们已经在本教程的其他地方可以看到）。

虽然调用 delete_post_meta 就像传递帖子 ID、元键和可选元值一样简单，但该函数返回一个布尔值，说明数据是否已删除。

删除我们迄今为止一直在查看的一些帖子元数据的示例代码可能如下所示：

<?php add_filter( 'the_content', 'tutsplus_metadata' ); function tutsplus_metadata( $content ) { if ( 1 === get_the_ID() ) { delete_post_meta( get_the_ID(), 'my_name' ); } return $content; }
Copier après la connexion

但是，您的实施可能会有所不同。如果您正在使用多个元数据，并且想要验证删除是否成功，那么您可以将代码包装在条件中。

最后的代码示例

下面您将找到一个很长的、有记录的代码片段，它应该代表我们在本教程中讨论的大部分内容。请注意，这些函数挂接到 the_content。

这仅用于演示目的，以便您可以在加载特定页面时轻松触发这些函数。

<?php /** * This file shows how to work with the common Post Meta API functions. * * Namely, it demonstrates how to use: * - add_post_meta * - update_post_meta * - get_post_meta * - delete_post_meta * * Each function is hooked to 'the_content' so that line will need to be * commented out depending on which action you really want to test. * * Also note, from the tutorial linked below, that this file is used form * demonstration purposes only and should not be used in a production * environment. * * Tutorial: * http://code.tutsplus.com/tutorials/how-to-work-with-wordpress-post-metadata--cms-25715 * * @version 1.0.0 * @author Tom McFarlin * @package tutsplus_wp_metadata */ add_filter( 'the_content', 'tutsplus_add_post_meta' ); /** * Determines if the current post is the default 'Hello World' post and, if so, * adds my name as the post meta data to the postmeta database table. * * @param string $content The post content. * @return string $content The post content. */ function tutsplus_add_post_meta( $content ) { if ( 1 === get_the_ID() ) { add_post_meta( get_the_ID(), 'my_name', 'Tom McFarlin' ); } return $content; } add_filter( 'the_content', 'tutsplus_update_post_meta' ); /** * Determines if the current post is the default 'Hello World' post and, if so, * updates my name as the post meta data to the postmeta database table. This * is an alternative way of writing post metadata to the postmeta table as * discussed in the linked tutorial. * * @param string $content The post content. * @return string $content The post content. */ function tutsplus_update_post_meta( $content ) { if ( 1 === get_the_ID() ) { update_post_meta( get_the_ID(), 'my_name', 'Tom McFarlin' ); } return $content; } add_filter( 'the_content', 'tutsplus_get_post_meta' ); /** * Determines if the current post is the default 'Hello World' post and, if so, * retrieves the value for the 'my_name' in the format of a string and echoes * it back to the browser. * * @param string $content The post content. * @return string $content The post content. */ function tutsplus_get_post_meta( $content ) { // Note: Don't worry about the esc_textarea call right now. if ( 1 === get_the_ID() ) { echo esc_textarea( get_post_meta( get_the_ID(), 'my_name', true ) ); } return $content; } add_filter( 'the_content', 'tutsplus_delete_post_meta' ); /** * Determines if the current post is the default 'Hello World' post and, if so, * deletes the post metadata identified by the unique key. * * @param string $content The post content. * @return string $content The post content. */ function tutsplus_delete_post_meta( $content ) { if ( 1 === get_the_ID() ) { delete_post_meta( get_the_ID(), 'my_name' ); } return $content; }
Copier après la connexion

通常，您会发现与其他挂钩相关的元数据函数，例如 save_post 和类似操作，但这是更高级工作的主题。也许我们会在今年晚些时候的另一个系列中介绍这一点。

结论

WordPress Codex 中提供了每个 API 函数，因此，如果您想在本系列的下一篇文章之前跳到前面并进行更多阅读，那么请随意这样做。

如前所述，这是对 WordPress Post Meta API 的介绍。通过 Codex、本教程以及提供的源代码中提供的信息，您应该能够开始向与您的每篇帖子相关的数据库写入其他内容。

但请记住，这只是为了演示目的，因为我们有更多信息要介绍。具体来说，我们需要检查数据清理和数据验证。尽管我们首先要讨论其他主题（例如用户元数据、评论元数据等），但我们很快就会讨论更高级的主题。

En fin de compte, nous essayons de jeter les bases pour que les futurs développeurs WordPress puissent développer des solutions pour d'autres, pour leurs institutions et même pour leurs projets.

Cela étant dit, j'ai hâte de continuer cette série. N'oubliez pas que si vous débutez, vous pouvez consulter ma série sur Comment démarrer avec WordPress, qui se concentre sur des thèmes spécifiquement destinés aux débutants WordPress.

En attendant, si vous recherchez d'autres utilitaires pour vous aider à créer votre ensemble d'outils WordPress croissant, ou pour apprendre le code et devenir plus compétent sur WordPress, n'oubliez pas de consulter ce que nous avons disponible à l'achat sur Envato Marketplace. .

N'oubliez pas que vous pouvez voir tous mes cours et tutoriels sur ma page de profil et vous pouvez me suivre sur mon blog et/ou Twitter (@tommcfarlin) où je discute également de diverses pratiques de développement de logiciels. Comment nous les utilisons dans WordPress.

N'hésitez pas à laisser vos questions ou commentaires dans le fil ci-dessous et je ferai de mon mieux pour répondre à chacun.

Ressources

Champs personnalisés

add_post_when

update_post_meta

get_post_when

delete_post_meta

Exemple de métafonction post

Écho

var_dump

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!