wordpress教程随笔

获取文件路径
plugin_dir_path($file);
获取插件目录
plugin_dir_path(__FILE__)

常见路径函数

plugins_url

plugins_url($path, $plugin )
— 插件目录的 URL (例如:http://example.com/wp-content/plugins)
$path — (string)(可选) — 相对于 插件 URL 的路径
$plugin — (string)(可选) — 要相对的插件文件(如果是自己,就传 __FILE__ )
支持 mu — 插件的插件目录。
自动检测 SSL,所以如果 SSL 被开启,那么 URL 会自动返回包含 https 的。
使用 WP_PLUGIN_URL 常量,意味着即使用户把插件移动到了自定义的位置,也可以检测到插件的目录。
使用 WPMU_PLUGIN_URL 常量来支持 Multisite
include_url()
— includes 目录的 URL (例如:http://example.com/wp-includes)
content_url()
— content 目录的 URL (例如:http://example.com/wp-content)
admin_url()
— admin 目录的 URL (例如:http://example.com/wp-admin/)
site_url()
— 当前网站的 URL (例如:http://example.com),返回的是数据库中 wp_options 表里面的 siteurl 字段值
home_url()
— 当前网站首页的 URL (例如:http://example.com),返回的是wp_option 表中取得 home 字段的值

activate/deactivate

activation
启动时执行
register_activation_hook( $file, $function );
  • $file — (string)(必须) — 主插件文件的路径。
  • $function — (string)(必须) — 当插件启用时要执行的函数。
案例
<?php register_activation_hook( __FILE__, ‘boj_myplugin_install’); function boj_myplugin_install() { // 启用时要做的事情  } ?>
deactivate
禁用时执行
register_deactivation_hook( $file, $function );
  • $file — (string)(必须) — 主插件文件的路径。
  • $function — (string)(必须) — 当插件禁用时要执行的函数。
案例
<?php register_deactivation_hook( __FILE__, ‘boj_myplugin_uninstall’ ); function boj_myplugin_unstall() { // 执行内容 } ?>

  卸载

uninstall.php文件卸载

<?php // 如果 uninstall 不是从 WordPress 调用,则退出 if( !defined( ‘WP_UNINSTALL_PLUGIN’ ) ) exit(); // 从 options 表删除选项 delete_option( ‘boj_myplugin_options’ ); // 删除其他额外的选项和自定义表 ?>

卸载钩子

register_uninstall_hook( $file, $function );
  • $file — (string)(必须) — 插件主文件的路径
  • $function — (string)(必须) — 在插件卸载后要执行的函数
案例
<?php register_activation_hook( __FILE__, ‘boj_myplugin_activate’ ); function boj_myplugin_activate() { // 注册卸载函数 register_uninstall_hook( __FILE__, ‘boj_myplugin_uninstaller’ ); } function boj_myplugin_uninstaller() { // 删除插件创建的选择,表等等 delete_option( ‘boj_myplugin_options’ ); } ?>

register_uninstall_hook() 必须在启用函数中调用

插件开发检查列表

在开发 WordPress 插件时,你需要记住许多事情来创建一个合适的插件基础。下面的列表帮助你完成这个过程。跟随这个列表,你就可以确保有一个合适的插件基础了:

  1. 确定一个具有描述性的唯一的插件名
    1. 名字是否可以描述你的插件的功能
    2. 是否验证了插件名在插件目录中不存在
  2. 为插件设置一个唯一的前缀
    1. 前缀是否足够特殊来避免冲突
  3. 建立插件的目录结构
    1. 是否需要 PHP 目录
    2. 是否需要 JavaScript 目录
    3. 是否需要 CSS 目录
    4. 是否需要 images 目录
  4. 建立默认的插件文件
    1. 建立和插件文件夹名同名的主插件文件
    2. 建立 uninstall.php 文件来执行卸载过程
  5. 建立插件的头部代码
    1. 设置你希望显示的插件的名字
    2. 添加一个详细的插件目的的描述
    3. 设置正确的版本
    4. 确保设置了插件的 URI 和 作者的 URI 的值
  6. 包括版权信息
    1. 在插件头下面直接包含版权信息
  7. 建立插件的启用函数
    1. 你的插件功能的实现是否需要一个特殊的或者更高的 WordPress?
    2. 你的插件是否要在启用时设置默认值?
  8. 建立插件的禁用函数
    1. 你的插件是否要在禁用时执行神马东西?
  9. 建立插件的卸载脚本
    1. 建立 uninstall.php 文件
    2. 在文件中包含卸载脚本
  10. 文件引用
    1. 使用合适的目录常量和函数来确定 WordPress 和插件中的路径
发表评论 0

Your email address will not be published. Required fields are marked *