Vimeify Documentation

Appearance

Frequently Asked Questions ​

Common questions about Vimeify features, setup, and troubleshooting.

General Questions ​

What is Vimeify? ​

Vimeify is a WordPress plugin that integrates your site with Vimeo, allowing you to upload, manage, and display Vimeo videos directly from WordPress. It provides automatic synchronization, video galleries, page builder integration, and more.

Learn more →

Do I need a Vimeo account? ​

Yes, you need a Vimeo account (free or paid) to use Vimeify. The plugin connects to your Vimeo account via API credentials to upload and manage videos.

What Vimeo plans are supported? ​

Vimeify works with all Vimeo plans:

  • Free: Basic features with 500MB weekly upload, 5GB storage
  • Plus: More storage and upload quota
  • Pro: Higher limits and advanced features
  • Business: Unlimited uploads and premium features

Higher-tier plans provide better API limits and storage.

Is Vimeify free? ​

Yes, there's a free version with core features:

  • Video upload and management
  • Automatic sync
  • Gutenberg blocks
  • Basic page builder support
  • Galleries and shortcodes

Vimeify Pro adds:

  • Form builder integrations (WPForms, Gravity Forms)
  • LMS integration (LearnDash)
  • ACF field type
  • CustomForms API
  • Priority support

What's the difference between Free and Pro? ​

FeatureFreePro
Video Upload✅✅
Auto Sync✅✅
Galleries✅✅
Gutenberg Blocks✅✅
Elementor/Bricks✅✅
Form Builders❌✅
LMS Integration❌✅
ACF Field❌✅
CustomForms API❌✅
Priority Support❌✅

Installation & Setup ​

How do I install Vimeify? ​

  1. Install from WordPress Plugin Directory
  2. Activate the plugin
  3. Get Vimeo API credentials
  4. Enter credentials in Vimeify → Settings → Connection
  5. Start uploading videos

Full installation guide →

How do I get Vimeo API credentials? ​

  1. Go to developer.vimeo.com/apps
  2. Create a new app (or use existing)
  3. Generate an access token with required scopes
  4. Copy the Access Token
  5. Enter in WordPress settings

Alternatively, Vimeify can use an existing Vimeo plugin connection automatically!

Detailed instructions →

Can I use environment variables for API credentials? ​

Yes! Define in wp-config.php:

php
define('VIMEIFY_ACCESS_TOKEN', 'your_access_token');

This is more secure than storing in database and works great for multi-environment setups.

Note: When defined in wp-config.php, you cannot disconnect via WordPress admin. Edit the wp-config.php file directly to change the token.

Learn more →

Does Vimeify work with multisite? ​

Yes, Vimeify is multisite compatible. Each site in your network can have its own Vimeo API credentials and settings.

Video Upload ​

What video formats are supported? ​

Vimeify supports all formats that Vimeo accepts:

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

The plugin validates file types before upload.

What's the maximum upload size? ​

Upload size depends on three factors:

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

Learn about upload limits →

How do I increase upload size? ​

Server Side - Edit php.ini:

ini
upload_max_filesize = 2G
post_max_size = 2G
max_execution_time = 600
memory_limit = 512M

Vimeo Side: Upgrade your Vimeo plan for higher limits.

Can users upload videos from the frontend? ​

Yes, with Vimeify Pro using:

  • Form builder integrations (WPForms, Gravity Forms)
  • CustomForms API for custom forms
  • Frontend upload portals

Learn about Frontend Uploads →

Do uploaded videos appear immediately? ​

Videos appear in WordPress immediately after upload completes. However, Vimeo needs time to process the video (transcoding) before it's playable. Processing time varies by video size and Vimeo's queue.

Can I upload to specific Vimeo folders? ​

Yes! Use Upload Profiles to configure automatic folder assignment. When you upload using that profile, videos go directly to the specified Vimeo folder.

Learn about Upload Profiles →

Synchronization ​

How does automatic sync work? ​

Vimeify uses WordPress Action Scheduler for reliable background sync:

  • Metadata Sync: Every 10 minutes - updates video info
  • Status Sync: Every 20 minutes - removes deleted videos
  • Cleanup: Hourly - removes temporary files

Learn about sync →

Can I manually trigger sync? ​

Yes, two ways:

Via WP-CLI:

bash
wp vimeify sync all

Via WordPress admin: Coming soon

CLI commands →

What data gets synced? ​

From Vimeo to WordPress:

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

Note: WordPress categories/galleries are local only.

How long does sync take? ​

Depends on video count:

  • < 100 videos: Few minutes
  • 100-1000 videos: 10-60 minutes
  • 1000+ videos: 1-3 hours

Sync is incremental and respects API quotas.

Does sync use a lot of API calls? ​

Metadata Sync: 1 API call per 100 videos (very efficient)

Status Sync: 1 API call per video (more intensive)

Vimeify automatically manages API quotas to prevent exceeding limits.

What happens if I hit API limits? ​

Vimeify:

  1. Detects approaching limit
  2. Stops sync operations
  3. Saves current progress
  4. Automatically resumes after quota resets (hourly)

You'll never lose sync progress.

Video Display ​

How do I display videos? ​

Multiple ways:

Gutenberg Blocks:

Add "Vimeify Video" or "Vimeify Gallery" block

Shortcodes:

[vimeify_video id="123456"]
[vimeify_gallery id="123" style="slider"]

Page Builders:

  • Elementor widgets
  • Bricks elements
  • Direct shortcode insertion

Learn about display options →

Can I customize the video player? ​

Yes! Control:

  • Player dimensions
  • Autoplay and loop
  • Controls visibility
  • Player colors
  • Title and byline display
  • And more

Customize via shortcode parameters, block settings, or PHP filters.

Are videos responsive? ​

Yes, all video embeds are fully responsive by default and work on mobile devices.

Can I create custom video layouts? ​

Yes, several ways:

  1. Custom CSS: Add styles to your theme
  2. Template Overrides: Copy templates to your theme
  3. Hooks/Filters: Use 50+ hooks to customize
  4. Custom Development: Use PHP API

Customization guide →

Galleries ​

Selection Gallery:

  • Manually choose videos
  • Full control over selection and order
  • Static - doesn't auto-update

Folder Sync Gallery:

  • Automatically syncs with Vimeo folder
  • Videos update automatically
  • Order matches Vimeo folder

Learn about galleries →

How often do folder sync galleries update? ​

Every 10 minutes during metadata sync. Videos are added/removed automatically to match the Vimeo folder.

Can I have multiple display styles? ​

Yes! Each gallery can display as:

  • Slider: Horizontal carousel
  • Playlist: Vertical list with player

Choose the style when embedding:

[vimeify_gallery id="123" style="slider"]

Recommended: 10-30 videos per gallery

  • Smaller galleries load faster
  • Better user experience
  • Easier to navigate
  • Use pagination for larger collections

Integrations ​

Does Vimeify work with my page builder? ​

Vimeify natively supports:

  • Gutenberg (WordPress Block Editor)
  • Elementor (custom widgets)
  • Bricks (native elements)

Other page builders can use shortcodes.

Integration guides →

Can I use Vimeify with forms? ​

Yes, with Vimeify Pro:

  • WPForms integration
  • Gravity Forms integration
  • CustomForms API for other forms

Frontend Uploads →

Does it work with LMS plugins? ​

Yes, Vimeify Pro integrates with:

  • LearnDash

Use for video lessons, course content, and assignments.

Is it compatible with ACF? ​

Yes! Vimeify Pro provides a custom ACF field type for selecting videos in custom fields.

What about multilingual sites? ​

Vimeify is compatible with:

  • WPML
  • Polylang
  • Other translation plugins

Video metadata can be translated per language.

Performance & Security ​

Does Vimeify slow down my site? ​

No. Vimeify:

  • Loads assets only when needed
  • Uses background processing for sync
  • Minifies CSS/JS in production
  • Supports lazy loading
  • Caches API responses

Is my Vimeo API token secure? ​

Yes. Vimeify:

  • Stores tokens encrypted in database
  • Supports wp-config.php storage (recommended)
  • Never exposes tokens in frontend
  • Uses nonce verification
  • Follows WordPress security standards

Can I control who uploads videos? ​

Yes, using WordPress capabilities:

php
// Grant upload permission
$role = get_role( 'author' );
$role->add_cap( 'upload_to_vimeo' );

// Remove permission
$role->remove_cap( 'upload_to_vimeo' );

Learn about permissions →

Are uploads validated? ​

Yes, Vimeify validates:

  • File type (video formats only)
  • File size (server and Vimeo limits)
  • User permissions
  • API quota availability
  • Vimeo account status

Troubleshooting ​

Videos aren't syncing ​

Solutions:

  1. Check API credentials connected
  2. Verify Action Scheduler running: wp action-scheduler run
  3. Check API quota not exceeded
  4. Manually trigger sync: wp vimeify sync metadata
  5. Review logs at wp-content/uploads/vimeify/cron.log

Sync troubleshooting →

Upload fails immediately ​

Common causes:

  1. Invalid API credentials
  2. File type not allowed
  3. File too large for server
  4. Insufficient permissions
  5. API quota exceeded

Check:

  • Test API connection in settings
  • Verify file format
  • Check PHP upload limits
  • Review user capabilities

Upload troubleshooting →

Video player not appearing ​

Solutions:

  1. Verify video published in WordPress
  2. Check Vimeo privacy settings
  3. Test video on vimeo.com directly
  4. Clear browser/plugin cache
  5. Check browser console for errors

For Folder Sync Galleries:

  1. Verify Vimeo folder has videos
  2. Wait for sync (max 10 minutes)
  3. Manually sync: wp vimeify sync metadata
  4. Check folder selected correctly

For Selection Galleries:

  1. Verify videos added to gallery
  2. Check videos are published
  3. Clear cache

API quota exceeded ​

Immediate fix: Wait 1 hour for quota reset

Long-term solutions:

  1. Upgrade Vimeo plan for higher limits
  2. Reduce sync frequency
  3. Use "Update existing only" sync mode
  4. Monitor quota: wp vimeify sync info

"Invalid post ID" error ​

This means the video post doesn't exist in WordPress. Possible causes:

  1. Video deleted
  2. Wrong post ID
  3. Video in trash
  4. Database issue

Solution: Use correct video ID or restore from trash.

Development ​

Can I customize Vimeify? ​

Yes! Vimeify provides:

  • 50+ hooks & filters: Customize behavior
  • PHP API: Programmatic video management
  • REST API: Headless WordPress support
  • Template system: Override templates
  • CustomForms API (Pro): Build custom forms

Developer documentation →

How do I add custom fields to videos? ​

Use WordPress post meta:

php
// Add custom field
add_action( 'vimeify_video_created', function( $post_id ) {
    update_post_meta( $post_id, '_custom_field', 'value' );
} );

// Display custom field
$custom = get_post_meta( $video_id, '_custom_field', true );

Can I modify the sync process? ​

Yes, using filters:

php
// Modify sync query
add_filter( 'vimeify_sync_per_page', function( $per_page ) {
    return 50; // Sync 50 videos at a time
} );

// Modify synced data
add_filter( 'vimeify_sync_video_data', function( $data, $vimeo_data ) {
    // Customize video data
    return $data;
}, 10, 2 );

All hooks →

Is there a staging/development mode? ​

Yes! Define in wp-config.php:

php
define('VIMEIFY_DEVELOPMENT', true);

This:

  • Loads unminified assets
  • Enables detailed logging
  • Shows debug information
  • Useful for development

Pricing & Licensing ​

Is there a trial for Pro? ​

Contact us for Pro trial information and demo access.

How many sites can I use Pro on? ​

Pro licenses are:

  • Single: 1 site
  • 5-Pack: 5 sites
  • Developer: Unlimited sites

Can I upgrade from Free to Pro? ​

Yes! Pro installs alongside Free (doesn't replace it). Free version is required for Pro to work.

Do I get updates with Pro? ​

Yes, Pro includes:

  • 1 year of updates
  • 1 year of support
  • Renewal discount after first year

Getting Help ​

Where can I get support? ​

Free Version:

Pro Version:

  • Priority email support
  • Private ticket system
  • Response within 24 hours

How do I report a bug? ​

  1. Check if it's a known issue
  2. Test with default theme and no other plugins
  3. Submit detailed report:
    • WordPress version
    • PHP version
    • Steps to reproduce
    • Error messages
    • Screenshots

Report on GitHub

Can I request features? ​

Yes! Submit feature requests on:

  • GitHub Issues
  • WordPress.org support forum
  • Direct email (Pro users)

We prioritize based on demand and feasibility.

Where are the logs? ​

Sync and error logs are at:

wp-content/uploads/vimeify/cron.log

View in real-time:

bash
tail -f wp-content/uploads/vimeify/cron.log

How do I debug issues? ​

Enable debugging:

php
// In wp-config.php
define('WP_DEBUG', true);
define('WP_DEBUG_LOG', true);
define('VIMEIFY_DEVELOPMENT', true);

Then check wp-content/debug.log for errors.

Still have questions? ​

Released under the GPL-2.0 License.

Copyright © 2024 IDEOLOGIX MEDIA