更改插件的文件夹名称

用于文件夹的“pluginname”应始终是可更改的。

这通常通过定义常量并在整个插件中持续使用来处理。

不用说，许多流行插件都是罪人。

相关：

• plugins_url() 为了方便链接到资源，插件中包含了这些资源

使用WordPress（内置）错误处理return; 如果某些用户输入错误。向他们提供一些信息，说明做得不对。

function some_example_fn( $args = array() ) 
{
    // If value was not set, build an error message
    if ( ! isset( $args[\'some_value\'] ) )
        $error = new WP_Error( \'some_value\', sprintf( __( \'You have forgotten to specify the %1$s for your function. %2$s Error triggered inside %3$s on line %4$s.\', TEXTDOMAIN ), \'$args[\\\'some_value\\\']\', "\\n", __FILE__, __LINE__ ) );

    // die & print error message & code - for admins only!
    if ( isset( $error ) && is_wp_error( $error ) && current_user_can( \'manage_options\' ) ) 
        wp_die( $error->get_error_code(), \'Theme Error: Missing Argument\' );

    // Elseif no error was triggered continue...
}

一个错误（对象）针对所有主题或插件，您可以在引导过程中为主题或插件设置一个全局错误对象：

function bootstrap_the_theme()
{
    global $prefix_error, $prefix_theme_name;
    // Take the theme name as error ID:
    $theme_data = wp_get_theme();
    $prefix_theme_name = $theme_data->Name;
    $prefix_error = new WP_Error( $theme_data->Name );

    include // whatever, etc...
}
add_action( \'after_setup_theme\', \'bootstrap_the_theme\' );

以后，您可以根据需要添加无限错误：

function some_theme_fn( $args )
{
    global $prefix_error, $prefix_theme_name;
    $theme_data = wp_get_theme();
    if ( ! $args[\'whatever\'] && current_user_can( \'manage_options\' ) ) // some required value not set
        $prefix_error->add( $prefix_theme_name, sprintf( \'The function %1$s needs the argument %2$s set.\', __FUNCTION__, \'$args[\\\'whatever\\\']\' ) );

    // continue function...
}

然后你可以在主题结束时把它们全部取出来。这样，您就不会中断页面的呈现，并且仍然可以输出所有错误以进行开发

function dump_theme_errors()
{
    global $prefix_error, $prefix_theme_name;

    // Not an admin? OR: No error(s)?
    if ( ! current_user_can( \'manage_options\' ) ! is_wp_error( $prefix_error ) )
        return;

    $theme_errors = $prefix_error->get_error_messages( $prefix_theme_name );
    echo \'<h3>Theme Errors</h3>\';
    foreach ( $theme_errors as $error )
        echo "{$error}\\n";
}
add_action( \'shutdown\', \'dump_theme_errors\' );

有关更多信息，请访问this Q. 修复“协作”的相关票据WP_Error 和wp_die() 从那里链接，然后会有另一张票。评论、批评和；这是值得赞赏的。

最小化添加到全局命名空间的名称reduce it\'s impact 尽可能地minimizing the number of names it adds to the global namespace.

这可以通过将插件的函数封装到类中或使用PHP namespaces feature. 在所有内容前加前缀也有帮助，但没有那么灵活。

除了函数和类之外，插件不应该引入全局变量。使用类通常会淘汰它们，从而简化插件维护。

相关的Prefix Properly

使用add\\u选项之前的设置API，而不是通过add\\u选项功能将选项添加到DB中，您应该使用Settings API 那会为你照顾好一切。

在add\\u选项之前使用主题修改APIModifications API 是一种非常简单的构造，也是一种允许添加和检索选项的安全方法。所有内容都将保存为数据库中的序列化值。简单、安全；易于理解的

使用PhpDoc的注释最佳实践接近PhpDoc样式。如果您不使用IDE，如；日蚀“；，你可以看看at the PhpDoc Manual.

你不必知道这是怎么回事。专业开发人员无论如何都可以阅读代码，只需要将其作为摘要。爱好编码者和用户可能会欣赏你在相同知识水平上解释它的方式。

保护插件用户隐私（上一篇：匿名API通信）

如果插件与外部系统或API（例如某些Webservice）通信，则应匿名通信，或为用户提供匿名选项，以确保与插件用户相关的数据不会泄露给第二方。

在WordPress上托管插件。org使用SVN 存储库provided on WordPress.org 用于托管插件。它有助于更轻松地更新用户体验，如果您以前从未使用过SVN，那么通过在证明其合理性的上下文中使用它，您可以真正理解SVN。

通过使用权限提供访问控制在许多情况下，用户可能不希望每个人都能访问您的插件创建的区域，特别是对于执行多个复杂操作的插件，单次硬编码功能检查可能不够。

至少，对插件可以用于的所有不同类型的过程进行适当的功能检查。

组织您的代码总是很难读取未按执行顺序编写的代码。首先包括/要求、定义、wp\\u enqueue\\u style&_脚本等，然后是插件/主题所需的功能，最后是生成器（例如管理屏幕、主题中集成的东西等）。

尝试将css和js等内容分别放在各自的文件夹中。还可以尝试使用仅起辅助作用的函数，如数组展平器等。保留；“主要”；当您试图在一年内进行更新，并且已经很长时间没有看到代码时，尽可能干净且易于阅读的文件是一种帮助用户、开发人员和您的方法。

有一个你经常重复的结构也很好，这样你总能找到自己的出路。在一个已知的结构中开发不同的项目会给你时间让它变得更好，即使你的客户转向另一个开发人员，你也永远不会听到；他留下了一片混乱；。这会建立你的声誉，应该是一个长期目标。

导入/导出插件设置在插件中并不常见，但如果你的插件有（一些）设置，它应该provide Import / Export of data like configuration and user input.

导入/导出提高了插件的可用性。

具有这种导入和导出功能（以及撤消机制）的插件示例如下Breadcrumb NavXT (Wordpress Plugin) （完全披露：其中一些小代码是我写的，大部分是mtekk写的）。

相关的Uninstall should remove all plugin\'s data

Deactivation should not provoke Data-Loss

有风格的模具

使用wp_die() 还有助于你的插件/主题与wordpress testsuite.

相关：

• Use WP Error handling

为用户提供帮助屏幕

/**
  * Add contextual help for this screen
  * 
  * @param $rtfm
  * @uses get_current_screen
  */ 
  function ContextualHelp( /*string*/ $rtfm) 
  { 
     $current_screen = get_current_screen();
     if ($current_screen->id == $this->_pageid) 
     {
        $rtfm .= \'<h3>The WordPress Plugin - Screen A</h3>\';
        $rtfm .= \'<p>Here are some tips: donate to me \' .
     }
     return $rtfm; 
  }
add_action(\'contextual_help\', array($this,\'ContextualHelp\'),1,1);

提供可扩展的表单

见：Settings API

相关的Use Actions and Filters

Re-Use existing functions

I18n support

始终通过钩子而不是直接包含函数。

例子：

不要使用通过new Withook包含插件类

使用加载的挂钩插件

// add the class to WP                                   
function my_plugin_start() {                                                               
    new my_plugin();   
}                                                        
add_action( \'plugins_loaded\', \'my_plugin_start\' );

//avoid direct calls to this file where wp core files not present
if (!function_exists (\'add_action\')) {
        header(\'Status: 403 Forbidden\');
        header(\'HTTP/1.1 403 Forbidden\');
        exit();
}

if ( !class_exists( \'plugin_class\' ) ) {
    class plugin_class {

        function __construct() {
        }

    } // end class

    function plugin_start() {

        new plugin_class();
    }

    add_action( \'plugins_loaded\', \'plugin_start\' );
} // end class_exists

在GPL兼容许可证下许可插件，插件和主题应在WordPress兼容许可证下许可。这使得它们可以通过WordPress作为；程序&引用；推荐的许可证是the GPL. 注意插件中包含的所有代码库都与同一许可证兼容

（这有been a problem 而且很严重point of debate 过去和现在present.)

最小化远程数据源和Web服务的副作用一个插件应该Cache/Shield Webservice 和/或XMLRPC/SOAP requests through a caching/data-provider layer 如果您使用它们来避免前端请求等待（缓慢的）webservice响应。

这包括下载RSS提要和其他页面。设计他们在后台请求数据的插件。

一个可能的步骤是（以发布到ping.fm为例）：创建一个缓冲表，例如：ping\\u fm\\u buffer\\u post（日期、时间、消息、提交时间、状态）

每次您要向ping提交更新时。fm，将其添加到此表中

，因为我们有这个表，我们还可以列出提交给ping的每个消息。调频并检查每个帖子的状态。以防ping出现问题。fm方面，我们可以重新提交

Use WordPress\'s Coding Standards

http://codex.wordpress.org/WordPress_Coding_Standards

我们知道你的插件或主题是你自己的，你打断台词和添加花括号的方式是你个性的表现。每一个缩进都是经过深思熟虑的陈述。但是，通过自定义代码，即使您的代码不在核心应用程序中，您也为WordPress做出了贡献。编码标准可以帮助开发人员快速了解您的代码。

测试你的插件

基于this answer 通过Ethan Seifert 对于测试问题，应遵循以下良好做法：

单元测试应该测试类可以执行的最小数量的行为

关心未来的WordPress&；主题版本

Check if functions are deprecated 直接在你的主题中。

这是一个；“可能是这样的。”；实例

if ( ! function_exists( \'wp_some_fn\' ) ) 
{
    $theme_data = wp_get_theme();
    $error = new WP_Error( \'wp_some_fn\', sprintf( __( \'The function %1$s is deprecated. Please inform the author\', TEXTDOMAIN ), "Theme: {$theme_data->Name}: Version {$theme_data->Version}" );

    // abort
    if ( is_wp_error( $error ) )
        return print $error->get_error_message();
} 
// else if no error - the function works and exists
wp_some_fn();

您甚至可以将$cause放入函数中。这将帮助您和您的用户跟踪主题中可能更改的函数或类。

使用专有名称

如果文件包含名为“dbdbInit”的类，则应将包含该类的文件命名为dbdbInit.class.php“如果你进入dbdbInit-类a函数，该函数注册ex.custom\\u post\\u类型，然后调用它register_custom_post_types().

与WordPress核心代码解耦插件应该reduce the impact of the WordPress API to the needed minimum 所以要把插件代码和WordPress代码分开。这减少了WordPress代码库中的更改对插件的影响。此外，这还提高了插件代码的跨版本兼容性。

这并不意味着不使用WordPress函数（使用它们，如Re-Use existing functions 建议），但不要将您的代码与WordPress功能过度融合，而是将插件业务逻辑与WordPress功能分开。

将wp选项用于插件输出字符串

例如：Sociable-使您能够更改图标部分“共享和享受：”

使用卸载、激活和停用挂钩有三种不同的挂钩：

卸载register_uninstall_hook();停用register_deactivation_hook();register_activation_hook();A detailed instruction with a working example can be found here..

使用某种模板机制，许多插件倾向于自由混合代码和html，这使得维护和调试非常困难。更好的方法是将所有html放在单独的文件中，并使用如下内容：

function parseTemplate($file, $options) {
    $template = file_get_contents($file);
    preg_match_all("!\\{([^{]*)\\}!", $template, $matches);

    $replacements = array();
    for ($i = 0; $i < count($matches[1]); $i++) {
        $key = $matches[1][$i];
        if (isset($options[$key])) {
            $val = $matches[0][$i];
            $template = str_replace($val, $options[$key], $template);
        }
    }

    return $template;
}

然后像这样使用：

// In mytemplate.html
<h1>{title}</h1>
<h2>{date}</h2>
<p>{text}</p>

// In your functions.php
echo parseTemplate("mytemplate.html", array(
    "title" => $title,
    "date" => $date,
    "text" => $somethingelse
));