hametuha / wp-enqueue-manager
一个用于批量注册资产的WordPress库。
1.2.1
2024-09-13 09:06 UTC
Requires
- php: >=7.2
- hametuha/string-utility: ^1.2
Requires (Dev)
README
以指定文件夹结构批量注册WordPress资产。对于主题开发是一个很好的快捷方式。
安装
使用composer。
composer require hametuha/wp-enqueue-manager
用法
在您的资产(js和css)的头部以注释形式写入依赖项。格式如下:wpdeps=dependencies。CSV格式。
这种表示法将用于wp_register_script(文档)和wp_register_style(文档)的deps参数。
操作应在init钩子或之前完成。在您的functions.php中编写代码。
JavaScript
头部文件应如下所示
/*! * wpdeps=jquery,thicbox */ jQuery(document).ready(function($){ // Do something. });
注意:如果您使用autoprefixer或minify工具,请小心清理注释。
然后,从您的主题或插件中注册它们。
// Register all js in folder. // e.g. /assets/js/sample.js will be regsitered as 'my-sample'. Hametuha\WpEnqueueManager::register_js( __DIR__ . '/assets/, 'my-', '1.0.0' );
样式表
与JavaScript相同,注册
/*! * wpdeps=bootstrap */ body{ background-color: red; }
然后运行register_styles。
// Register all css in folder. // e.g. /assets/css/sample.css will be regsitered as 'my-sample'. Hametuha\WpEnqueueManager::register_styles( __DIR__ . '/assets/, 'my-', '1.0.0' );
版本控制
如果您是主题或插件作者,传递您主题/插件的版本是合适的。懒惰的作者可能只会传递null或跳过参数。然后,将使用文件修改时间作为版本字符串。
本地化
对于JavaScript本地化,您可以批量注册本地化变量。
Hametuha\WpEnqueueManager::register_js_var_files( __DIR__ . '/l10n );
文件名等于js处理名。驼峰式处理名应该是变量名。PHP文件应返回变量数组。
例如,如果您在l10n目录下放置以下my-sample.php。
<?php // Avoide direct load. defined( 'ABSPATH' ) || die(); // Return JS vars. return [ 'label' => 'This is my var!', ];
注册信息如下
- 处理: my-sample
- 变量名: MySample
- 变量:文件返回的数组。
因此,您可以像这样从JS中引用PHP变量
$('.button').on('click', function(){ alert(MySample.label); // => This is my var! };
许可协议
MIT。