Users

Returns information about a user or group of users

Twitter Users

Method: `users()`

Returns information about a group of users

$twitter = new BirdElephant($credentials);

$users = $twitter->users()

Lookup Users

Method: `lookup()`

Looks up multiple twitter users by username

$usernames = ['coderjerk', 'kennyg', 'dril'];

$params = [
    'expansions' => 'pinned_tweet_id',
    'user.fields' =>  'created_at,description,entities,id,location'
];

$users->lookup($usernames, $params);

Argument	Type	Description
$usernames	Array	array of Twitter usernames	required
$params	Array	available query parameters	optional

Me

Method: `me()`

Get the authenticated user

$twitter = new BirdElephant($credentials);

$me = $twitter->me()

Method: `myself()`

Gets information about the authenticated user.

$params = [
    'expansions' => 'pinned_tweet_id',
];

$me->myself($params);

Argument	Type	Description
$params	Array	available query parameters	optional

Twitter User

Method: `user()`

Sets up a Twitter user by user name to be used in conjunction with the methods below to perform actions on behalf of and retrieve data about the named user. The named user must be the authenticated user in instances where user context auth is required.

$twitter = new BirdElephant($credentials);

$user = $twitter->user($user_name);

Argument	Type	Description
$user_name	String	Twitter username	required

Get User

Method: `get()`

Gets information about the named Twitter user.

$user->get();

Argument	Type	Description
$params	Array	available query parameters	optional

Get Followers

Method: `followers()`

Gets a Twitter user's followers

$user->followers();

Argument	Type	Description
$params	Array	available query parameters	optional

Get Following

Method: `following()`

Gets a Twitter user's followed accounts

$params= [
    'max_results' => 20,
    'user.fields' => 'profile_image_url'
];

$user->following($params);

Argument	Type	Description
$params	Array	available query parameters	optional

Follow

Method: `follow()`

Follows a given user

$user->follow('coderjerk');

Argument	Type	Description
$target_username	String	The target twitter username	required

Unfollow

Method: `unfollow()`

Unfollows a given user

$user->unfollow('stefanmross');

Argument	Type	Description
$target_username	String	The target twitter username	required

Timeline

Method: `timeline()`

Gets the authenticated user's timeline in reverse chronological order.

$username = $twitter->me()->myself()->data->username;

$timeline = $twitter->user($username)->timeline();

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

User Tweets

Method: `tweets()`

Gets the tweets of a Twitter user.

$user->tweets();

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

Mentions

Method: `mentions()`

Gets the mentions of a Twitter user.

$user->mentions();

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

User Blocks

Method: `blocks()`

Gets the blocked accounts of a Twitter user.

$user->blocks();

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

Block User

Method: `block()`

Blocks a given user

$user->block('GilbertOSull_');

Argument	Type	Description
$target_username	String	The target twitter username	required

Unblock User

Method: `unblock()`

Unblocks a given user

$user->unblock('claydermanmusic');

Argument	Type	Description
$target_username	String	The target twitter username	required

User Mutes

Method: `mutes()`

Gets the muted accounts of a Twitter user.

$user->mutes();

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

Mute User

Method: `mute()`

Mutes a given user

$user->mute('kennyg');

Argument	Type	Description
$target_username	String	The target twitter username	required

Unmute User

Method: `unmute()`

Unmutes a given user

$user->unmute('kennyg');

Argument	Type	Description
$target_username	String	The target twitter username	required

User Likes

Method: `likes()`

Gets the named user's last 100 likes

$user->likes($params);

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

Like Tweet

Method: `like()`

Likes a tweet on behalf of the authenticated user

$user->like('1456978214837006343');

Argument	Type	Description
$tweet_id	String	the target tweet id	reqired

Unlike Tweet

Method: `unlike()`

Unlikes a tweet on behalf of the authenticated user

$user->unlike($tweet_id);

Argument	Type	Description
$tweet_id	String	the target tweet id	required

Retweet

Method: `retweet()`

Retweets a tweet on behalf of the authenticated user

$user->retweet('1456978214837006343');

Argument	Type	Description
$tweet_id	String	the target tweet id	required

Unretweet

Method: `unretweet()`

Unretweets a tweet on behalf of the authenticated user

$user->unretweet($tweet_id);

Argument	Type	Description
$tweet_id	String	the target tweet id	required

User Spaces

Method: `spaces()`

Gets a user's spaces

$user->spaces();

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

User Lists

Method: `lists()`

Perform actions on lists on behalf of the authenticated user.

$user_lists = $user->lists();

Get Followed Lists

Method: `followed()`

Gets a list of folllowed lists on behalf of the authenticated user

$user_lists->followed($params);

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

Get Pinned Lists

Gets a list of pinned lists on behalf of the authenticated user

$user_lists->pinned($params);

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

Get Owned Lists

Gets lists owned by the authenticated user

$user_lists->owned($params);

Argument	Type	Description
$params	Array	see Twitter docs for avilable query parameters	optional

Follow Lists

Follows a list on behalf of the authenticated user

$user_lists->follow($target_list_id);

Argument	Type	Description
$target_list_id	String	The target list id	required

Unfollow Lists

Unfollows a list on behalf of the authenticated user

$user_lists->unfollow($target_list_id);

Argument	Type	Description
$target_list_id	String	The target list id	required

Pin Lists

Unpins a list on behalf of the authenticated user

$user_lists->pin($target_list_id);

Argument	Type	Description
$target_list_id	String	The target list id	required

Unpin Lists

Pins a list on behalf of the authenticated user

$user_lists->unpin($target_list_id);

Argument	Type	Description
$target_list_id	String	The target list id	required

Reference

Refer to the Twitter documentation for details of paramaters, expansions and fields.

Users

Twitter Users

Method: users()

Lookup Users

Method: lookup()

Me

Method: me()

Method: myself()