automattic / jetpack-assets
Asset management utilities for Jetpack ecosystem packages
Installs: 1 070 032
Dependents: 29
Suggesters: 0
Security: 0
Stars: 3
Watchers: 4
Forks: 3
Type:jetpack-library
Requires
- php: >=7.2
- automattic/jetpack-constants: ^3.0.1
Requires (Dev)
- automattic/jetpack-changelogger: ^5.1.0
- brain/monkey: ^2.6.2
- wikimedia/testing-access-wrapper: ^1.0 || ^2.0 || ^3.0
- yoast/phpunit-polyfills: ^1.1.1
Suggests
- automattic/jetpack-autoloader: Allow for better interoperability with other plugins that use this package.
- dev-trunk / 4.0.x-dev
- v4.0.2
- v4.0.1
- v4.0.0
- v3.0.0
- v2.3.14
- v2.3.13
- v2.3.12
- v2.3.11
- v2.3.10
- v2.3.9
- v2.3.8
- v2.3.7
- v2.3.6
- v2.3.5
- v2.3.4
- v2.3.3
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.0
- v2.1.13
- v2.1.12
- v2.1.11
- v2.1.10
- v2.1.9
- v2.1.8
- v2.1.7
- v2.1.6
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- v2.0.4
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v1.18.15
- v1.18.14
- v1.18.13
- v1.18.12
- v1.18.11
- v1.18.10
- v1.18.9
- v1.18.8
- v1.18.7
- v1.18.6
- v1.18.5
- v1.18.4
- v1.18.3
- v1.18.2
- v1.18.1
- v1.18.0
- v1.17.34
- v1.17.33
- v1.17.32
- v1.17.31
- v1.17.30
- v1.17.29
- v1.17.28
- v1.17.27
- v1.17.26
- v1.17.25
- v1.17.24
- v1.17.23
- v1.17.22
- v1.17.21
- v1.17.20
- v1.17.19
- v1.17.18
- v1.17.17
- v1.17.16
- v1.17.15
- v1.17.14
- v1.17.13
- v1.17.12
- v1.17.11
- v1.17.10
- v1.17.9
- v1.17.8
- v1.17.7
- v1.17.6
- v1.17.5
- v1.17.4
- v1.17.3
- v1.17.2
- v1.17.1
- v1.17.0
- v1.16.2
- v1.16.1
- v1.16.0
- v1.15.0
- v1.14.0
- v1.13.1
- v1.13.0
- v1.12.0
- v1.11.10
- v1.11.9
- v1.11.8
- v1.11.7
- v1.11.6
- v1.11.5
- v1.11.4
- 1.11.3
- v1.11.2
- v1.11.1
- v1.11.0
- v1.10.0
- v1.9.1
- v1.9.0
- v1.8.0
- v1.7.0
- v1.6.0
- v1.5.0
- v1.4.0
- v1.3.0
- v1.2.0
- v1.1.1
- v1.1.0
- v1.0.3
- v1.0.1
- v1.0.0
- dev-prerelease
- dev-fix/slack-workflow-branch-detection
- dev-fix/release-branch-typo
- dev-update/generate-branch-plugin
- dev-release-v1.11.2
- dev-release-v1.11.1
- dev-feature/reorg
- dev-release-v1.11.0
- dev-release-v1.10.0
- dev-release-v1.9.1
- dev-release-v1.9.0
- dev-release-v1.8.0
- dev-release-v1.7.0
- dev-release-v1.6.0
- dev-release-v1.5.0
- dev-release-v1.4.0
- dev-release-v1.3.0
- dev-release-v1.2.0
This package is auto-updated.
Last update: 2024-12-23 00:35:26 UTC
README
A package containing functionality to improve loading of assets (scripts, etc).
Includes manipulation of paths, enqueuing async scripts, and DNS resource hinting.
Usage
::get_file_url_for_environment( $min_path, $non_min_path, $package_path )
-- This is similar toplugins_url()
, but chooses between$min_path
and$non_min_path
based on the constantSCRIPT_DEBUG
. The filterjetpack_get_file_for_environment
may be used to control the returned URL.::add_resource_hint( $urls, $type )
-- Adds domains (string or array) to the WordPress' resource hinting. Accepts type of dns-prefetch (default), preconnect, prefetch, or prerender.::normalize_path( $path )
-- Normalize.
and..
components in a path or URL.::register_script( $handle, $path, $relative_to, $options )
-- Register a Webpack bundled script and styles using data produced by@wordpress/dependency-extraction-webpack-plugin
. This replaces reading the.asset.php
file and then making calls towp_register_script()
,wp_register_style()
(with a potentially varying filename based onis_rtl()
), andwp_set_script_translations()
. See the inline documentation for details.::enqueue_script( $handle )
-- Enqueue a script and style previously registered with::register_script()
.::alias_textdomains_from_file( $file )
-- Use data recorded by automattic/jetpack-composer-plugin to enable use of translations for shared Composer libraries.::alias_textdomains( $from, $to, $totype, $ver )
-- Manually add a textdomain alias, if for some reason::alias_textdomains_from_file()
is insufficient.
The Assets package also provides a wp-jp-i18n-loader
script to support Webpack lazy-loaded bundles using @automattic/i18n-loader-webpack-plugin. No initialization is required, other than calling ::alias_textdomains_from_file()
or ::alias_textdomains()
if said bundles are coming from shared Composer libraries.
Testing
$ composer run phpunit
Using this package in your WordPress plugin
If you plan on using this package in your WordPress plugin, we would recommend that you use Jetpack Autoloader as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.
Security
Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.
License
jetpack-assets is licensed under GNU General Public License v2 (or later)