JTwitterStatuses::getOembed
Method to get information allowing the creation of an embedded representation of a Tweet on third party sites.
Note: either the id or url parameters must be specified in a request. It is not necessary to include both.
Signature
public function getOembed([integer
$id = null,
[string
$url = null,
[integer
$maxwidth = null,
[boolean
$hide_media = null,
[boolean
$hide_thread = null,
[boolean
$omit_script = null,
[string
$align = null,
[string
$related = null,
[string
$lang = null]]]]]]]]] )
Parameters
-
$id
- The Tweet/status ID to return embed code for.
-
$url
- The URL of the Tweet/status to be embedded.
-
$maxwidth
- The maximum width in pixels that the embed should be rendered at. This value is constrained to be
-
$hide_media
- Specifies whether the embedded Tweet should automatically expand images which were uploaded via
-
$hide_thread
- Specifies whether the embedded Tweet should automatically show the original message in the case that
-
$omit_script
- Specifies whether the embedded Tweet HTML should include a <script> element pointing to widgets.js. In cases where
-
$align
- Specifies whether the embedded Tweet should be left aligned, right aligned, or centered in the page.
-
$related
- A value for the TWT related parameter, as described in Web Intents. This value will be forwarded to all
-
$lang
- Language code for the rendered embed. This will affect the text and localization of the rendered HTML.
Returns
- array
- The decoded JSON response