Adding a library without a version number causes 'Undefined index: version in drupal_get_library()'

Open on Drupal.org →

Created on 31 January 2014, almost 11 years ago

Updated 10 June 2024, 7 months ago

drupal_get_library() will cause the following PHP notice if the library you are trying to get does not have an associated version number.

Notice: Undefined index: version in drupal_get_library() (line 4765 of /includes/common.inc).

What are the steps required to reproduce the bug?

Create a Drupal library by implementing hook_library(). Nothing that I saw in the documentation indicates that a library requires a version number.
Load the library either by calling drupal_add_library() or drupal_get_library() (drupal_add_library calls drupal_get_library.)

What behavior were you expecting?

The documentation for hook_library() says that the library may contain a version. Therefore I didn't expect to run into any issues if I didn't include a version in the library I was adding.

What happened instead?

drupal_get_library() assumes that the library has a version and if it doesn't causes a PHP notice.

The drupal_get_library() function starts at line 4748 of common.inc and it includes the following lines (4764 - 4766):

        foreach ($module_libraries[$key]['js'] as $file => $options) {
          $module_libraries[$key]['js'][$file]['version'] = $module_libraries[$key]['version'];
        }

Proposed resolution

I'm proposing one of the following two solutions:

1. Add an isset() check to drupal_get_library()

I've attached a patch for this. One possible issue with this approach is that it might cause problems for downstream code that assumes the loaded library will have a version for each javascript file.

2. Change the hook_library() documentation to make version mandatory

🐛 Bug report

Status

Needs work

Version

7.0 ⚰️

Component

Asset library →

Last updated 7 days ago

No maintainer

Created by

🇨🇦Canada Dave Bagler

Live updates comments and jobs are added and updated live.

Incomplete comments

Sign in to follow issues

Merge Requests

!8328Adding a library without a version number causes 'Undefined index: version in drupal_get_library()'
Open
🇮🇳India immaculatexavier
updated 7 months ago

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Comment 7 months ago →
🇸🇰Slovakia poker10
Thanks for working on this. There are contrib modules expecting the ['version'] array key from drupal_get_library(). I think the better approach is to return empty version in case the key is not present, but not omit the key, as the current patch #4 does.
First commit to issue fork.
Merge request !8328Update file common.inc → (Open) created by immaculatexavier
Open in Jenkins → Open on Drupal.org →
Environment: PHP 8.1 & MySQL 5.7
last update 7 months ago
2,184 pass
Pipeline finished with Success
7 months ago
Total: 263s
#193569
Status changed to Needs review 7 months ago11:23am 7 June 2024
Open in Jenkins → Open on Drupal.org →
Environment: PHP 8.1 & MySQL 5.7
last update 7 months ago
2,184 pass
Comment 7 months ago →
🇮🇳India immaculatexavier
Status changed to Needs work 7 months ago9:13am 10 June 2024
Comment 7 months ago →
🇸🇰Slovakia poker10
Thnaks for creating the MR. I think we need to fix this in drupal_get_library(), not in drupal_add_library(), so that we cover all usages across core/contribs.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024