WordPress插件开发笔记(三):初始化插件设置

在插件开发中, 我们可能有一些选项有默认值. 那么此时就需要把这个默认值在启用插件时写入到数据库. 下面, 我们将

• 所有的选项都添加到一个数组. 这样的好处是可以减少数据库查询的次数.
• 而且要求在启用插件时初始化该数组.
• 最后, 我们还在卸载插件时删除该数组.

我们主要修改的地方是latex2html.php中的on_activation():

    public static function on_activation()
    {
      if ( !current_user_can('activate_plugins') )
        return;
      $plugin = isset ( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
      check_admin_referer( "activate-plugin_{$plugin}" );

      /**
       * Initialize the setting options
       */
      add_option( 'l2h_options', []);
      include_once( dirname( __FILE__).'/default_options.php' );
      # Uncomment the following line to see the function in action
      # exit ( var_dump( $_GET ) );
    }

这里, 我们主要就是向wp_options数据表中添加了一条记录:l2h_options, 其值为空. 稍后我们将在文件default_options.php中设置具体的值.

在此之前, 我们先向on_uninstall()添加一句卸载该记录的语句:

    public static function on_uninstall()
    {
      if ( !current_user_can( 'activate_plugins' ) )
        return;
      check_admin_referer( 'bulk-plugins' );

      // Important: Check if the file is the one
      // thatn was registered during the uninstall hook.
      if ( __FILE__ != WP_UNINSTALL_PLUGIN )
        return;

      /**
       * Remove the option setting in /default_options.php
       */
      delete_option( 'l2h_options' );
      # Uncomment the following line to see the function in action
      # exit( var_dump( $_GET ) );
    }

最后, 我们的设置选项默认值都在includes/default_options.php中:

<?php
/**
 * The default options
 */
$mathjax_cdn = "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_SVG.js";
$mathjax_config= <<<EOF
MathJax.Hub.Config({
  tex2jax: {
    inlineMath: [['$','$'], ['\\(','\\)']],
    displayMath: [['$$', '$$'], ["\\[", "\\]"]],
    processEscapes: true
  },
  TeX: {
     equationNumbers: {autoNumber: "AMS",
     useLabelIds: true}
  },
});
EOF;
$latex_cmd= <<<'EOD'
\newcommand{\eps}{\varepsilon}
\newcommand{\R}{\bm{R}}
\newcommand{\rd}{\operatorname{d}}
\newcommand{\set}[1]{\left\{#1\right\}
EOD;
$latex_style= <<<EOF
.latex_thm, .latex_lem, .latex_cor, .latex_defn, .latex_prop, .latex_rem{
  margin:0;padding:5px;
  background: lightcyan;
  border: solid 3px green;
  -moz-border-radius: 1.0em;
  -webkit-border-radius: 7px;
  box-shadow: 0 0 0 green;
}
EOF;

$options=get_option( 'l2h_options' );
$options['enall'] = isset( $options['enall'] ) ? $options['enall'] : false;
$options['single'] = isset( $options['single'] ) ? $options['single'] : false;
$options['mathjax_cdn'] = isset( $options['mathjax_cdn'] ) ? $options['mathjax_cdn'] : $mathjax_cdn;
$options['mathjax_config'] = isset( $options['mathjax_config'] ) ? $options['mathjax_config'] : $mathjax_config;
$options['latex_cmd'] = isset( $options['latex_cmd'] ) ? $options['latex_cmd'] : $latex_cmd;
$options['latex_style'] = isset( $options['latex_style'] ) ? $options['latex_style'] : $latex_style;

update_option('l2h_options', $options);

意思很明显, 其实就是取出l2h_options的值存入变量$options, 然后逐条判断这个值是不是为空, 如果为空则将其设置为默认值(这里是初始化, 即启用插件时执行. 我们在下一次会看到如何update用户的设置). 最后, 用update_options更新该记录.

接下来, 我们将开发用户设置页面, 到时会看到上面添加的记录的具体输出值. 目前只有通过myphpadmin看到数据库的变化.