Vimeify Documentation

Appearance

Initial Setup ​

After installing Vimeify and configuring your API connection, this guide will help you configure the plugin settings and prepare it for use.

Prerequisites ​

Before proceeding with initial setup:

  • ✅ Vimeify plugin is installed and activated
  • ✅ API connection is configured (API Configuration Guide)
  • ✅ Connection status shows "Connected" in dashboard

Plugin Settings ​

Navigate to Vimeify → Settings to configure the plugin.

General Settings ​

Configure basic plugin behavior:

Default Privacy ​

Choose the default privacy level for newly uploaded videos:

  • Public: Anyone can view the video
  • Private: Only you can view the video
  • Unlisted: Anyone with the link can view, but won't appear in search

Recommendation: Start with "Unlisted" for testing, then switch to your preferred default.

Auto-Publish Videos ​

Control whether videos are automatically published in WordPress after upload:

  • Enabled: Videos appear immediately after upload
  • Disabled: Videos are saved as drafts for manual review

Recommendation: Enable for trusted users, disable if you want to review videos before publishing.

Default Category ​

Assign a default category to new videos:

  1. Create categories at Vimeify → Categories
  2. Select a default category in settings
  3. All new uploads will be assigned to this category automatically

Optional: Leave blank if you prefer to assign categories manually.

Sync Settings ​

Configure how Vimeify synchronizes with your Vimeo account.

Sync Behavior ​

Choose how Vimeify handles videos from your Vimeo account:

Update existing videos only (Recommended)

  • Only syncs videos already in WordPress
  • Keeps WordPress and Vimeo data in sync
  • Won't import all Vimeo videos automatically
  • Better for large Vimeo libraries

Sync all videos from Vimeo

  • Automatically imports ALL videos from Vimeo
  • Creates WordPress posts for every Vimeo video
  • Good for new sites or small video libraries
  • Can create many posts if you have hundreds of videos

Recommendation

Start with "Update existing videos only" to maintain control over which videos appear in WordPress. You can manually import specific videos later.

Sync Frequency ​

Vimeify uses automatic background sync with these intervals:

  • Metadata Sync: Every 10 minutes

    • Updates video titles, descriptions, thumbnails
    • Very efficient (1 API call per 100 videos)

  • Status Sync: Every 20 minutes

    • Removes deleted Vimeo videos from WordPress
    • More API intensive (1 call per video)

  • Cleanup: Every hour

    • Removes temporary files
    • Clears expired cache

Note

Sync frequency cannot be changed via settings. These intervals are optimized for performance and API quota management.

Upload Settings ​

Configure default upload behavior:

Default Upload Profile ​

Select which upload profile to use by default:

  1. Create upload profiles (see Upload Profiles below)
  2. Set one as the default in settings
  3. This profile will be pre-selected when uploading videos

Allowed File Types ​

Specify which video file types can be uploaded:

Default formats:

  • MP4
  • MOV
  • AVI
  • WMV
  • FLV
  • MKV
  • WebM

TIP

These are WordPress-level validations. Vimeo itself accepts many video formats and will transcode them automatically.

Max File Size ​

Maximum upload size is controlled by:

  1. Server limits: upload_max_filesize and post_max_size in PHP
  2. Vimeo plan limits: Varies by plan (Free: 500MB/week, Pro: 20GB/week)
  3. Chunked uploads: Vimeify uses chunked uploads for files over 5MB

To increase upload size, see Upload Limits Guide.

Upload Profiles ​

Upload profiles are templates that define how videos should be uploaded to Vimeo.

Why Use Upload Profiles? ​

Upload profiles allow you to:

  • Set different privacy levels for different types of videos
  • Organize videos into specific Vimeo folders automatically
  • Apply different embed presets (player settings)
  • Create context-specific upload configurations

Creating Your First Upload Profile ​

  1. Go to Vimeify → Upload Profiles
  2. Click Add New
  3. Configure the profile:

Profile Name ​

Give your profile a descriptive name:

  • "Standard Upload"
  • "Public Marketing Videos"
  • "Private Training Videos"
  • "Customer Testimonials"

Privacy Settings ​

Set the default privacy level for videos uploaded with this profile:

  • Public: Viewable by anyone
  • Private: Only viewable by you
  • Unlisted: Viewable by anyone with the link

Vimeo Folder (Optional) ​

Assign videos to a specific Vimeo folder:

  1. Create folders in your Vimeo account first
  2. Sync folders to WordPress (Vimeify → Folders → Sync)
  3. Select a folder in the upload profile
  4. Videos uploaded with this profile will automatically go to that folder

Organization

Use folders to organize videos by:

  • Client/customer
  • Project or campaign
  • Content type (tutorials, testimonials, etc.)
  • Department or team

Embed Preset (Optional) ​

Select an embed preset to control player appearance and behavior:

  • Player colors
  • Control visibility
  • Autoplay settings
  • Title and byline display

Embed presets are created in your Vimeo account settings.

Publish ​

Click Publish to save your upload profile.

Example Upload Profiles ​

Public Marketing Videos

  • Privacy: Public
  • Folder: "Marketing"
  • Embed Preset: "Brand Colors"

Internal Training

  • Privacy: Private
  • Folder: "Training Materials"
  • Embed Preset: "Default"

Customer Testimonials

  • Privacy: Unlisted
  • Folder: "Testimonials"
  • Embed Preset: "Minimal Player"

Testing Your Setup ​

After configuring settings, test your setup to ensure everything works correctly.

Test 1: Video Upload ​

Upload a small test video to verify the upload process:

  1. Navigate to Vimeify → Upload Video
  2. Click Select File and choose a small test video (under 50MB)
  3. Fill in video details:
    • Title: "Test Upload"
    • Description: "Testing Vimeify upload functionality"
    • Upload Profile: Select your default profile
  4. Click Upload to Vimeo
  5. Monitor the upload progress bar
  6. Wait for completion

Verify:

  • ✅ Video appears in Vimeify → Videos (WordPress)
  • ✅ Video appears in your Vimeo account
  • ✅ Video is in the correct folder (if specified)
  • ✅ Privacy setting is correct

Test 2: Manual Sync ​

Test the sync functionality:

  1. Upload a video directly to Vimeo (via vimeo.com)
  2. Option A: Wait 10 minutes for automatic sync
  3. Option B: Manually trigger sync via WP-CLI:
    bash
    wp vimeify sync metadata
  4. Check Vimeify → Videos to see if the new video appears

Verify:

  • ✅ New video from Vimeo appears in WordPress (if using "Sync all videos" mode)
  • ✅ Sync completes without errors
  • ✅ Video metadata is correct (title, description, etc.)

Test 3: Video Display ​

Test displaying videos on your site:

Using Gutenberg Block:

  1. Create or edit a post/page
  2. Add the "Vimeify Video" block
  3. Select your test video
  4. Publish and view the page

Using Shortcode:

  1. Find your video ID (Vimeify → Videos)
  2. Add shortcode to a post: [vimeify_video id="12345"]
  3. Publish and view the page

Verify:

  • ✅ Video player appears and loads
  • ✅ Video plays correctly
  • ✅ Player is responsive on mobile
  • ✅ Privacy settings allow viewing

Importing Existing Videos ​

If you want to import videos from your existing Vimeo library:

Option 1: Automatic Import ​

  1. Go to Vimeify → Settings → Sync
  2. Select "Sync all videos from Vimeo"
  3. Click Save Changes
  4. Wait for the next sync cycle (10 minutes) or trigger manually:
    bash
    wp vimeify sync all

WARNING

This will create WordPress posts for EVERY video in your Vimeo account. If you have hundreds of videos, this may take a while.

  1. Keep sync mode as "Update existing videos only"
  2. Upload videos one-by-one through WordPress (Vimeify → Upload Video)
  3. This gives you control over which videos appear in WordPress

Option 3: Selective Import via CLI ​

Use WP-CLI to import specific videos:

bash
# Import a specific video by Vimeo ID
wp vimeify video import 123456789

# Import all videos from a specific folder
wp vimeify sync folder --folder-id=12345

See CLI Commands for more options.

Organizing Your Videos ​

Categories ​

Create categories to organize videos:

  1. Go to Vimeify → Categories
  2. Add categories like:
    • Tutorials
    • Product Demos
    • Testimonials
    • Webinars
  3. Assign videos to categories when uploading

Categories work just like WordPress post categories.

Galleries ​

Create curated video collections:

Selection Gallery:

  • Manually choose specific videos
  • Full control over order
  • Static (doesn't auto-update)

Folder Sync Gallery (Recommended):

  • Automatically syncs with a Vimeo folder
  • Videos update automatically when folder changes
  • Dynamic and self-maintaining

See Galleries Guide for detailed instructions.

Next Steps ​

Now that your initial setup is complete:

  1. Start Uploading: Video Upload Guide
  2. Create Galleries: Galleries Guide
  3. Display Videos: Gutenberg Blocks
  4. Explore Pro Features: Frontend Uploads (Pro only)
  5. Customize: Hooks & Filters

Getting Help ​

If you encounter setup issues:

Released under the GPL-2.0 License.

Copyright © 2024 IDEOLOGIX MEDIA