React WordPress Hooks
Edit page
About
Context
Hooks
Block RendererBlock RevisionsBlocksCategoriesCommentsMediaPage RevisionsPagesPost RevisionsPostsSearchSettingsStatusesTagsTaxonomiesThemesTypesUsersUsersWordPress

Users

useUsers

Available options

Default query (latest 10 users):

const { data, loading, error } = useUsers();

Users meeting the criteria:

const { data, loading, error } = useUsers({
  /* WordPress REST API options */
});

Single user (by id):

const { data, loading, error } = useUsers(/* user id */);

Multiple users (by id):

const { data, loading, error } = useUsers(/* array of user ids */);

useCreateUser

Available options

const { data, loading, error } = useCreateUser({
  /* WordPress REST API options */
});

useRetrieveUser

Available options

Given user:

const { data, loading, error } = useRetrieveUser(
  /* user id */,
  { /* WordPress REST API options */ }
);

Current user:

const { data, loading, error } = useRetrieveUser('me', {
  /* WordPress REST API options */
});

useUpdateUser

Available options

const { data, loading, error } = useUpdateUser(
  /* user id */,
  { /* WordPress REST API options */ }
);

useDeleteUser

Available options

const { data, loading, error } = useDeleteUser(
  /* user id */,
  { /* WordPress REST API options */ }
);