get_user_meta - PHP

介绍

get_user_meta() 是 WordPress 中的一个 PHP 函数，用于获取用户的元数据。在 WordPress 中，用户数据不仅包括基本信息如用户名、密码、邮件等，还包括用户的自定义数据，如联系方式、简介等等。这些自定义信息保存在用户元数据中。get_user_meta() 是获取这些元数据的函数。

语法

get_user_meta( int $user_id, string $meta_key = '', bool $single = false )

参数

$user_id

• 必选参数，要获取元数据的用户 ID。

$meta_key

• 可选参数，要获取的元数据键名。如果省略该参数，则返回该用户所有元数据。

$single

• 可选参数，指定是否返回单个元素。如果设置为 true，则返回一个字符串值(元数据只有一个)，否则将返回包含所有元素的数组。

返回值

如果 $meta_key 存在，则返回该键名对应的元数据值，如果不存在，则返回空字符串 or 空数组（如果 $single 为 false）。如果 $meta_key 为空，则返回该用户的所有元数据。

用法示例

获取单个元素

$phone = get_user_meta( $user_id, 'phone', true );

此代码将从存储在 $user_id 中的用户元数据中获取 phone 键对应的元素并将其存储在 $phone 中。

获取所有元素

$all_meta = get_user_meta( $user_id );

此代码将从存储在 $user_id 中的用户元数据中获取所有元素并将其存储在 $all_meta 数组中。

总结

get_user_meta() 是 WordPress 中的一个重要函数。在开发 WordPress 主题或插件时，通常需要访问用户元数据。通过使用 get_user_meta() 函数，可以轻松地获取并操纵这些元数据。