Video Feed Options

This page lists all of the TubePress options that apply to the collection of videos from a remote video provider (YouTube, Vimeo, etc).

Global

The options below apply to all video providers (YouTube, Vimeo, Dailymotion, etc.).

Option name orderBy
Description Defines the overall sort order of a video feed.
Default value default
Valid values
  • alphabetical Alphabetical sort based on the video's title. (Vimeo only)
  • default TubePress chooses the "best" sort order for the video source. e.g. search-based galleries are sorted by relevance, and user uploads are sorted by newest.
  • likes Most-liked videos first. (Vimeo only)
  • longest Longest videos first. (Vimeo only)
  • newest Newest videos first.
  • oldest Oldest videos first.
  • random Retrieves videos in a random order. (Dailymotion only)
  • ranking Highest-ranked videos first. (Dailymotion only)
  • rating Highest-rated videos first. (YouTube only)
  • relevance Applies only to search-based galleries or interactive searching. Videos most relevant to the search term will be shown first.
  • reverseAlphabetical Reverse alphabetical sort based on the video's title.
  • shortest Shortest videos first. (Vimeo only)
  • title Videos will be shown in alphabetical order of their titles. (YouTube only)
  • trending Most-trending videos first. (Dailymotion only)
  • viewCount Videos with the most views will be shown first.
Note Not all sort orders can be used with every video source.
Example shortcode
[tubepress orderBy="newest"]
Example in PHP
<?php TubePressPro::getHTML('orderBy="newest"');
Option name perPageSort
Description Defines an additional sorting to apply to each individual page of a video gallery.
Default value none
Valid values
  • commentCount Videos with more comments will be shown before others.
  • duration Longest-running videos shown first.
  • newest Newest videos first
  • none Do nothing.
  • oldest Oldest videos first.
  • random Shuffles videos on the page.
  • rating Highest-rated videos first.
  • title Videos will be shown in alphabetical order of their titles..
  • viewCount Videos with the most views will be shown first
Example shortcode
[tubepress perPageSort="newest"]
Example in PHP
<?php TubePressPro::getHTML('perPageSort="newest"');
Option name resultCountCap
Description Set a maximum limit on the total number of videos in a gallery. This can both limit the number of videos that show up on a page (if resultsPerPage > resultCountCap), or reduce the number of pagination links for a gallery. Set to 0 to disable any limit.
Default value 0
Valid values Any non-negative integer
Example shortcode
[tubepress resultCountCap="100"]
Example in PHP
<?php TubePressPro::getHTML('resultCountCap="100"');
Option name searchResultsRestrictedToUser
Description For keyword-based galleries, or during interactive searching, this option can filter the results to videos uploaded by the given user or channel.
Default value empty
Valid values Any Vimeo username, a Dailymotion user ID, or a YouTube username or channel ID.
Example shortcode
[tubepress searchResultsRestrictedToUser="3hough"]
Example in PHP
<?php TubePressPro::getHTML('searchResultsRestrictedToUser="3hough"');
Option name videoBlacklist
Description A list of video IDs that should never appear in TubePress's output.
Default value empty
Valid values A comma-separated list of YouTube, Vimeo, or Dailymotion video IDs.
Example shortcode
[tubepress videoBlacklist="HSrtIrVCm64, BnS-rTbFw2g, 3045633"]
Example in PHP
<?php TubePressPro::getHTML('videoBlacklist="HSrtIrVCm64, BnS-rTbFw2g, 3045633"');

Dailymotion

The options below apply only to Dailymotion.

Option name dailymotionCountry
Description Limit to videos declared (by the video owner) to be from the given country.
Default value empty
Valid values Any two-digit country code.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionCountry="FR"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionCountry="FR"');
Option name dailymotionExcludeGenre
Description Exclude videos declared (by the video owner) to be in the given genre.
Default value empty
Valid values Any genre that might exist on Dailymotion. There is no finite list of genres.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionExcludeGenre="sports"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionExcludeGenre="sports"');
Option name dailymotionFamilyFilter
Description Enables or disables Dailymotion's family filter, which attempts to filter out videos with explicit or adult content.
Default value true
Valid values true or false
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionFamilyFilter="true"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionFamilyFilter="true"');
Option name dailymotionFeaturedOnly
Description Only include videos featured by Dailymotion.
Default value false
Valid values true or false
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionFeaturedOnly="true"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionFeaturedOnly="true"');
Option name dailymotionGenre
Description Only include videos declared (by the video owner) to be in the given genre.
Default value empty
Valid values Any genre that might exist on Dailymotion. There is no finite list of genres.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionGenre="sports"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionGenre="sports"');
Option name dailymotionHdOnly
Description Only include videos with vertical resolutions greater than or equal to 720p.
Default value false
Valid values true or false
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionHdOnly="true"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionHdOnly="true"');
Option name dailymotionLanguageDetected
Description Limit to videos detected (by Dailymotion) to use the given language.
Default value none
Valid values Any of the code values found here, or none to include all detected languages.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionLanguageDetected="it"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionLanguageDetected="it"');
Option name dailymotionLanguagesDeclared
Description Limit to videos declared (by the video owner) to be in the specified language(s).
Default value none
Valid values A comma-separated list of two-digit language codes.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionLanguagesDeclared="ru, be, uk"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionLanguagesDeclared="ru, be, uk"');
Option name dailymotionLiveFilter
Description Only include videos with the given broadcast status.
Default value all
Valid values
  • all Include all broadcast statuses
  • onlyLive Only include live videos
  • onlyLiveOffAir Only include live videos (off-air)
  • onlyLiveOnAir Only include live videos (on-air)
  • onlyLiveUpcoming Only include live videos (upcoming)
  • onlyNonLive Only include non-live videos
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionLiveFilter="onlyLiveOnAir"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionLiveFilter="onlyLiveOnAir"');
Option name dailymotionLocale
Description Sets the desired localization for Dailymotion results.
Default value true
Valid values Any of the locale codes found here.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionLocale="ko_KR"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionLocale="ko_KR"');
Option name dailymotionOnlyLongerThan
Description Only include videos longer than or equal to the given number of minutes. Set to 0 to include all videos.
Default value 0
Valid values Any non-negative integer
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionOnlyLongerThan="10"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionOnlyLongerThan="10"');
Option name dailymotionOnlySearch
Description Only include videos that match a full-text search for the given term.
Default value empty
Valid values Any string.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionOnlySearch="yosemite national park"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionOnlySearch="yosemite national park"');
Option name dailymotionOnlyShorterThan
Description Only include videos shorter than or equal to the given number of minutes. Set to 0 to include all videos.
Default value 0
Valid values Any non-negative integer
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionOnlyShorterThan="10"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionOnlyShorterThan="10"');
Option name dailymotionOnlyStrongTag
Description Only include videos with the given tag (exact match)
Default value empty
Valid values Any string.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionOnlyStrongTag="yosemite"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionOnlyStrongTag="yosemite"');
Option name dailymotionOnlyTags
Description Only include videos with the given tags (full-text search)
Default value empty
Valid values A comma-separated list of tags.
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionOnlyTags="yosemite, california, park"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionOnlyTags="yosemite, california, park"');
Option name dailymotionOnlyOwners
Description Only include videos uploaded by the given Dailymotion users.
Default value empty
Valid values A comma-separated list of any of the following:
  • Exact user IDs (e.g. IGN)
  • User URLs on Dailymotion (e.g. http://www.dailymotion.com/ign or http://www.dailymotion.com/user/splashnews/1)
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionOnlyOwners="user1, user2, user3"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionOnlyOwners="user1, user2, user3"');
Option name dailymotionPartnerFilter
Description Only include videos with the given partner status.
Default value all
Valid values
  • all Include all videos
  • onlyPartner Only include partner videos
  • onlyUserGenerated Only include non-partner (user-generated) videos
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionPartnerFilter="onlyUserGenerated"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionPartnerFilter="onlyUserGenerated"');
Option name dailymotionPremiumFilter
Description Only include videos with the given free/paid status.
Default value all
Valid values
  • all Include all videos
  • onlyPremium Only include premium (paid) videos
  • onlyNonPremium Only include non-premium (free) videos
Dailymotion docs Click here
Example shortcode
[tubepress dailymotionPremiumFilter="onlyNonPremium"]
Example in PHP
<?php TubePressPro::getHTML('dailymotionPremiumFilter="onlyNonPremium"');

YouTube

The options below apply only to YouTube.

Option name embeddableOnly
Description Some videos have embedding disabled. Enabling this option will exclude these videos from your galleries. Most users will never need to modify this option.
Default value true
Valid values true or false
YouTube docs Click here
Example shortcode
[tubepress embeddableOnly="true"]
Example in PHP
<?php TubePressPro::getHTML('embeddableOnly="true"');
Option name filter_racy
Description Filter out restricted content.
Default value moderate
Valid values
  • none YouTube will not perform any filtering.
  • moderate YouTube will filter some videos.
  • strict YouTube will try to exclude all restricted videos.
YouTube docs Click here
Example shortcode
[tubepress filter_racy="strict"]
Example in PHP
<?php TubePressPro::getHTML('filter_racy="strict"');
Option name googleApiKey
Description Your Google API key. YouTube will use this for logging and quota purposes.
Default value empty
Valid values Any valid Google API key. WordPress users can follow these instructions to obtain a new key, and standalone PHP users can follow these instructions. You may use a single key on multiple websites.
YouTube docs Click here
Example shortcode
[tubepress googleApiKey="xxxx"]
Example in PHP
<?php TubePressPro::getHTML('googleApiKey="xxxx"');


Last Updated Feb 22, 2016 11:40PM PST
c65861bf7a72e1a8878bdf73cabbbdbf@tubepress.desk-mail.com
http://assets2.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete