Vimeify Documentation

Appearance

Video Management ​

Vimeify integrates seamlessly with WordPress, providing powerful video management capabilities through familiar WordPress interfaces.

Videos Overview ​

All synced and uploaded videos appear in the WordPress admin under Vimeify → Videos.

Videos List ​

The videos list page shows all your Vimeo videos with standard WordPress list table features.

Columns:

  • Thumbnail: Video preview image
  • Title: Video name with edit quick link
  • Vimeo ID: Direct Vimeo video identifier
  • Duration: Video length (HH:MM:SS)
  • Privacy: Public, Private, or Unlisted
  • Categories: Assigned Vimeify categories
  • Galleries: Associated galleries
  • Date: Upload date or publish date

List Actions:

  • Edit: Open full video editor
  • Quick Edit: Inline editing
  • Trash: Move to trash
  • View: Preview on frontend
  • View on Vimeo: Open Vimeo video page

Filtering Videos ​

By Category:

  1. Use "All Categories" dropdown
  2. Select category to filter
  3. View only videos in that category

By Gallery:

  1. Use "All Galleries" dropdown
  2. Select gallery to filter
  3. View only videos in that gallery

By Date:

  1. Use "All Dates" dropdown
  2. Select month/year
  3. View videos from that period

Search:

  1. Use search box (top right)
  2. Searches title and description
  3. Real-time results

Sorting Videos ​

Click column headers to sort by:

  • Title: Alphabetical order
  • Date: Upload/publish date
  • Modified: Last edit date

Click again to reverse sort order (ascending/descending).

Bulk Actions ​

Select multiple videos and perform batch operations.

Available Bulk Actions:

  • Edit: Bulk edit metadata
  • Move to Trash: Delete multiple videos
  • Assign Categories: Add categories to multiple videos
  • Add to Galleries: Add videos to galleries
  • Change Privacy: Update privacy settings

Using Bulk Actions:

  1. Check boxes next to videos
  2. Select action from "Bulk Actions" dropdown
  3. Click "Apply"
  4. Configure settings (if applicable)
  5. Confirm action

Editing Videos ​

Quick Edit ​

For fast inline editing without leaving the list:

  1. Hover over video row
  2. Click "Quick Edit"
  3. Edit fields:
    • Title
    • Slug
    • Date
    • Categories
    • Galleries
  4. Click "Update"

Best for: Quick metadata updates, category assignments.

Full Editor ​

For comprehensive editing with all options:

  1. Click video title or "Edit"
  2. Full post editor opens
  3. Edit all available fields
  4. Click "Update" to save

Video Editor Interface ​

Video Details ​

Title

  • Main video name
  • Used in listings and embeds
  • Updates Vimeo title on sync

Slug

  • URL-friendly permalink
  • Auto-generated from title
  • Customize for SEO

Description

  • Full video description
  • Supports HTML formatting
  • Updates Vimeo description on sync

Featured Image

  • Video thumbnail
  • Auto-synced from Vimeo
  • Can upload custom thumbnail

Vimeo Information ​

Read-only metadata synced from Vimeo:

Video Details:

  • Vimeo ID: Unique video identifier
  • Duration: Video length
  • Dimensions: Width × Height (pixels)
  • Upload Date: Original Vimeo upload date
  • Modified Date: Last Vimeo update
  • Playability: Playable status

Links:

  • Vimeo URL: Direct link to video on Vimeo
  • Embed URL: Player embed link
  • Thumbnail URL: Preview image link

Privacy Settings ​

Control video visibility:

Public

  • Anyone can view
  • Discoverable on Vimeo
  • Embeddable anywhere

Private

  • Only you and shared users
  • Not discoverable
  • Restricted embedding

Unlisted

  • Accessible via link
  • Not discoverable on Vimeo
  • Embeddable with link

WARNING

Privacy setting changes sync to Vimeo on next sync cycle (max 10 minutes). For immediate changes, edit directly on Vimeo.

Categories ​

Organize videos with hierarchical categories.

Assigning Categories:

  1. Check category boxes in right sidebar
  2. Click "Add New Category" to create
  3. Supports multiple categories
  4. Hierarchical structure (parent/child)

Category Features:

  • Filter videos by category
  • Query videos by category in code
  • Display category archives
  • Use in shortcodes

Galleries ​

Add videos to galleries for display collections.

Assigning to Galleries:

  1. Check gallery boxes in right sidebar
  2. Video appears in those galleries
  3. Supports multiple galleries
  4. Updates gallery displays automatically

TIP

For folder sync galleries, videos are managed automatically. Manual assignments only work for selection galleries.

Custom Fields ​

Access video metadata as custom fields.

Standard Meta Fields:

  • _vimeify_vimeo_id - Vimeo video ID
  • _vimeify_duration - Video length (seconds)
  • _vimeify_width - Video width (pixels)
  • _vimeify_height - Video height (pixels)
  • _vimeify_embed_url - Embed player URL
  • _vimeify_privacy - Privacy setting
  • _vimeify_upload_date - Original upload timestamp
  • _vimeify_thumbnail - Thumbnail URL array

Accessing Custom Fields:

php
$vimeo_id = get_post_meta( $post_id, '_vimeify_vimeo_id', true );
$duration = get_post_meta( $post_id, '_vimeify_duration', true );

Publishing Options ​

Status:

  • Published: Visible on site
  • Draft: Hidden, work in progress
  • Pending: Awaiting review
  • Private: Only visible to editors/admins

Visibility:

  • Public: Visible to all visitors
  • Password Protected: Requires password
  • Private: Only logged-in users with permission

Publish Date:

  • Set specific publish date/time
  • Schedule for future publication
  • Backdate to match Vimeo upload date

Deleting Videos ​

Moving to Trash ​

Soft delete - videos can be restored:

  1. Click "Move to Trash" on video
  2. Or use bulk action for multiple
  3. Video moves to Trash
  4. Restore within 30 days

Trash Location: Vimeify → Videos → Trash

Restoring:

  1. Navigate to Trash
  2. Hover over video
  3. Click "Restore"
  4. Video returns to published state

Permanent Deletion ​

Permanently remove videos:

Single Video:

  1. Move video to Trash
  2. Navigate to Trash
  3. Click "Delete Permanently"
  4. Confirm deletion

Bulk Deletion:

  1. Navigate to Trash
  2. Select videos
  3. Choose "Delete Permanently" bulk action
  4. Click "Apply"

DANGER

Permanent deletion cannot be undone. This only deletes the WordPress post, not the Vimeo video.

Vimeo Deletion ​

WordPress deletion does NOT delete from Vimeo. To delete from both:

Option 1: Delete from Vimeo first

  1. Delete video on vimeo.com
  2. Wait for status sync (max 20 minutes)
  3. Video auto-removes from WordPress

Option 2: Manual Vimeo deletion

  1. Delete from WordPress
  2. Manually delete from Vimeo dashboard
  3. Run sync: wp vimeify sync status

Video Organization ​

Using Categories ​

Create a hierarchical organization structure.

Creating Categories:

  1. Navigate to Vimeify → Categories
  2. Enter category name
  3. Select parent category (optional)
  4. Add description (optional)
  5. Click "Add New Category"

Category Hierarchy Example:

Tutorials
  ├── Beginner
  ├── Intermediate
  └── Advanced
Products
  ├── Product A
  └── Product B

Bulk Categorization:

  1. Select multiple videos
  2. Bulk Actions → Edit
  3. Select categories
  4. Update

Using Galleries ​

Group videos for display purposes.

Gallery Assignment:

  1. Edit video
  2. Check gallery boxes
  3. Video appears in gallery

Multiple Galleries:

  • Videos can be in multiple galleries
  • Update reflects in all galleries
  • Remove by unchecking box

Using Tags ​

Add metadata tags to videos (if enabled).

Adding Tags:

  1. Edit video
  2. Enter tags (comma-separated)
  3. Press Enter after each tag
  4. Update video

Tag Benefits:

  • Flexible organization
  • Easy filtering
  • Search enhancement
  • Custom queries

Video Metadata Management ​

Syncing Metadata ​

Keep WordPress and Vimeo in sync.

Automatic Sync:

  • Runs every 10 minutes
  • Updates all video metadata
  • Processes 100 videos per page
  • Respects API quota

Manual Sync:

bash
# Sync all video metadata
wp vimeify sync metadata

# Fresh sync from beginning
wp vimeify sync metadata --fresh

What Syncs:

  • Title and description
  • Duration and dimensions
  • Thumbnails
  • Privacy settings
  • Upload/modified dates
  • Playability status

What Doesn't Sync:

  • WordPress categories/galleries (local only)
  • Custom fields (unless specifically coded)
  • WordPress post status
  • Post content (beyond description)

Updating Video Information ​

WordPress → Vimeo:

  • Privacy settings sync on next cycle
  • Most other fields are Vimeo-authoritative
  • Use Vimeo API hooks for custom syncing

Vimeo → WordPress:

  • Metadata automatically syncs
  • Thumbnails download and update
  • Status changes reflect in WordPress

Manual Metadata Updates ​

Update specific video manually:

php
// Get video by Vimeo ID
$video_id = vimeify_get_video_by_vimeo_id( '123456789' );

// Update metadata from Vimeo
vimeify_sync_video_metadata( $video_id );

Viewing Videos ​

Frontend Display ​

Single Video Page:

  • Navigate to Vimeify → Videos
  • Hover over video
  • Click "View"
  • Opens single video page

Embed Display:

  • Responsive Vimeo player
  • Video metadata
  • Categories and galleries
  • Related videos (theme-dependent)

Admin Preview ​

Quick Preview:

  1. Edit video
  2. Find Vimeo preview metabox
  3. Click "Play" to preview
  4. Plays in admin without leaving page

View on Vimeo ​

Direct Vimeo Link:

  1. Edit video or hover in list
  2. Click "View on Vimeo"
  3. Opens video on vimeo.com
  4. Full Vimeo interface available

Video Statistics ​

Viewing Stats ​

Access video statistics (if available):

  1. Edit video
  2. Find "Statistics" metabox
  3. View available stats:
    • Play count
    • Like count
    • Comment count
    • Download count (if enabled)

TIP

Statistics availability depends on your Vimeo plan. Free accounts have limited stats.

Custom Stats Integration ​

Add custom analytics:

php
// Track video views
add_action( 'vimeify_video_viewed', function( $video_id ) {
    $views = get_post_meta( $video_id, '_custom_views', true );
    update_post_meta( $video_id, '_custom_views', $views + 1 );
} );

Advanced Management ​

Custom Video Queries ​

Query videos programmatically:

Basic Query:

php
$args = [
    'post_type' => 'vimeify-video',
    'posts_per_page' => 10,
    'orderby' => 'date',
    'order' => 'DESC',
];
$videos = new WP_Query( $args );

By Category:

php
$args = [
    'post_type' => 'vimeify-video',
    'tax_query' => [
        [
            'taxonomy' => 'vimeify-category',
            'field' => 'slug',
            'terms' => 'tutorials',
        ],
    ],
];

By Gallery:

php
$args = [
    'post_type' => 'vimeify-video',
    'tax_query' => [
        [
            'taxonomy' => 'vimeify-gallery',
            'field' => 'slug',
            'terms' => 'featured',
        ],
    ],
];

By Meta:

php
$args = [
    'post_type' => 'vimeify-video',
    'meta_query' => [
        [
            'key' => '_vimeify_duration',
            'value' => 300,
            'compare' => '>',
            'type' => 'NUMERIC',
        ],
    ],
];

REST API Management ​

Manage videos via REST API:

Get Videos:

bash
curl -X GET "https://yoursite.com/wp-json/vimeify/v1/videos" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response:

json
{
  "videos": [
    {
      "id": 123,
      "title": "My Video",
      "vimeo_id": "987654321",
      "duration": 120,
      "thumbnail": "https://...",
      "embed_url": "https://..."
    }
  ],
  "total": 50,
  "pages": 5
}

See full API reference →

Batch Operations ​

Perform operations on many videos:

WP-CLI Batch Updates:

bash
# Update all videos
wp post list --post_type=vimeify-video --format=ids | \
  xargs -I % wp post meta update % _custom_field "value"

# Bulk categorize
wp post list --post_type=vimeify-video --format=ids | \
  xargs -I % wp post term add % vimeify-category "tutorials"

Programmatic Batch:

php
$videos = get_posts( [
    'post_type' => 'vimeify-video',
    'posts_per_page' => -1,
    'fields' => 'ids',
] );

foreach ( $videos as $video_id ) {
    // Perform operation
    update_post_meta( $video_id, '_custom_meta', 'value' );
}

Troubleshooting ​

Videos Not Appearing ​

Check:

  1. Run sync: wp vimeify sync metadata
  2. Verify API credentials connected
  3. Check Trash folder
  4. Verify post type not hidden
  5. Review sync logs

Metadata Not Updating ​

Solutions:

  1. Check sync schedule: wp vimeify sync info
  2. Manually sync: wp vimeify sync metadata
  3. Verify API quota not exceeded
  4. Check Action Scheduler logs
  5. Review debug.log for errors

Bulk Actions Failing ​

Common Issues:

  • PHP timeout on large selections
  • Memory limit exceeded
  • Server restrictions

Solutions:

  1. Process in smaller batches
  2. Increase PHP limits
  3. Use WP-CLI for large operations
  4. Check error logs

Best Practices ​

Organization ​

  1. Consistent Naming: Use clear, descriptive titles
  2. Categorize Immediately: Assign categories on upload
  3. Use Galleries Wisely: Group related content
  4. Regular Cleanup: Remove outdated videos
  5. Tag Strategically: Use tags for flexible filtering

Maintenance ​

  1. Monitor Sync: Check sync status regularly
  2. Review Logs: Watch for errors in cron.log
  3. Update Metadata: Keep information current
  4. Clean Trash: Empty trash periodically
  5. Backup Data: Regular WordPress backups

Performance ​

  1. Limit Queries: Use pagination for large sets
  2. Cache Results: Cache expensive queries
  3. Optimize Images: Compress thumbnails
  4. Index Meta: Add indexes for queried meta
  5. Monitor Load: Watch server resources

Workflow ​

  1. Upload Strategy: Use upload profiles
  2. Review Process: Draft → Review → Publish
  3. Quality Control: Preview before publishing
  4. Scheduling: Schedule releases appropriately
  5. Documentation: Document your organization system
  • Upload - Uploading videos
  • Sync - Synchronization details
  • Galleries - Gallery management
  • CLI - Command-line management
  • Hooks - Customize management
  • API - Programmatic management

Released under the GPL-2.0 License.

Copyright © 2024 IDEOLOGIX MEDIA