Wordpress用get_current_screen函数来选择性加载插件中的JS和CSS

简介:

很多人都说过,“一个良好的 WordPress 使用者只加载他们需要的文件。” 这个原则既适用于前端,也适用于后端。当你只是想 CSS 和 JS 出现在你所创建的那个页面,就没有必要在后台也加载了。

“绝对不要在所有的管理界面上都允许 CSS 和 JS 文件,这会引起与其他插件的冲突。”

WordPress 函数就能解决这个问题

几乎所有的管理员页面都有一个唯一的 URL,所以要做到在需要的页面上加载 JS 和 CSS 文件并不难。可以使用 $_SERVER['REQUEST_URI'] 或者是 $_GET['action'] 参数。其实还有一种更快捷,简单而又标准化的方式来实现这个目的。那就是 get_current_screen 函数。

关于 get_current_screen function 你需要了解的事情

  • 是在 WordPress 3.1 引入的,所以如果你在更旧版本上使用,会返回 call to undefined function 错误。如果不确定,可以用 function_exists 函数来检查一下是否可用。
  • 在 admin_init 和 init 挂钩上不可用。因为这是在那些挂钩请求之后才会初始化的。
  • 这个函数会返回 一个包含很多信息的叫 WP_Screen 的目标,但是我们需要的只是上面的 id 。
  • 在后端不可用。

几行代码就能使之大不相同

我们假设你的插件在设置菜单下有一个选项页面你是用下面这行代码写的:

add_options_page('My Plugin', 'My Plugin', 'manage_options', 'my_plugin', 'my_plugin_options');

此时,你需要添加额外的 CSS 和 JavaScript 到这个页面,代码如下:

复制代码
// Bad code below! Don't copy/paste!
add_action('admin_enqueue_scripts', 'my_plugin_scripts');
 
function my_plugin_scripts() {
    wp_enqueue_style('farbtastic');
    wp_enqueue_script('farbtastic');
}
复制代码

 

上面是个很糟糕的方案,不要那样做。上面一段代码会让包含 CSS 和 JS 的 Farbtastic 颜色选择器出现在管理员界面的每一页。如果别的插件不需要你的 CSS 和 JS, 他们就必须用 wp_dequeue_* 函数来移除。这很没有必要而且很鲁莽,因为这是可以有更好的代码的。代码如下:

复制代码
add_action('admin_enqueue_scripts', 'my_plugin_scripts');
 
function my_plugin_scripts() {
    // Include JS/CSS only if we're on our options page
    if (is_my_plugin_screen()) {
        wp_enqueue_style('farbtastic');
        wp_enqueue_script('farbtastic');
    }
}
 
// Check if we're on our options page
function is_my_plugin_screen() {
    $screen = get_current_screen();
    if (is_object($screen) && $screen->id == 'settings_page_my_plugin') {
        return true;
    } else {
        return false;
    }
}
复制代码

 

要实现这个功能很简单

使用 get_current_screen 函数来选择性加载 JS 和 CSS

如果你看到上图我们写的改进的代码,你会发现只加了一个 if 语句以及一个简单的函数 is_my_plugin_screen(这是用来确认是否打开的是插件选项页面)。控制 WP_Screen 的变量 $screen 有很多属性值,但是我们感兴趣的就只有 id 。这个 id 有一个 前缀 settings_page_,该前缀在所有的设置页面都是一样的。而字符串 my_plugin 是唯一的,因为我们在调用 add_options_page 函数的时候把它定位为第四个参数了。

代码很简单而且在所有的管理员界面都适用。可以很方便的看见转存到 $screen 的 id 是什么

echo '<pre>' . print_r(get_current_screen(), true) . '</pre>';
 

总结

  • 1、不要在所有的管理页面上都加载 CSS 或 JS 文件。这会引起与其他插件的冲突。
  • 2、在 init 函数之后使用 get_current_screen 来识别你的管理界面什么时候是可见的,可见的时候加载额外的东西。
  • 3、核心管理页面的 ID 可在 Codex 的这个页面上找到 Admin Screen Reference 。
  • 4、不要引用 <script> 或者 <style> 标签;要用 wp_enqueue_* 函数。
  • 5、先到 Codex 检查是不是你的脚本已经在 WP core 上面了。

原文:Quick Tip: Conditionally Including JS and CSS With get_current_screen

本文由 CloudCheung 翻译,转载请以可点击的超链接形式注明源地址。




本文转自黄聪博客园博客,原文链接:http://www.cnblogs.com/huangcong/archive/2013/03/23/2977349.html,如需转载请自行联系原作者

相关文章
|
4天前
|
JavaScript
浏览器插件crx文件--JS混淆与解密
浏览器插件crx文件--JS混淆与解密
11 0
|
22天前
|
JavaScript
变量和函数提升(js的问题)
变量和函数提升(js的问题)
|
22天前
|
JavaScript
常见函数的4种类型(js的问题)
常见函数的4种类型(js的问题)
11 0
|
23天前
|
JavaScript
写一个函数将N组<>(包含开始和结束),进行组合,并输出组合结果 (js)
写一个函数将N组<>(包含开始和结束),进行组合,并输出组合结果 (js)
9 0
|
1月前
|
自然语言处理 JavaScript 网络架构
js开发:请解释什么是ES6的箭头函数,以及它与传统函数的区别。
ES6的箭头函数以`=&gt;`定义,简化了函数写法,具有简洁语法和词法作用域的`this`。它无`arguments`对象,不能用作构造函数,不支持`Generator`,且不改变`this`、`super`、`new.target`绑定。适用于简短表达式,常用于异步编程和高阶函数。
18 5
|
2天前
|
JavaScript 前端开发
js开发:请解释什么是ES6的Generator函数,以及它的用途。
ES6的Generator函数是暂停/恢复功能的特殊函数,利用yield返回多个值,适用于异步编程和流处理,解决了回调地狱问题。例如,一个简单的Generator函数可以这样表示: ```javascript function* generator() { yield &#39;Hello&#39;; yield &#39;World&#39;; } ``` 创建实例后,通过`.next()`逐次输出&quot;Hello&quot;和&quot;World&quot;,展示其暂停和恢复的特性。
12 0
|
4天前
WP-AutoPostPro WordPress自动采集发布插件
WP-AutoPostPro 是目前最好用的WordPress自动采集发布插件,最大的特点是可以采集来自于任何网站的内容并自动发布到你的WordPress站点。真正做到可以采集任何网站的内容并自动发布,采集过程完全自动进行无需人工干预,并提供内容过滤、HTML标签过滤、关键词替换、自动链接、自动标签、自动下载远程图片到本地服务器、自动添加文章前缀后缀、并且可以使用微软翻译引擎将采集的文章自动翻译为各种语言进行发布。
12 0
|
9天前
|
缓存 JavaScript 前端开发
js的入口函数,入口函数的作用
js的入口函数,入口函数的作用
15 4
|
17天前
|
JavaScript 前端开发
EasyUi js 加载数据表格DataGrid
EasyUi js 加载数据表格DataGrid
|
22天前
|
JavaScript
理解DOM树的加载过程(js的问题)
理解DOM树的加载过程(js的问题)
10 0