ryan

Module: Video embed for YouTube/Vimeo (TextformatterVideoEmbed)

Recommended Posts

I had several clients request a version of this module that honors the aspect ratio of a video when using the responsive embed method. For now, the module is using a hard-coded 16/9 ratio.

I decided to give it a go myself and forked Ryan's repo. I added functionality to calculate a video's aspect ratio from the oEmbed return values for width and height and made a change to the module's custom db schema to save the aspect ratio. In the (improbable) case the aspect ratio can't be determined, I added a fallback aspect ratio to the module's config. After looking around for a bit, this post about db schema updates for modules with custom databases provided excellent examples on how to handle the schema updates for existing installations. 

The changes have been tested on several live sites (3.0) and the update went without hiccups.

If anyone's interested, here's the commit: https://github.com/[...]/commit/76e9a5e7bba79aef8fae35aaa7a1b7b79e970f90

I'd love to get some feedback on this! Especially from people running this on the 2.7 or 2.8 branch.

If all works well, it'd be great to integrate this into @ryan's official repo at some point.

 

  • Like 6

Share this post


Link to post
Share on other sites

Great module @ryan :) 

Our client wants support for another video site too, though. So I'm just trying to properly create/extend a module/use hooks for the first time, so as to add an extra embed function.

Supposing I wanted to create support for an additional platform, where would I hook this into (I don't see any hookable functions other than install and uninstall in it)? Is this module extendable?

Share this post


Link to post
Share on other sites

It's such a small simple module that I think your best bet is just to edit it directly, and perhaps rename it (to avoid it potentially getting overwritten in the future). Remember to rename both the filename i.e. TextformatterMyVideoEmbed.module, and the class name to match. Then do a Modules > Refresh, and install it. 

  • Like 1

Share this post


Link to post
Share on other sites
1 minute ago, ryan said:

It's such a small simple module that I think your best bet is just to edit it directly, and perhaps rename it (to avoid it potentially getting overwritten in the future). Remember to rename both the filename i.e. TextformatterMyVideoEmbed.module, and the class name to match. Then do a Modules > Refresh, and install it. 

Okidoki, will do that instead :) Thank you.

  • Like 1

Share this post


Link to post
Share on other sites

This module sort of solves the video embed problem - thank you! - but...

1. It doesn't work in combination with HTML Entity Encoder?
2. You lose all YouTube embed customization options.

Normally I add the following to the iframe embed url:

... ?rel=0&showinfo=0&autohide=1&wmode=transparent&modestbranding=1&color=white

That removes unnecessary stuff and makes the video look less youtubey. Is there no way to do that in Processwire?

Is there really no way to force PW or the text editor to just leave iframe code alone? At least from a few trusted sources.

I have tried adding my customization to the module at return $embedCode. ..., but that doesn't work of course. It comes out like this:

Spoiler

<p><div class='TextformatterVideoEmbed' style='position:relative;padding:30px 0 56.25% 0;height:0;overflow:hidden;'><iframe style='position:absolute;top:0;left:0;width:100%;height:100%;' width="480" height="270" src="https://www.youtube.com/embed/Wl4XiYadV_k?feature=oembed" frameborder="0" allowfullscreen></iframe>?rel=0&showinfo=0&autohide=1&wmode=transparent&modestbranding=1&color=white</div></p>

 

 

Share this post


Link to post
Share on other sites
4 minutes ago, modifiedcontent said:

...Is there really no way to force PW or the text editor to just leave iframe code alone? At least from a few trusted sources.

I am not sure whether this is relevant in your case and it is from a while back but just thought to post to see if it helps:

 

  • Like 2

Share this post


Link to post
Share on other sites

I haven't tried it, but check out this module that allows you to customize the embedded video's settings: 

And regarding this: " It doesn't work in combination with HTML Entity Encoder" - try changing the order of the text formatters.

  • Like 1

Share this post


Link to post
Share on other sites

I would like to combine the module with lazysizes. Is there a way to replace "src" with "data-src" ?

Share this post


Link to post
Share on other sites

@gar1606just make sure to do a modules refresh and look under new modules

Share this post


Link to post
Share on other sites
15 hours ago, PWaddict said:

I would like to combine the module with lazysizes. Is there a way to replace "src" with "data-src" ?

I found a way how to apply lazysizes. Sharing it here in case anyone wants to do the same thing. With the below javascript code you are replacing iframe's "src" with "data-src" and of course adding the lazyload class and you are 100% ready :)

var iframeEl = document.getElementsByTagName('iframe');
for (var i=0; i<iframeEl.length; i++) {
    if(iframeEl[i].getAttribute('src')) {
       iframeEl[i].setAttribute('data-src',iframeEl[i].getAttribute('src'));
       iframeEl[i].removeAttribute('src');
    }
}

$('iframe').addClass('lazyload');

 

Share this post


Link to post
Share on other sites

I don't think this is a good solution. By the time your Js runs the iframe may start to load so making it useless.

I think it would be better to edit the module itself, and maybe rename the module to avoid overwrite it later when updating. Or even better, submit a PR with a new setting for lazy load :)

  • Like 2

Share this post


Link to post
Share on other sites

@PWaddict

I also think you shouldn't use javascript, instead do the formatting on the server. I feel I wouldn't trust the JS solution because it might not work as expected under certain circumstances.

I put together a regular expression which might help you build another Textformatter which replaces "src" with "data-src" if thats the only thing to do:

Have a look at the demo here: http://www.phpliveregex.com/p/jkp (On the right, click on preg_replace to see the replacement.)

This is the code:

<?php
preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $input_lines);

(During my research I learned from: http://stackoverflow.com/questions/4898192/preg-replace-how-to-replace-only-matching-xxx1yyy-pattern-inside-the-selector)

Hope that helps,
if you need more advice you can also DM me and we will post the result later -

cheers!

PS:

Or like @tpr mentioned you may put that modification directly into a copy of TextformatterVideoEmbed. That way you would have more control. (TextformatterVideoEmbed itself gets the embed code from an oembed url, so you can't easily intercept there ...)

PPS:

Oh, actually a simple str_replace("src=", "data-src=", $embedCode) in a copy of TextformatterVideoEmbed might actually be sufficient!

  • Like 3

Share this post


Link to post
Share on other sites

Thanks @tpr & @blynx for the help.

I replaced the 129 line of the module with this and it's working:

$out = preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $out);
$out = str_ireplace('<iframe ', "<iframe class='lazyload' style='position:absolute;top:0;left:0;width:100%;height:100%;' ", $out);

BUT on some fields I'm using the TextformatterMakeLinks module and the videos on that fields aren't loading cause it adds the video links with href inside of data-src.

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, PWaddict said:

BUT on some fields I'm using the TextformatterMakeLinks module and the videos on that fields aren't loading cause it adds the video links with href inside of data-src.

Maybe changing the order of the Textformatters would help? (Putting TextformatterMakeLinks at the bottom / after VideoEmbed)?

Share this post


Link to post
Share on other sites
1 hour ago, blynx said:

Maybe changing the order of the Textformatters would help? (Putting TextformatterMakeLinks at the bottom / after VideoEmbed)?

On that order I have it and it doesn't work.

Share this post


Link to post
Share on other sites

TextformatterMakeLinks thinks the iframe with the data-src attribute is a text to parse for links. (http://www.phpliveregex.com/p/jkU) It does not get caught by the first regular expression there ...

Either that bug has to be fixed (huh, thats a rather long reg-exp there -.-) - try to contact @interrobang there:

Or you could seperate this 

preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $out)

into a new Textformatter and use the original VideoEmbed again.
Then, the order should be:

VideoEmbed
MakeLinks
ThatFormatterWhichMakesTheDataSrc

I think this should work, since MakeLinks detects "src" in an iframe correctly - but not "data-src"

Good luck :)

Share this post


Link to post
Share on other sites

@blynx Actually I've unistalled TextformatterMakeLinks cause I don't really need it so problem solved. Thanks again for the help.

@ryan Can you update the module with a new option for lazy load? On the module config there must be 2 new fields. A checkbox field for the lazy loading option and a text field with the css class name from the lazy script used. Eg. I'm using lazysizes so the class name is lazyload.

Here is the replaced code on the 129 line of the module:

$out = preg_replace("/(<iframe.*)src(.*)(youtube|vimeo)/", "$1data-src$2$3", $out);
$out = str_ireplace('<iframe ', "<iframe class='lazyload' style='position:absolute;top:0;left:0;width:100%;height:100%;' ", $out);

 

Share this post


Link to post
Share on other sites

Hi, i need youtube video id 

Is there any way to get this id from template file.?

I was looking into TextformatterVideoEmbed.module file

public function format(&$str) {
		$this->embedYoutube($str);
		$this->embedVimeo($str);
	}

	/**
	 * Check for Youtube URLS and embed when found
	 *
	 */
	protected function embedYoutube(&$str) {

		// perform a strpos fast check before performing regex check
		if(strpos($str, '://www.youtube.com/watch') === false && strpos($str, '://www.youtube.com/v/') === false && strpos($str, '://youtu.be/') === false) return;

		//               1: full URL                                                 2:video id    3: query string (optional)
		$regex = '#<p>\s*(https?://(?:www\.)?youtu(?:.be|be.com)+/(?:watch/?\?v=|v/)?([^\s&<\'"]+))(&[-_,.=&;a-zA-Z0-9]*)?.*?</p>#';
		if(!preg_match_all($regex, $str, $matches)) return;

		foreach($matches[0] as $key => $line) { 

			$oembedURL = 
				"$this->http://www.youtube.com/oembed?url=" . urlencode($matches[1][$key]) . 
				"&format=json&maxwidth={$this->maxWidth}&maxheight={$this->maxHeight}"; 

			$videoID = $matches[2][$key]; 
			$queryString = isset($matches[3][$key]) ? $matches[3][$key] : '';
			$embedCode = $this->getEmbedCode($oembedURL, $videoID); 

 

Can i use something like below  from my template file

$page->video->$videoID;

 

There are hundreds of youtube video fields  entered with TextformatterVideoEmbed module . And i can not get these url with 

Quote

echo $page->video;

because it embed iframe and shows youtube video not the url

If i can grab video url i can get the id from there.

I want to keep working this way but i need this url or video id for use on amp-youtube tag

Share this post


Link to post
Share on other sites

Videos not showing up.:'(

PW Version: 3.0.57

TextformatterVideoEmbed Version: 1.1.1

The module is installed. I have added the "Video embed for YouTube/Vimeo" Text formatter to the body field. I put a link with the format "https://www.youtube.com/watch?v=xxxxxx" into the body surrounded by <p></p> tags. However, when I view the site, I just see the text for the link.

What am I missing?

Thanks!

Share this post


Link to post
Share on other sites
3 hours ago, artaylor said:

Videos not showing up.:'(

PW Version: 3.0.57

TextformatterVideoEmbed Version: 1.1.1

The module is installed. I have added the "Video embed for YouTube/Vimeo" Text formatter to the body field. I put a link with the format "https://www.youtube.com/watch?v=xxxxxx" into the body surrounded by <p></p> tags. However, when I view the site, I just see the text for the link.

What am I missing?

Thanks!

Make sure your link added as plain text not as clickable link. Also try chaning the order of the text formatters. "Video embed for YouTube/Vimeo" should be on top.

Share this post


Link to post
Share on other sites

@PWaddict: Thanks. The link is plain text and "Video embed..." is the first text formatter. I tried removing the Hanna Code textformatter to see if it was causing a conflict but it still did not work.

 

 

Share this post


Link to post
Share on other sites
15 minutes ago, artaylor said:

@PWaddict: Thanks. The link is plain text and "Video embed..." is the first text formatter. I tried removing the Hanna Code textformatter to see if it was causing a conflict but it still did not work.

 

 

Is the field textarea? Is the Inputfield Type: CKEditor?

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
      MediaLibrary
      Update: MediaLibrary can now be found in the official module list.
      Out of necessity, I've started to implement a simple media library module.
      The basic mechanism is that it adds a MediaLibrary template with file and image fields. Pages of this type can be added anywhere in the page tree.
      The link and image pickers in CKEditor are extended to allow quick selection of library pages from dropdowns. In the link picker this happens in the MediaLibrary tab, where you can also see a preview of the selected image. In the image picker, simply select a library from the dropdown at the top, everything else is handled by standard functionality.
      I've put the code onto github. This module is compatible with ProcessWire 3.
      Steps to usage:
      Download the module's zip from github (switch to the pw3 branche beforehand if you want to test on PW 3.x) and unpack it into site/modules Click "Modules" -> "Refresh" in the admin Click "Install" for MediaLibrary For testing, create a page with the MediaLibrary template under home (give it an expressive title like 'Global Media') and add some images and files Edit a differnt page with a CKEditor field and add a link and an image to see the MediaLibrary features in action (see the screencap for details) Optionally, go into the module settings for MediaLibrary Note: this module is far from being as elaborate as Kongondo's Media Manager (and doesn't plan to be). If you need a feature-rich solution for integrated media management, give it a look.
      Feel free to change the settings for MediaFiles and MediaImages fields, just keep the type as multiple.
      There are some not-so-pretty hacks for creating and inserting the correct markup, which could probably be changed to use standard input fields, though I'm a bit at a loss right now how to get it to work. I've also still got to take a look at error handling before I can call it fit for production. All feedback and pointers are appreciated (that's also why I post this in the development section).

      Edit 09.03.2016 / version 0.0.4: there's now also a "Media" admin page with a shortcut to quickly add a new library.

      Edit 01.05.2016:
      Version 0.0.8:
      - The module now supports nested media libraries (all descendants of eligible media libraries are also selectable in link/image picker).
      - There's a MediaLibrary::getPageMediaLibraries method you can hook after to modify the array of available libraries.
      - You can switch between (default) select dropdowns or radio boxes in the module configuration of MediaLIbrary to choose libraries.
      Edit 10.10.2018:
      Version 0.1.3:
      - Dropped compatibility for ProcessWire legacy versions by adding namespaces
      - Allow deletion of libraries from the Media overview admin page
      - Added an option to hide media libraries from the page tree (optionally also for superusers)
    • By Robin S
      This module corrects a few things that I find awkward about the "Add New Template" workflow in the PW admin. I opened a wishlist topic a while back because it would good to resolve some of these things in the core, but this module is a stopgap for now.
      Originally I was going to share these as a few standalone hooks, but decided to bundle them together in a configurable module instead.
      Add Template Enhancements
      A module for ProcessWire CMS/CMF. Adds some efficiency enhancements when adding or cloning templates via admin.

      Features
      Derive label from name when new template added: if you like to give each of your templates a label then this feature can save some time. The label can be added automatically when templates are added in admin, in admin/API, or not at all. There are options for underscore/hyphen replacement and capitalisation of the label. Edit template after add: when adding only a single template, the template is automatically opened for editing after it is added. Copy field contexts when cloning: this copies the field contexts (a.k.a. overrides such as column width, label and description) from the source template to the new template when using the "Duplicate/clone this template?" feature on the Advanced tab. Copy field contexts when duplicating fields: this copies the field contexts if you select the "Duplicate fields used by another template" option when adding a new template. Usage
      Install the Add Template Enhancements module.
      Configure the module settings according to what suits you.
       
      https://github.com/Toutouwai/AddTemplateEnhancements
      https://modules.processwire.com/modules/add-template-enhancements/
    • By Mike Rockett
      As I mentioned in this issue, I've create a new textformatter for ParsedownExtraPlugin, which adds some oomph to your markdown.
      Repo: Parsedown Extra Plugin
      Unlike the built-in textformatter for Parsedown and Parsedown Extra, this should be used when you want to use Extra with additional configuration/customisation.
      Some examples:
      ### Test {.heading} - A [external link](https://google.com/){.google} with `google` as a class that opens in a new tab if the config property is set. - [Another link](/page){target=_blank} that opens in a new tab even though it isn't external. ```html .html <p>Test</p> ``` There's some config options available to you, such as setting attributes on all/external images and links, setting table and table-cell alignment classes, adjusting footnote classes and IDs, adding <code> attributes to their parent <pre> elements, and changing the <code> class if your syntax highlighter does not use language-*.
      I was thinking about adding the ability to make links open in a new tab by appending a plus to the link syntax, but only external links should be opening in a new tab anyway. Further, this would add extra, unnecessary processing time.
      Please let me know if you bump into any problems. ☺️
    • By Mike Rockett
      TextformatterTypographer (0.4.0 Beta)
      A ProcessWire wrapper for the awesome PHP Typography class, originally authored by KINGdesk LLC and enhanced by Peter Putzer in wp-Typography. Like Smartypants, it supercharges text fields with enhanced typography and typesetting, such as smart quotations, hyphenation in 59 languages, ellipses, copyright-, trade-, and service-marks, math symbols, and more.
      Learn more on my blog
      It's based on the PHP-Typography library found over at wp-Typography, which is more frequently updated and feature rich that its original by KINGdesk LLC.
      The module itself is fully configurable. I haven't done extensive testing, but there is nothing complex about this, and so I only envisage a typographical bug here and there, if any.
      Please do test it out and let me know what you think.
      Also note that I have indicated support for PW 2.8, but I haven't tested there as yet. This was built on PW 3.0.42/62.
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.50
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy!