ryan

Module: Video embed for YouTube/Vimeo (TextformatterVideoEmbed)

Recommended Posts

Video embed for YouTube and Vimeo

ProcessWire Textformatter module that enables translation of YouTube or Vimeo URLs to full embed codes, resulting in a viewable video in textarea fields you apply it to.

How to install

  • Copy the TextformatterVideoEmbed.module file to your /site/modules/ directory (or place it in /site/modules/TextformatterVideoEmbed/).
  • Click check for new modules in ProcessWire Admin Modules screen. Click install for the module labeled: "Video embed for YouTube/Vimeo".

How to use

  • Edit your body field in Setup > Fields (or whatever field(s) you will be placing videos in). On the details tab, find the Text Formatters field and select "Video embed for YouTube/Vimeo". Save.
  • Edit a page using the field you edited and paste in YouTube and/or Vimeo video URLs each on their own paragraph.

Example

How it might look in your editor (like TinyMCE):

Here are two videos about ProcessWire

https://www.youtube.com/watch?v=Wl4XiYadV_k

https://www.youtube.com/watch?v=XKnG7sikE-U

And here is a great video I watched earlier this week:

http://vimeo.com/18280328

How it works

This module uses YouTube and Vimeo oEmbed services to generate the embed codes populated in your content. After these services are queried the first time, the embed code is cached so that it doesn't need to be pulled again.

The advantage of using the oEmbed services is that you get a video formatted at the proper width, height and proportion. You can also set a max width and max height (in the module config) and expect a proportional video.

Configuration/Customization

You may want to update the max width and max height settings on the module's configuration screen. You should make these consistent with what is supported by your site design.

If you change these max width / max height settings you may also want to check the box to clear cache, so that YouTube/Vimeo oembed services will generate new embed codes for you.

Using with Markdown, Textile or other LML

I mostly assume you are using this with TinyMCE. But there's no reason why you can't also use this with something like Markdown or Textile. This text formatter is looking for a YouTube or Vimeo video URL surrounded by paragraph tags. As a result, if you are using Markdown or Textile (or something else like it) you want that text formatter to run before this one. That ensures that the expected paragraph tags will be present when TextformatterVideoEmbed runs. You can control the order that text formatters are run in by drag/drop sorting in the field editor.

Thanks to Pete for tuning me into these oEmbed services provided by YouTube and Vimeo a long time ago in another thread.

  • Like 12

Share this post


Link to post
Share on other sites

No probs, but not sure it was me that mentioned oembed ryan - think I said I'd build this module and then never did (there's a theme there ;)).

Share this post


Link to post
Share on other sites

The good thing about oembed is that you don't rely on third party scripts/services and many services already support it - see Ryan's module code and you'll see YouTube and Vimeo's oembed URLs

As such, this module can easily be expanded upon to provide more services.

Share this post


Link to post
Share on other sites

Michael, that looks interesting. Looks like a lot of cool possibilities there and I look forward to taking a closer look and seeing if there might be another module brewing in there. But I have to admit that I find the whole oEmbed thing a bit vulnerable, as it's letting another web site populate raw markup into your site. You must have a lot of trust in whoever you let do that. It's more sensitive than linking to another service's JS. I have that level of trust with YouTube and Vimeo. I suppose I need to convince myself that something like embed.ly doesn't seem like a potential security timebomb, because the potential is very cool. I'm going to spend some more time looking at it.

  • Like 2

Share this post


Link to post
Share on other sites

Can't wait to try this out! Thanks Ryan, incredibly useful.

Share this post


Link to post
Share on other sites

This is great Ryan, thank you! My only comment is that Vimeo seems to default to https - for me at least. When I tried entering a url like

the formatter didn't seem to catch it. To my surprise I could see how to fix it by duplicating the vimeo section and adding changing it to https. Scary!
  • Like 1

Share this post


Link to post
Share on other sites

Thanks Marty, I was wondering about https URLs, but hadn't yet seen any so figured they didn't use them. I have just updated the module to support them, so they should work now (vimeo or youtube).

Share this post


Link to post
Share on other sites

Most of the time my customers want self hosted videos. Usually I give them a simple File-Field and embed the video with a <video> tag and include a javascript (mediaelementjs.com) with flash fallback for browsers without html5-video support.

Medialement.js even has a youtube plugin so you can Embed youtube videos like this:

<video width="640" height="360" id="player1" preload="none">
<source type="video/youtube" src="https://www.youtube.com/watch?v=nOEw9iiopwI" />
</video>

I have not used this module yet, but maybe Medialement.js is a interesting option to include?

Share this post


Link to post
Share on other sites

Mediaelement looks pretty cool, I actually have a use for this on another project and am glad to find out about it. I need to take a closer look to determine if this is something that fits the URL-to-embed code purpose of the module without stepping over the line on front-end dev. But it certainly fits with the name and purpose of the module.

Modal popups are a good idea, but things that might be better in one's front-end development rather than in a text formatting module, given that they are more site/need specific and involve linking to local javascript files and such. These common YouTube/Vimeo video embeds are pretty much universal to the point where one almost expects one of their URLs to convert to a player, so that's what the purpose is here. And that's the most likely way this module would grow (adding more services). Still, this module may be a good starting point for branching in less universal, more site specific needs, and I'd encourage extending it like that.

Share this post


Link to post
Share on other sites

OT: Re: Embed.ly - They totally lost my trust with that reversed gradient on hover in navigation. Doh.

---

Also, Ryan, are you on fire or have you just finished million client projects? You seem to work 50 hours a day, lately.

Share this post


Link to post
Share on other sites

He perfected his clone() function in PW and it now clones humans too ;)

Share this post


Link to post
Share on other sites
Also, Ryan, are you on fire or have you just finished million client projects? You seem to work 50 hours a day, lately.

I wish that was me. You are thinking of Marty. :) I've not launched a bunch of projects lately, not by a long shot. The ones I posted about in Pub a month or two ago were done over a long period of time.

Share this post


Link to post
Share on other sites

Oh Marty's on fire alright, but it seems that new things in PW are coming faster than usually lately, so I thought you have somewhat less client work or so.

  • Like 2

Share this post


Link to post
Share on other sites

Adam, you don't need to like yourself :D i can give you a like ;)

Share this post


Link to post
Share on other sites

I saw that but didn't comment :D I've no idea why the software allows you to like yourself but it does...

Share this post


Link to post
Share on other sites

I thought that was edit button, I'm mobile today. O tapped random thibgs to edit :D Somehow I made the reply text smaller as well.

Share this post


Link to post
Share on other sites
I thought that was edit button, I'm mobile today.

Yeah yeah, we believe you ;)

Share this post


Link to post
Share on other sites

Hi all,

I'm trying to use the Embed video module, but it doesn't work for me... I followed the documentation, but it failed and I keep wondering what I am doing wrong.

Here's my work :

  • Module upload in 'site/modules/' > Check new module > installation
  • Setup > Fields > body > Details > Textformatters > Video embed
  • In my page body field, I have 2 Youtube links, but they stay as links (no embed...).

If you want to have a look at the page, here it is : http://flenglish.tux...s/the-alphabet/

Thanks for your concern ;-) (And sorry not to be able to find the answer myself...)

Share this post


Link to post
Share on other sites

@celfred, you've got two problems in that example:

  • YouTube links need to be alone in their own paragraphs, there shouldn't be any other content in same <p> tag -- try adding the descriptions below or above actual YT links (also: now they're in a list, which probably won't work either)
  • Don't make them actual hyperlinks; I might remember wrong, but IMHO that way they won't work -- just plain URL as a string without the <a> tag

I hope this helps a bit.

  • Like 2

Share this post


Link to post
Share on other sites

@teppo, Thank you for your help ! It works better now although I had tried doing this, but on the second link and it never worked. Actually, this second link still doesn't work. I've changed it with another equivalent video (for my purpose), and the new link works...

I can't tell what the problem is... If I copy and paste this link, the video is available...

If someone is interested in understanding the issue, here are my 3 Youtube links (preceded by https://www.youtube.com/ [to avoid the max number of media error I get posting in the Forum]):

  1. watch?v=8-NeizIkHBY
  2. watch?v=Imum21-hdNg
  3. watch?v=dsO__o4Ezjw

Number 1 and number 3 : Video embed without any problem since I followed teppo's advice (in their own paragraph's tags).

Number 2 : no embed... Just a regular text...

Thanks again !

Again, if you want to see the original article : http://flenglish.tux...s/the-alphabet/

Share this post


Link to post
Share on other sites

@celfred, either the video you're trying to embed has embedding disabled or this could be a problem (or feature, can't really tell yet) at YouTube. There's similar problem reported at the WordPress bug tracking system here: http://core.trac.wordpress.org/ticket/14377.

This example you gave returns code 401 Unauthorized and this is what oembed.com has to say about this particular error code:

The specified URL contains a private (non-public) resource. The consumer should provide a link directly to the resource instead of any embedding any extra information, and rely on the provider to provide access control.

Will have to do some more testing later.. unless, of course, someone else knows a solution / answer to this problem already :)

  • Like 2

Share this post


Link to post
Share on other sites

I am having problems with this module. It seems to save the embed codes into the database, which is good. Bad thing is that it saves only one line there. This causes every video to be the same. It seems to fail on video_id part, since my only row in textformatter_video_embed table is this:

www.
<iframe width="640" height="360" src="https://www.youtube.com/embed/9StIWIg03eM?fs=1&feature=oembed" frameborder="0" allowfullscreen></iframe>
2012-09-19 10:40:44

So it saves only www. as video_id and seems to that with every video. Is this problem only on my installation or are other experiencing the same? My url in textarea is in this format:

https://www.youtube.com/watch?v=9StIWIg03eM&feature=related
  • Like 2

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By BitPoet
      As threatened in the Pub sub forum in the "What are you currently building?" thread, I've toyed around with Collabora CODE and built file editing capabilities for office documents (Libre-/OpenOffice formats and MS Office as well as a few really old file types) into a PW module.
      If you are running OwnCloud or NextCloud, you'll perhaps be familiar with the Collabora app for this purpose.
      LoolEditor
      Edit office files directly in ProcessWire
      Edit your docx, odt, pptx, xlsx or whatever office files you have stored in your file fields directly from ProcessWire's page editor. Upload, click the edit icon, make your changes and save. Can be enabled per field, even in template context.
      Currently supports opening and saving of office documents. Locking functionality is in development.
      See the README on GitHub for installation instructions. You should be reasonably experienced with configuring HTTPS and running docker images to get things set up quickly.
      Pull requests are welcome!
      Here is a short demonstration:

    • By Robin S
      An Images field allows you to:
      Rename images by clicking the filename in the edit panel or in list view. Replace images, keeping metadata and filename (when possible) by dropping a new image on the thumbnail in the edit panel. Introduced here. But neither of these things is possible in File fields, which prompted this module. The way that files are renamed or replaced in this module is not as slick as in the Images field but it gets the job done. The most time-consuming part was dealing with the UI differences of the core admin themes. @tpr, gives me even more respect for the work that must go into AdminOnSteroids.
      Most of the code to support the rename/replace features is already present in InputfieldFile - there is just no UI for it currently. So hopefully that means these features will be offered in the core soon and this module can become obsolete.
       
      Files Rename Replace
      Allows files to be renamed or replaced in Page Edit.

      Usage
      Install the Files Rename Replace module.
      If you want to limit the module to certain roles only, select the roles in the module config. If no roles are selected then any role may rename/replace files.
      In Page Edit, click "Rename/Replace" for a file...
      Rename
      Use the text input to edit the existing name (excluding file extension).
      Replace
      Use the "Replace with" select to choose a replacement file from the same field. On page save the file will be replaced with the file you selected. Metadata (description, tags) will be retained, and the filename also if the file extensions are the same.
      Tip: newly uploaded files will appear in the "Replace with" select after the page has been saved.
       
      https://github.com/Toutouwai/FilesRenameReplace
      http://modules.processwire.com/modules/files-rename-replace/
    • By d'Hinnisdaël
      So I decided to wade into module development and created a wrapper module around ImageOptim, a service that compresses and optimizes images in the cloud. ImageOptim currently handles JPG, PNG and GIF files and, depending on the settings you use, shaves off between 15% and 60% in filesize. Great for bandwidth and great for users, especially on mobile.
      This module handles the part of uploading images to ImageOptim via their official API, downloading the optimized version and storing it alongside the original image.
       

       
      Download & Info
      GitHub / Module directory / Readme / Usage
       
      Why ImageOptim?
      There are other image optimization services out there, some of them free, that have outstanding ProcessWire modules. A few things make ImageOptim the best tool for most of my customers: It's not free, i.e. it will probably be around for a while and offers support. However, it's cheaper than some of the bigger competitors like Cloudinary. And it does PNG compression better than any of the free services out there, especially those with alpha channels.
       
      Installation
      Install the module like any other ProcessWire module, by either copying the folder into your modules folder or installing it via the admin. See above for downloads links on GitHub and in the module directory.
       
      Requirements
      To be able to upload images to the service, allow_url_fopen must be set on the server. The module will abort installation if that's not the case.
      I have only tested the module on ProcessWire 3.x installations. I don't see why it shouldn't work in 2.x, if anyone wants to try it out and report back.
       
      ImageOptim account
      To compress images, you first need to sign up for an ImageOptim account. They offer free trials to try the service.
       
      Usage (manual optimization)
      Images can be optimized by calling the optimize() method on any image. You can pass an options array to set ImageOptim API parameters.
      $image->size(800,600)->optimize()->url $image->optimize(['quality' => 'low', 'dpr' => 2]) // Set quality to low and enable hi-dpi mode
      Automatic optimization
      The module also has an automatic mode that optimizes all image variations after resizing. This is the recommended way to use this module since it leaves the original image uncompressed, but optimizes all derivative images.
      $image->size(800,600)->url // nothing to do here; image is optimized automatically
      To change compression setting for single images, you can pass an options array along with the standard ImageResizer options. Passing false disables optimization.
      $image->size(800, 600, ['optimize' => 'medium']) $image->size(800, 600, ['optimize' => ['quality' => 'low', 'dpr' => 2]]) $image->size(800, 600, ['optimize' => false])
      For detailed usage instructions and all API parameters, see the usage instructions on GitHub.
       
      Filenames
      Optimized images will be suffixed, e.g. image.jpg becomes image.optim.jpg. You can configure the suffix in the module settings.
       
      Roadmap
      Asynchronous processing. Not really high on the list. Image variations need to be created anyway, so waiting a few seconds longer on first load is preferable to adding complexity to achieve async optimization. Optimize image variations created by other modules. CroppableImage comes to mind. I don't use any of these, so if somebody wants to help out and submit a pull request — all for it! Add a dedicated page in the setup menu with a dashboard and detailed statistics. ImageOptim's API is very barebones for now, so not sure if that's feasible or even necessary.
      Stability
      I've been using this module on production sites for some time now, without hiccups. If you do notice oddities, feel free to comment here or investigate and submit PRs.
    • By daniels
      General
      This is a lightweight alternative to other newsletter & newsletter-subscription modules.
      It can update / create a subscriber in a list in Mailchimp with MailChimp API 3.0. It does not provide any forms or validation, so you can feel free to use your own. To protect your users, it does not save any user data in logs or sends them to an admin.
      This module fits your needs if you...
      ...use Mailchimp as your newsletter / email-automation tool ...want to let users subscribe to your newsletter on your website ...want to use your own form, validation and messages (with or without the wire forms) ...don't want any personal user data saved in any way in your ProcessWire environment (cf. EU data regulation terms) ...like to subscribe users to different lists ...like the Mailchimp UI for creating / sending / reviewing email campaigns You can find it here: https://github.com/danielstieber/SubscribeToMailchimp
      Let me know what you think and if I should add it to the Modules Directory.
      Setup
      Log into your Mailchimp account and go to  Profile > Extras > API Keys. If you don't have an API Key, create a new one. Copy your API Key and paste it in the module settings (Processwire > Modules > Site > SubscribeToMailchimp). Back in Mailchimp, go to the list, where you want your new subscribers. Go to Settings > List name and defaults. Copy the List ID an paste it in to the module settings.
      Usage
      To use the module, you need to load it into your template:
      $mc = $modules->get("SubscribeToMailchimp"); Now you can pass an email address to the module and it will try to edit (if the user exists) or create a new subscriber in your list.
      $mc->subscribe('john.doe@example.com'); You can also pass a data array, to add additional info.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe']); You can even choose an alternative list, if you don't want this subscriber in your default list.
      $mc->subscribe('john.doe@example.com', ['FNAME' => 'John', 'LNAME' => 'Doe'], 'abcdef1356'); // Subscribe to List ID abcdef1356  
      Important Notes
      This module does not do any data validation. Use a sever-sided validation like Valitron Make sure that you have set up your fields in your Mailchimp list. You can do it at Settings > List fields and *|MERGE|* tags Example
      Example usage after a form is submitted on your page:
      // ... validation of form data $mc = $modules->get("SubscribeToMailchimp"); $email = $input->post->email; $subscriber = [ 'FNAME' => $input->post->firstname, 'LNAME' => $input->post->lastname, ]; $mc->subscribe($email, $subscriber);  
      Troubleshooting
      In case of trouble check your ProcessWire warning logs.
      I can't see the subscriber in the list
      If you have enabled double opt-in (it is enabled by default) you will not see the subscriber, until he confirmed the subscription in the email sent by Mailchimp
      I get an error in my ProccessWire warning logs
      Check if you have the right List ID and API Key. Check if you pass fields, that exist in your list. Check if you pass a valid email address. Go to Mailchimps Error Glossary for more Information
      How To Install
      Download the zip file at Github or clone directly the repo into your site/modules If you downloaded the zip file, extract it in your sites/modules directory. You might have to change the folders name to 'SubscribeToMailchimp'. Goto the modules admin page, click on refresh and install it  
    • By PWaddict
      Module for hiding pages for non-superusers.
      Download
      HidePages
      Requirements
      ProcessWire 3.x Changelog
      1.0.1 (31 March 2018)
      Module renamed to prevent confusion 1.0.0 (30 March 2018)
      Initial release