1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
<?php
namespace WPGraphQL\Type\User;
use GraphQL\Type\Definition\ResolveInfo;
use GraphQLRelay\Relay;
use WPGraphQL\AppContext;
use WPGraphQL\Type\Comment\Connection\CommentConnectionDefinition;
use WPGraphQL\Type\PostObject\Connection\PostObjectConnectionDefinition;
use WPGraphQL\Type\WPEnumType;
use WPGraphQL\Type\WPObjectType;
use WPGraphQL\Types;
class UserType extends WPObjectType {
private static $type_name;
private static $fields;
public function __construct() {
self::$type_name = 'User';
$config = [
'name' => self::$type_name,
'description' => __( 'A User object', 'wp-graphql' ),
'fields' => self::fields(),
'interfaces' => [ self::node_interface() ],
];
parent::__construct( $config );
}
private static function fields() {
if ( null === self::$fields ) :
self::$fields = function() {
$fields = [
'id' => [
'type' => Types::non_null( Types::id() ),
'description' => __( 'The globally unique identifier for the user', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ( ! empty( $info->parentType ) && ! empty( $user->ID ) ) ? Relay::toGlobalId( 'user', $user->ID ) : null;
},
],
'capabilities' => [
'type' => Types::list_of( Types::string() ),
'description' => __( 'This field is the id of the user. The id of the user matches WP_User->ID field and the value in the ID column for the `users` table in SQL.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
if ( ! empty( $user->allcaps ) ) {
$capabilities = array_keys( array_filter( $user->allcaps, function( $cap ) {
return true === $cap;
} ) );
}
return ! empty( $capabilities ) ? $capabilities : null;
},
],
'capKey' => [
'type' => Types::string(),
'description' => __( 'User metadata option name. Usually it will be `wp_capabilities`.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->cap_key ) ? $user->cap_key : null;
},
],
'roles' => [
'type' => Types::list_of( Types::string() ),
'description' => __( 'A list of roles that the user has. Roles can be used for querying for certain types of users, but should not be used in permissions checks.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->roles ) ? $user->roles : null;
},
],
'email' => [
'type' => Types::string(),
'description' => __( 'Email of the user. This is equivalent to the WP_User->user_email property.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->user_email ) ? $user->user_email : null;
},
],
'firstName' => [
'type' => Types::string(),
'description' => __( 'First name of the user. This is equivalent to the WP_User->user_first_name property.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->first_name ) ? $user->first_name : null;
},
],
'lastName' => [
'type' => Types::string(),
'description' => __( 'Last name of the user. This is equivalent to the WP_User->user_last_name property.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->last_name ) ? $user->last_name : null;
},
],
'extraCapabilities' => [
'type' => Types::list_of( Types::string() ),
'description' => __( 'A complete list of capabilities including capabilities inherited from a role. This is equivalent to the array keys of WP_User->allcaps.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->allcaps ) ? array_keys( $user->allcaps ) : null;
},
],
'description' => [
'type' => Types::string(),
'description' => __( 'Description of the user.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->description ) ? $user->description : null;
},
],
'username' => [
'type' => Types::string(),
'description' => __( 'Username for the user. This field is equivalent to WP_User->user_login.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, $context, ResolveInfo $info ) {
return ! empty( $user->user_login ) ? $user->user_login : null;
},
],
'name' => [
'type' => Types::string(),
'description' => __( 'Display name of the user. This is equivalent to the WP_User->dispaly_name property.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->display_name ) ? $user->display_name : null;
},
],
'registeredDate' => [
'type' => Types::string(),
'description' => __( 'The date the user registered or was created. The field follows a full ISO8601 date string format.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->user_registered ) ? date( 'c', strtotime( $user->user_registered ) ) : null;
},
],
'nickname' => [
'type' => Types::string(),
'description' => __( 'Nickname of the user.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->nickname ) ? $user->nickname : null;
},
],
'url' => [
'type' => Types::string(),
'description' => __( 'A website url that is associated with the user.', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->user_url ) ? $user->user_url : null;
},
],
'slug' => [
'type' => Types::string(),
'description' => __( 'The slug for the user. This field is equivalent to WP_User->user_nicename', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->user_nicename ) ? $user->user_nicename : null;
},
],
'nicename' => [
'type' => Types::string(),
'description' => __( 'The nicename for the user. This field is equivalent to WP_User->user_nicename', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->user_nicename ) ? $user->user_nicename : null;
},
],
'locale' => [
'type' => Types::string(),
'description' => __( 'The preferred language locale set for the user. Value derived from get_user_locale().', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
$user_locale = get_user_locale( $user );
return ! empty( $user_locale ) ? $user_locale : null;
},
],
'userId' => [
'type' => Types::int(),
'description' => __( 'The Id of the user. Equivelant to WP_User->ID', 'wp-graphql' ),
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
return ! empty( $user->ID ) ? $user->ID : null;
},
],
'avatar' => [
'type' => Types::avatar(),
'description' => __( 'Avatar object for user. The avatar object can be retrieved in different sizes by specifying the size argument.', 'wp-graphql' ),
'args' => [
'size' => [
'type' => Types::int(),
'description' => __( 'The size attribute of the avatar field can be used to fetch avatars of different sizes. The value corresponds to the dimension in pixels to fetch. The default is 96 pixels.', 'wp-graphql' ),
'defaultValue' => 96,
],
'forceDefault' => [
'type' => Types::boolean(),
'description' => __( 'Whether to always show the default image, never the Gravatar. Default false' ),
],
'rating' => [
'type' => new WPEnumType([
'name' => 'AvatarRatingEnum',
'description' => __( 'What rating to display avatars up to. Accepts \'G\', \'PG\', \'R\', \'X\', and are judged in that order. Default is the value of the \'avatar_rating\' option', 'wp-graphql' ),
'values' => [
'G' => [
'value' => 'G',
],
'PG' => [
'value' => 'PG',
],
'R' => [
'value' => 'R',
],
'X' => [
'value' => 'X',
],
],
]),
],
],
'resolve' => function( \WP_User $user, $args, AppContext $context, ResolveInfo $info ) {
$avatar_args = [];
if ( is_numeric( $args['size'] ) ) {
$avatar_args['size'] = absint( $args['size'] );
if ( ! $avatar_args['size'] ) {
$avatar_args['size'] = 96;
}
}
if ( ! empty( $args['forceDefault'] ) && true === $args['forceDefault'] ) {
$avatar_args['force_default'] = true;
}
if ( ! empty( $args['rating'] ) ) {
$avatar_args['rating'] = esc_sql( $args['rating'] );
}
$avatar = get_avatar_data( $user->ID, $avatar_args );
return ( ! empty( $avatar ) && true === $avatar['found_avatar'] ) ? $avatar : null;
},
],
'comments' => CommentConnectionDefinition::connection(),
];
$allowed_post_types = \WPGraphQL::$allowed_post_types;
if ( ! empty( $allowed_post_types ) && is_array( $allowed_post_types ) ) {
foreach ( $allowed_post_types as $post_type ) {
$post_type_object = get_post_type_object( $post_type );
$fields[ $post_type_object->graphql_plural_name ] = PostObjectConnectionDefinition::connection( $post_type_object );
}
}
return self::prepare_fields( $fields, self::$type_name );
};
endif;
return self::$fields;
}
}