rtMedia

https://rtmedia.io/docs/
Admin
rtMedia is a comprehensive WordPress plugin for managing and sharing media content including photos,...
Tokens:124,447
Snippets:1,603
Trust Score:9.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Grunt CLI Globally

Source: https://rtmedia.io/docs/inspirebook/setup-inspirebook-development

Install the Grunt command-line interface globally on your system using npm. This is a one-time setup step.

```bash
[sudo] npm install -g grunt-cli
```

--------------------------------

### Install Compass

Source: https://rtmedia.io/docs/inspirebook/setup-inspirebook-development

Install Compass, a CSS Authoring Framework, using the Ruby gem package manager. Administrator privileges might be needed.

```bash
[sudo] gem install compass
```

--------------------------------

### Example: Sort Photos by View, Like, and Rate

Source: https://rtmedia.io/docs/addons/sorting/features

This example demonstrates how to configure the `rtmedia_gallery` shortcode to display photos, disable media titles, and enable sorting by view, like, and rate. It showcases a practical application of the `sort_parameters` attribute.

```html
[rtmedia_gallery global=true media_type=photo media_title=false sort_parameters="view,like,rate"]
```

--------------------------------

### Install SASS/SCSS

Source: https://rtmedia.io/docs/inspirebook/setup-inspirebook-development

Install SASS using the Ruby gem package manager. This command may require administrator privileges.

```bash
[sudo] gem install sass
```

--------------------------------

### Sample Response for Get rtMedia Comments (User)

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response when fetching comments for a user.

```json
{"status":"TRUE",
"status_code":800004,
"message":"media comments",
"data":{"comments":[
 {"comment_ID":"3",
 "comment_content":"Facebok Stylern",
 "media_id":"23"
},
{"comment_ID":"4",
 "comment_content":"http://example.com/hello-world/trackback/",
  "media_id":"1"
 }
],
"user":{"user_id":"1",
    "name":"admin",
    "avatar":"http://gravatar.com/avatar/b71b87b10ab35253f5cdd5d7e4492d03?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=80&amp;r=G"
    }
 }
}
```

--------------------------------

### Successful Login Response Sample

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response indicating a successful user login, including an access token.

```json
{"status":"TRUE",
    "status_code":200004,
    "message":"login success",
    "data":{
    "access_token":"1c1486ad94f3eb155ce52d3dfe0842292ca4f0a1"
    }
  }
```

--------------------------------

### Sample Response for Get Likes

Source: https://rtmedia.io/docs/developers/json-api

JSON response containing user information and a list of likes for a media item.

```json
  {"status":"TRUE",
    "status_code":900004,
    "message":"media likes",
    "data":{"user":{ "2":{"name":"Test rtmedia", "avatar":"http://gravatar.com/avatar/ead51efe56285de1d46ca8a817a44f10?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=80&amp;r=G" } }, "likes":[ {"activity_time":"4 days", "user_id":"2" } ] }
    }
```

--------------------------------

### Sample Response for Get rtMedia Comments (Media)

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response when fetching comments for a specific media item.

```json
{"status":"TRUE",
 "status_code":800004,
 "message":"media comments",
 "data":{"comments":[ {"comment_ID":"7", "comment_content":"New Comment", "user_id":"2" }, {"comment_ID":"11", "comment_content":"example comment", "user_id":"1" } ], "user":{"2":{"name":"Test rtmedia", "avatar":"http://gravatar.com/avatar/ead51efe56285de1d46ca8a817a44f10?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=80&amp;r=G"},"1":{"name":"admin","avatar":"http://gravatar.com/avatar/b71b87b10ab35253f5cdd5d7e4492d03?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=80&amp;r=G" } } }
  }
```

--------------------------------

### Install Local Grunt Packages

Source: https://rtmedia.io/docs/inspirebook/setup-inspirebook-development

Install the required Grunt packages as development dependencies for your project. Navigate to your project directory before running this command.

```bash
[sudo] npm install --save-dev grunt grunt-autoprefixer grunt-checktextdomain grunt-contrib-compass grunt-contrib-imagemin grunt-contrib-uglify grunt-contrib-watch grunt-fontello grunt-wp-i18n load-grunt-tasks
```

--------------------------------

### Registration Failure Response Sample (Fields Empty)

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response for a failed user registration due to missing fields.

```json
{"status":"FALSE",
    "status_code":300001,
    "message":"fields empty",
    "data":false
}
```

--------------------------------

### Restrict Media Downloads with rtmedia_downloads_before_download_media

Source: https://rtmedia.io/docs/addons/direct-download-link/actions

Use this action to perform checks before a media file starts downloading. The example restricts downloads for users without the 'edit_published_posts' capability.

```php
add_action( 'rtmedia_downloads_before_download_media', 'rtmedia_before_download_media', 10, 1 );

function rtmedia_before_download_media ( $download ) {

    // Restrict media download for subscriber and lower capablities users.

    if ( ! user_can( $download->interactor, 'edit_published_posts' ) ) {
        die('You can\'t download media..');
    }
}
```

--------------------------------

### Successful Logout Response Sample

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response indicating a successful user logout.

```json
{"status":"TRUE",
    "status_code":200005,
    "message":"logged out",
    "data":false
}
```

--------------------------------

### Check ImageMagick Installation (Alternative)

Source: https://rtmedia.io/docs/addons/rtmedia-photo-filters

Use this alternative command to check for ImageMagick and related PHP extensions, which may be necessary depending on your server configuration.

```bash
dpkg -l | egrep '(imagemagick | libmagick9-dev | php5-imagick)'
```

--------------------------------

### Login Failure Response Sample

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response for a failed login attempt, typically due to an incorrect password.

```json
{"status":"FALSE",
    "status_code":200003,
    "message":"incorrect password",
    "data":false
}
```

--------------------------------

### Successful Registration Response Sample

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response indicating a successful user registration through the rtMedia API.

```json
{"status":"TRUE",
    "status_code":300007,
    "message":"new user created",
    "data":false
}
```

--------------------------------

### Check ImageMagick Installation (Debian/Ubuntu)

Source: https://rtmedia.io/docs/addons/rtmedia-photo-filters

Run this command in your server's terminal to check if ImageMagick and related PHP extensions are installed on Debian or Ubuntu-based systems.

```bash
dpkg -l | egrep '(imagemagick|libmagickwand-dev|php5-imagick)'
```

--------------------------------

### Forgot Password Success Response Sample

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response indicating that a password reset link has been successfully sent.

```json
{"status":"TRUE",
    "status_code":500003,
    "message":"reset link sent",
    "data":false
}
```

--------------------------------

### Get BuddyPress Activities Success Response

Source: https://rtmedia.io/docs/developers/json-api

Sample successful response for retrieving BuddyPress activities, including activity count and content.

```json
"status":"TRUE",
"status_code":700001,
"message":"bp activities",
"data":{ "total_activity_count":10, "total":10, "current":1, "0": {"id":"17", "activity_type":"rtmedia_update", "activity_time":"2014-01-13 10:29:25", "activity_time_human":" 23 hours, 6 minutes ago", "activity_content":"<div class="rtmedia-activity-container"> <ul class="rtmedia-list large-block-grid-3"> <li class="rtmedia-list-item media-type-document"> <div class="rtmedia-item-thumbnail"> <a href="http://example.com/members/admin/media/57/"> <img src="http://example.com/wp-content/plugins/rtmedia-pro/app/assets/img/documents-icon.png" height="70" width="70" /></a> </div> <div class="rtmedia-item-title"> <a href="http://example.com/members/admin/media/57/">license.txt</a> </div> <div class="rtmedia-item-actions"></div> </li> </ul> </div>", "user":{"id":"1", "name":"admin", "avatar":"http://gravatar.com/avatar/b71b87b10ab35253f5cdd5d7e4492d03?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=80&amp;r=G" }, "media":[ {"id":"57", "title":"license.txt", "src":"http://example.com/wp-content/plugins/rtmedia-pro/app/assets/img/documents-icon.png", "likes":"0", "current_user":"FALSE" } ] } }
}
```

--------------------------------

### Get BuddyPress Activities Failure Response

Source: https://rtmedia.io/docs/developers/json-api

Sample failure response for retrieving BuddyPress activities, indicating an invalid token.

```json
{"status":"FALSE",
    "status_code":600003,
    "message":"token invalid",
    "data":false
 }
```

--------------------------------

### Set Media Uploader Context to Profile

Source: https://rtmedia.io/docs/features/upload/developers

Use this filter to allow users to select albums while uploading media. This example sets the context to 'profile'.

```php
add_filter( 'rtmedia_media_uploader_attributes', function( $attr ){
    global $rtmedia_query;
    if ( $rtmedia_query->is_upload_shortcode ) {
        $rtmedia_query->query['context'] = 'profile';
    }
    return $attr;
}, 10, 1 );
```

--------------------------------

### Add content before media in gallery widget

Source: https://rtmedia.io/docs/addons/sidebar-widgets/actions

Fires just before an individual media item within the gallery widget starts rendering. This allows for custom styling or wrapping of each media element.

```php
add_action( 'rtmedia_gallery_widget_before_media', 'rtm_gallery_widget_before_media', 10, 1 );

function rtm_gallery_widget_before_media ( $rt_media_gallery ) {
     echo '<div style="border : 2px solid grey;">';
}
```

--------------------------------

### Get BuddyPress Profile Success Response

Source: https://rtmedia.io/docs/developers/json-api

Sample successful response for retrieving BuddyPress profile information, including avatar and custom fields.

```json
{"status":"TRUE",
"status_code":400002,
"message":"profile fields",
"data":{"id":"1", "avatar":{ "src":"http://gravatar.com/avatar/b71b87b10ab35253f5cdd5d7e4492d03?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=250&amp;r=G", "width":250, "height":250 }, "fields":{ "Name":{"value":"adminn", "privacy":"public" } } }
}


```

--------------------------------

### Set Media Uploader Context to Group

Source: https://rtmedia.io/docs/features/upload/developers

Use this filter to allow users to select albums while uploading media. This example sets the context to 'group'.

```php
add_filter( 'rtmedia_media_uploader_attributes', function( $attr ){
    global $rtmedia_query;
    if ( $rtmedia_query->is_upload_shortcode ) {
        $rtmedia_query->query['context'] = 'group';
    }
    return $attr;
}, 10, 1 );
```

--------------------------------

### Change Activity Content Layout

Source: https://rtmedia.io/docs/developers/hooks/rtmedia-activity-content-html

Use this filter to change the order of activity text and media list. This example shows the media list appearing before the activity text.

```php
/**  
 * Show the activity text below the media list.  
 */  
add_filter( 'rtmedia_activity_content_html', 'custom_activity_content_html', 10, 3 );  
  
function custom_activity_content_html( $activity_content, $activity_text, $media_list ) {  
    return $media_list . $activity_text;  
}
```

--------------------------------

### Enable Imagick Extension in php.ini

Source: https://rtmedia.io/docs/addons/rtmedia-photo-filters

Add this line to your server's php.ini file to enable the Imagick extension after installation. This is required for rtMedia Photo Filters to function correctly.

```ini
extension=imagick.so
```

--------------------------------

### Upload All Media to S3 Bucket

Source: https://rtmedia.io/docs/rtamazon-plugin

This command initiates the upload of all media from your site to the configured S3 bucket. It provides feedback on the progress and success of each upload.

```bash
# wp rtamazon media upload
```

```text
Uploading 2 media to 'your-s3-test' bucket ...
Success: 1/5 ID 15 - media-name-1 uploaded in 2.77 seconds
Success: 2/5 ID 14 - media-name-2 uploaded in 3.22 seconds
Success: 3/5 ID 13 - media-name-3 uploaded in 1.45 seconds
Success: 4/5 ID 12 - media-name-4 uploaded in 5.58 seconds
Success: 5/5 ID 11 - media-name-5 uploaded in 2.84 seconds


```

--------------------------------

### Sample Response for Like Media (Like)

Source: https://rtmedia.io/docs/developers/json-api

JSON response indicating a media has been successfully liked.

```json
    {"status":"TRUE",
    "status_code":900002,
    "message":"liked media",
    "data":{"like_count":2}
    }
```

--------------------------------

### Display User's Public Media Across Contexts

Source: https://rtmedia.io/docs/features/gallery

Lists all public media uploaded by a particular user across all contexts, creating a user showcase gallery. Global is true and media_author specifies the user.

```shortcode
[rtmedia_gallery global=true media_author=1]
```

--------------------------------

### Example: Display Media Title in Sidebar Widget

Source: https://rtmedia.io/docs/developers/hooks/media-gallery-widget

This example demonstrates how to use the 'rtmedia_gallery_widget_before_media' hook to display the title of each media item within the sidebar widget. Apply this hook in your theme's function.php file.

```php
add_action("rtmedia_gallery_widget_before_media", "my_widget_rtmedia_title",10,1);

function my_widget_rtmedia_title($rt_media_gallery) {
 echo $rt_media_gallery->media_title;
    }
```

--------------------------------

### Configure Media File URL Serving Method

Source: https://rtmedia.io/docs/rtamazon-plugin

Choose how media file URLs are served. Options include WordPress Media URL, Bucket Name as Subdomain, Bucket Name in Path, or a Custom Domain for CDN integration.

```php
define( 'RTAMAZON_S3_FILE_URLS', 'rtawss3_wp_url' );
```

```php
define( 'RTAMAZON_S3_FILE_URLS', 'rtawss3_subdomain' );
```

```php
define( 'RTAMAZON_S3_FILE_URLS', 'rtawss3_path' );
```

```php
define( 'RTAMAZON_S3_FILE_URLS', 'rtawss3_custom' );
```

--------------------------------

### Get Likes for rtMedia Media

Source: https://rtmedia.io/docs/developers/json-api

Retrieves the list of users who have liked a specific media item.

```http
 action => rtmedia_api
 method => get_likes_rtmedia
 token => 1c1486ad94f3eb155ce52d3dfe0842292ca4f0a1
 media_id => 47
```

--------------------------------

### Display Media from a User's Profile

Source: https://rtmedia.io/docs/features/gallery

Use this to fetch media from a specific user's BuddyPress profile. Global is false and context is set to profile.

```shortcode
[rtmedia_gallery context="profile" context_id="5"]
```

--------------------------------

### Get Media Likes

Source: https://rtmedia.io/docs/developers/json-api

Retrieves the list of users who have liked a specific media item, along with their details.

```APIDOC
## GET get_likes_rtmedia

### Description
Retrieves the list of users who have liked a specific media item.

### Method
GET

### Endpoint
rtmedia_api

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be "rtmedia_api"
- **method** (string) - Required - Must be "get_likes_rtmedia"
- **token** (string) - Required - Authentication token
- **media_id** (integer) - Required - The ID of the media to retrieve likes for.

### Response
#### Success Response (200 OK)
- **status** (string) - Indicates the success of the operation ('TRUE' or 'FALSE').
- **status_code** (integer) - The status code of the response.
- **message** (string) - A message describing the result of the operation.
- **data** (object)
  - **user** (object) - An object containing details of users who liked the media. Keys are user IDs.
    - **[user_id]** (object) - User details.
      - **name** (string) - The name of the user.
      - **avatar** (string) - The URL of the user's avatar.
  - **likes** (array) - An array of like objects.
    - **activity_time** (string) - The time when the like occurred.
    - **user_id** (string) - The ID of the user who liked the media.

### Response Example
```json
{
  "status": "TRUE",
  "status_code": 900004,
  "message": "media likes",
  "data": {
    "user": {
      "2": {
        "name": "Test rtmedia",
        "avatar": "http://gravatar.com/avatar/ead51efe56285de1d46ca8a817a44f10?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=80&amp;r=G"
      }
    },
    "likes": [
      {
        "activity_time": "4 days",
        "user_id": "2"
      }
    ]
  }
}
```
```

--------------------------------

### Get BuddyPress Activities

Source: https://rtmedia.io/docs/developers/json-api

Retrieves recent BuddyPress activities on the site. Can be filtered to show user-specific activities.

```APIDOC
## GET bp_get_activities

### Description
The method returns recent BuddyPress activities on the site. If `activity_user_id` is provided, it returns user specific activity.

### Method
GET

### Endpoint
rtmedia_api

### Parameters
#### Query Parameters
- **method** (string) - Required - `bp_get_activities`
- **token** (string) - Required - API token for authentication
- **page** (integer) - Optional - Page number to obtain feeds from, default 1
- **per_page** (integer) - Optional - Number of activities per page, default 10
- **activity_user_id** (integer) - Optional - ID of the user to retrieve activities for

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation ('TRUE' or 'FALSE')
- **status_code** (integer) - The status code of the response
- **message** (string) - A message describing the response
- **data** (object) - Contains the activity data, including total counts and individual activity details

#### Response Example (Success)
```json
{
  "status": "TRUE",
  "status_code": 700001,
  "message": "bp activities",
  "data": {
    "total_activity_count": 10,
    "total": 10,
    "current": 1,
    "0": {
      "id": "17",
      "activity_type": "rtmedia_update",
      "activity_time": "2014-01-13 10:29:25",
      "activity_time_human": " 23 hours, 6 minutes ago",
      "activity_content": "<div class=\"rtmedia-activity-container\"> <ul class=\"rtmedia-list large-block-grid-3\"> <li class=\"rtmedia-list-item media-type-document\"> <div class=\"rtmedia-item-thumbnail\"> <a href=\"http://example.com/members/admin/media/57/\"> <img src=\"http://example.com/wp-content/plugins/rtmedia-pro/app/assets/img/documents-icon.png\" height=\"70\" width=\"70\" /></a> </div> <div class=\"rtmedia-item-title\"> <a href=\"http://example.com/members/admin/media/57/\">license.txt</a> </div> <div class=\"rtmedia-item-actions\"></div> </li> </ul> </div>",
      "user": {
        "id": "1",
        "name": "admin",
        "avatar": "http://gravatar.com/avatar/b71b87b10ab35253f5cdd5d7e4492d03?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=80&amp;r=G"
      },
      "media": [
        {
          "id": "57",
          "title": "license.txt",
          "src": "http://example.com/wp-content/plugins/rtmedia-pro/app/assets/img/documents-icon.png",
          "likes": "0",
          "current_user": "FALSE"
        }
      ]
    }
  }
}
```

#### Response Example (Failure - Invalid Token)
```json
{
  "status": "FALSE",
  "status_code": 600003,
  "message": "token invalid",
  "data": false
}
```
```

--------------------------------

### rtmedia_before_add_playlist

Source: https://rtmedia.io/docs/addons/playlists/actions

Action fires just before a new playlist is created.

```APIDOC
## rtmedia_before_add_playlist

### Description
Action will fire just before new playlist will create.

### Example Usage
```php
add_action( 'rtmedia_before_add_playlist', 'rtmedia_before_add_playlist' );

function rtmedia_before_add_playlist() {
    error_log(var_export( 'New music album will be create.', true) );
}
```
```

--------------------------------

### Display Media from a Specific Page

Source: https://rtmedia.io/docs/features/gallery

Fetches media only from a specific page. Context is set to 'page' and context_id specifies the page.

```shortcode
[rtmedia_gallery context=page context_id=11]
```

--------------------------------

### Display Media with Pagination

Source: https://rtmedia.io/docs/features/gallery

Use this to load a specified number of media items per page or when 'Load more' is clicked. This overrides admin settings.

```shortcode
[rtmedia_gallery global="true" media_type="photo" per_page="10"]
```

--------------------------------

### PHP: Hook into rtmedia_before_add_playlist

Source: https://rtmedia.io/docs/addons/playlists/actions

Use this action to perform operations just before a new playlist is created. This action does not receive any arguments.

```php
add_action( 'rtmedia_before_add_playlist', 'rtmedia_before_add_playlist' );

function rtmedia_before_add_playlist() {
    error_log(var_export( 'New music album will be create.', true) );
}
```

--------------------------------

### Sample Response for Like Media (Unlike)

Source: https://rtmedia.io/docs/developers/json-api

JSON response indicating a media has been successfully unliked.

```json
  {"status":"TRUE",
    "status_code":900001,
    "message":"unliked media",
    "data":{"like_count":1}
    }
```

--------------------------------

### Bind JW Player to Media Elements

Source: https://rtmedia.io/docs/developers/replace-default-mediaplayer

Sets up JW Player for both video and audio elements. It dynamically retrieves media paths and configures the player dimensions. This code should be executed after the default player is removed and the custom player library is enqueued.

```javascript
var media_element = jQuery( '#rtmedia-single-media-container .rtmedia-media' );
var media_element_id = jQuery( media_element ).attr( 'id' );
//Path for video
var media_path_video = jQuery( '#rtmedia-single-media-container video' ).attr( 'src' );
//Path for audio
var media_path_audio = jQuery( '#rtmedia-single-media-container audio' ).attr( 'src' );
// jwplayer for video
jwplayer( media_element_id ).setup({
file: media_path_video,
height: 360,
width: 640
});
// jwplayer for audio
jwplayer( media_element_id ).setup({
file: media_path_audio,
height: 30,
width: 640
});
```

--------------------------------

### Remove BuddyPress Profile Tab

Source: https://rtmedia.io/docs/developers/add-remove-buddypress-tabs

Delete a tab from the BuddyPress member profile navigation. This example removes the 'notifications' tab.

```php
bp_core_remove_nav_item( 'notifications', 'members' );
```

--------------------------------

### Get Media Gallery with Parameters

Source: https://rtmedia.io/docs/developers/json-api

Use `rtmedia_gallery` to fetch media. Specify `media_type`, `media_author`, `global`, `context`, `context_id`, `order_by`, `per_page`, and `page` to filter results. Defaults fetch all media for the current user.

```php
action => rtmedia_api
method  => rtmedia_gallery
token => 1c1486ad94f3eb155ce52d3dfe0842292ca4f0a1
media_type => photo, video, music, document (<strong>optional, </strong>by default fetches all media types, specific media types are fetched if specified as comma separated or array of values)
media_author => current user(default), if super admin, media for all users is fetched(default), if a super user specifies id for other media author, media for that author is fetched
global => true(default), <strong>optional, </strong>if set to false, global items are not included
context => profile ( <strong>optional, </strong>not set by default )
context_id => <strong>optional</strong>
order_by => media_id (default, <strong>optional</strong>)
per_page => 5 (<strong>optional, </strong>set to 10 by default)
page => 2 (<strong>optional, </strong>displays media for first page by default)
```

--------------------------------

### Remove BuddyPress Group Tab

Source: https://rtmedia.io/docs/developers/add-remove-buddypress-tabs

Delete a sub-navigation item from a BuddyPress group's menu. This example removes the 'media' sub-tab.

```php
bp_core_remove_subnav_item( bp_current_item(), 'media', 'groups' );
```

--------------------------------

### Log Group Playlists

Source: https://rtmedia.io/docs/addons/playlists/filters

This filter enables modification of the list of playlists for groups a user is a member of. The example logs the playlists for debugging.

```php
add_filter( 'rtm_get_group_playlists', 'rtm_list_group_playlists', 10, 1);

function rtm_list_group_playlists( $playlists ) {
        error_log(var_export( $playlists, true) );
        return $playlists;
}
```

--------------------------------

### Get rtMedia Comments

Source: https://rtmedia.io/docs/developers/json-api

Fetches comments for a user or a specific media item. Provide media_id to filter comments for a particular media.

```http
action => rtmedia_api
method  => get_rtmedia_comment
token => 1c1486ad94f3eb155ce52d3dfe0842292ca4f0a1
media_id => 47 ( optional, to fetch comments for a particular media )
```

--------------------------------

### Get User Profile

Source: https://rtmedia.io/docs/developers/json-api

Retrieves the user's avatar and BuddyPress profile fields. Can fetch profiles for other users by specifying `user_id`.

```APIDOC
## GET bp_get_profile

### Description
The function returns User avatar and BuddyPress Profile Fields.

### Method
GET

### Endpoint
rtmedia_api

### Parameters
#### Query Parameters
- **method** (string) - Required - `bp_get_profile`
- **token** (string) - Required - API token for authentication
- **user_id** (integer) - Optional - ID of the user whose profile to fetch

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation ('TRUE' or 'FALSE')
- **status_code** (integer) - The status code of the response
- **message** (string) - A message describing the response
- **data** (object) - Contains profile information including avatar and fields

#### Response Example (Success)
```json
{
  "status": "TRUE",
  "status_code": 400002,
  "message": "profile fields",
  "data": {
    "id": "1",
    "avatar": {
      "src": "http://gravatar.com/avatar/b71b87b10ab35253f5cdd5d7e4492d03?d=http://example.com/wp-content/plugins/buddypress/bp-core/images/mystery-man.jpg&amp;s=250&amp;r=G",
      "width": 250,
      "height": 250
    },
    "fields": {
      "Name": {
        "value": "adminn",
        "privacy": "public"
      }
    }
  }
}
```
```

--------------------------------

### Display Media from a Specific Album

Source: https://rtmedia.io/docs/features/gallery

Use this to display media from a particular album within a specified context and context ID. Global is set to false.

```shortcode
[rtmedia_gallery global="false" context="profile" context_id="5" album_id="17"]
```

--------------------------------

### Display Media from a BuddyPress Group

Source: https://rtmedia.io/docs/features/gallery

Fetches media from a specific BuddyPress group. Context is set to 'group' and context_id specifies the group.

```shortcode
[rtmedia_gallery context="group" context_id="1"]
```

--------------------------------

### rtmedia_after_add_playlist

Source: https://rtmedia.io/docs/addons/playlists/actions

Action fires immediately after a new playlist is created. It receives the playlist object.

```APIDOC
## rtmedia_after_add_playlist

### Description
Action will fire immediately after new playlist created.

### Parameters
- **playlist** (object) - The newly created playlist object.

### Example Usage
```php
add_action( 'rtmedia_after_add_playlist', 'rtmedia_after_add_playlist' );

function rtmedia_after_add_playlist( $playlist ) {
    error_log(var_export( $playlist, true) );
}
```
```

--------------------------------

### Logout Failure Response Sample (Invalid Token)

Source: https://rtmedia.io/docs/developers/json-api

Example JSON response for a failed logout attempt due to an invalid or expired token.

```json
{"status":"FALSE",
    "status_code":600003,
    "message":"token invalid",
    "data":false
}
```

--------------------------------

### Rename Selector Button in Uploader

Source: https://rtmedia.io/docs/addons/sidebar-widgets/filters

Modify the text of the 'Select' button within the rtMedia sidebar uploader. This example changes it to 'Select the files'.

```php
add_filter('rtmedia_upload_tabs', 'function_to_rename_selector_button', 10, 1);
function function_to_rename_selector_button($tabs){
    $tabs['file_upload']['default']['content'] = str_replace( 'value="Select"', 'value="Select the files"', $tabs['file_upload']['default']['content']);
    return $tabs;
}
```

--------------------------------

### Customize Upload Not Allowed Message

Source: https://rtmedia.io/docs/addons/sidebar-widgets/filters

Change the warning message displayed when media uploads are not permitted in a widget. This example customizes the message for 'uploader_widget'.

```php
add_filter( 'rtmedia_upload_not_allowed_message', 'rtm_uploader_not_allowed_message', 10, 2);

function rtm_uploader_not_allowed_message( $msg, $uploader ) {
    if ( 'uploader_widget' == $uploader ) {
        $msg = 'You are not allowed to upload media from this widget.'; 
    }
    return $msg;
}
```

--------------------------------

### Modify Media Sitemap Change Frequency

Source: https://rtmedia.io/docs/addons/rtmedia-seo/filters

This filter allows you to control the change frequency attribute for media in the sitemap. The example sets it to 'weekly'.

```php
add_filter('rtm_seo_media_change_frequency', 'rtm_seo_media_change_frequency', 10, 2 );

function rtm_seo_media_change_frequency( $frequency, $media_id ) {
    return 'weekly';
}
```

--------------------------------

### Modify Media Sitemap Priority

Source: https://rtmedia.io/docs/addons/rtmedia-seo/filters

Use this filter to set the priority of media items in the sitemap. The example sets a fixed priority of 0.8.

```php
add_filter('rtm_seo_media_priority', 'rtm_seo_media_priority', 10, 2 );

function rtm_seo_media_priority( $priority, $media_id ) {
    return 0.8;
}
```

--------------------------------

### Get Specific Media Details

Source: https://rtmedia.io/docs/developers/json-api

Use `rtmedia_get_media_details` with a `media_id` to retrieve detailed information about a specific media item. Requires an API token.

```php
action => rtmedia_api
method  => rtmedia_get_media_details
token => 1c1486ad94f3eb155ce52d3dfe0842292ca4f0a1
media_id => 47


```

--------------------------------

### Media Upload Success Response

Source: https://rtmedia.io/docs/developers/json-api

Sample successful response after uploading media.

```json
{"status":"TRUE",
"status_code":140004,
"message":"media updated",
"data":false
}


```

--------------------------------

### rtm_before_add_global_album

Source: https://rtmedia.io/docs/addons/default-albums/actions

Action will fire just before a new global album will be added by the admin. It receives the album name as a parameter.

```APIDOC
## rtm_before_add_global_album

### Description
Action will fire just before new global album will added by admin.

### Parameters
#### Path Parameters
- **album_name** (string) - Required - The name of the global album to be created.

### Request Example
```php
add_action( 'rtm_before_add_global_album', 'rtmedia_before_add_global_album', 10, 1 );

function rtmedia_before_add_global_album ( $album_name ) {
    error_log(var_export( 'New global album "' .  $album_name . '" will be create.. ', true ) );
}
```
```

--------------------------------

### Define WordPress Language in wp-config.php

Source: https://rtmedia.io/docs/foodmania/theme-translation

Set the WPLANG constant in your wp-config.php file to specify the language for your WordPress installation. This is necessary to activate theme translations.

```php
define('WPLANG', 'de_DE');
```

--------------------------------

### Handle Upload and Fix Orientation

Source: https://rtmedia.io/docs/troubleshooting/fixing-image-orientation-wordpress-uploads

This snippet shows the initial steps of handling an uploaded file and then passing it to a custom exif function to correct its orientation.

```php
<?php
$file = wp_handle_upload($file);
$file = exif($file);
?>
```

--------------------------------

### Allow Bucket Creation

Source: https://rtmedia.io/docs/rtamazon-plugin

Set to 'TRUE' to grant permission for the plugin to create S3 buckets. If set to 'FALSE' or omitted, bucket creation will be disabled.

```php
define( 'RTAMAZON_S3_ALLOW_BUCKET_CREATION', 'TRUE' );
```

--------------------------------

### Display Logged-in User's Media

Source: https://rtmedia.io/docs/features/gallery

Dynamically displays media of the logged-in user. Global defaults to false, and context_id defaults to the current user's ID.

```shortcode
[rtmedia_gallery context="profile"]
```

--------------------------------

### Modify Download Button Label with rtmedia_download_button_label

Source: https://rtmedia.io/docs/addons/direct-download-link/filters

Use the 'rtm_download_button_label' filter to change the text displayed on the download button. This example changes it to 'Save Media'.

```php
add_filter( 'rtm_download_button_label', 'rtmedia_download_button_label', 10, 1 );

function rtmedia_download_button_label( $label ) {
    return 'Save Media';
}
```
Tokens:
Raw