wordpress插件开发

WordPress 插件开发

1. 初始化插件

• 文件头信息：每个插件都需要一个文件头，包含插件的基本信息。

  /*
  Plugin Name: My Custom Plugin
  Plugin URI: http://example.com/my-custom-plugin
  Description: A custom plugin for WordPress.
  Version: 1.0
  Author: Your Name
  Author URI: http://example.com
  */

• 命名空间和文件组织：使用命名空间来避免命名冲突，合理组织文件结构。

2. 添加激活与停用钩子

• 使用 register_activation_hook 和 register_deactivation_hook 来处理插件的激活和停用逻辑。

  register_activation_hook(__FILE__, 'my_plugin_activate');
  function my_plugin_activate() {
    // 插件激活时执行的操作
  }
  
  register_deactivation_hook(__FILE__, 'my_plugin_deactivate');
  function my_plugin_deactivate() {
    // 插件停用时执行的操作
  }

3. 添加管理页面

• 使用 add_menu_page 或 add_submenu_page 来添加自定义管理页面。

  add_action('admin_menu', 'my_plugin_add_admin_menu');
  function my_plugin_add_admin_menu() {
    add_menu_page(
        'My Plugin Settings',        // 页面标题
        'My Plugin',                 // 菜单标题
        'manage_options',            // 权限
        'myplugin-settings',         // 菜单 slug
        'my_plugin_settings_page'    // 回调函数
    );
  }
  
  function my_plugin_settings_page() {
    echo '<h1>My Plugin Settings</h1>';
    // 显示设置页面内容
  }

4. 注册设置选项

• 使用 register_setting 来注册设置选项，并通过表单保存数据。

  add_action('admin_init', 'my_plugin_register_settings');
  function my_plugin_register_settings() {
    register_setting('myplugin-settings-group', 'myplugin_option_name');
  }

5. 短代码（Shortcodes）

• 使用 add_shortcode 来创建短代码。

  add_shortcode('my_shortcode', 'my_shortcode_function');
  function my_shortcode_function($atts) {
    return 'Hello, World!';
  }

6. 小工具（Widgets）

• 创建自定义小工具。

  class My_Plugin_Widget extends WP_Widget {
    function __construct() {
        parent::__construct(
            'my_plugin_widget',       // 小工具 ID
            'My Plugin Widget',       // 小工具名称
            array('description' => 'A custom widget') // 描述
        );
    }
  
    function form($instance) {
        // 小工具配置表单
    }
  
    function update($new_instance, $old_instance) {
        // 更新小工具实例
    }
  
    function widget($args, $instance) {
        // 输出小工具内容
    }
  }
  
  add_action('widgets_init', function(){
    register_widget('My_Plugin_Widget');
  });

7. 钩子与动作

• 使用 add_action 和 do_action 来扩展或修改 WordPress 的行为。

  add_action('wp_head', 'my_custom_function');
  function my_custom_function() {
    echo '<!-- Custom code -->';
  }

8. 样式与脚本

• 使用 wp_enqueue_style 和 wp_enqueue_script 来加载样式和脚本。

  add_action('wp_enqueue_scripts', 'my_plugin_enqueue_styles');
  function my_plugin_enqueue_styles() {
    wp_enqueue_style('my-plugin-style', plugins_url('/css/style.css', __FILE__));
  }
  
  add_action('wp_enqueue_scripts', 'my_plugin_enqueue_scripts');
  function my_plugin_enqueue_scripts() {
    wp_enqueue_script('my-plugin-script', plugins_url('/js/script.js', __FILE__), array(), null, true);
  }

9. 数据库操作

• 使用 $wpdb 对象进行数据库查询。

  global $wpdb;
  $table_name = $wpdb->prefix . 'myplugin_table';
  $wpdb->insert($table_name, array(
    'column1' => 'value1',
    'column2' => 'value2'
  ));

10. 错误处理与日志记录

• 使用 WP_Error 类进行错误处理，并记录日志以便调试。

  function my_plugin_check_dependencies() {
    if (!function_exists('some_function')) {
        return new WP_Error('dependency_missing', 'Required function is missing.');
    }
  }

通过以上步骤，你可以开发一个功能完善的 WordPress 插件。