Prácticas Objetivas Recomendadas para el Desarrollo de Plugins?

Prueba tu plugin

Definitivamente deberíamos tener algunas herramientas de prueba en nuestro entorno de desarrollo de plugins.

Basado en esta respuesta de Ethan Seifert a una pregunta sobre pruebas, estas son buenas prácticas a seguir:

• Tu Prueba de Unidad debe evaluar la cantidad más pequeña de comportamiento que una clase puede realizar.
• Cuando llegas al nivel de pruebas funcionales, aquí es donde puedes evaluar tu código con dependencias de Wordpress.
• Dependiendo de lo que haga tu plugin - considera usar pruebas basadas en Selenium que evalúan la presencia de datos en el DOM usando IDs

Preocúpate por futuras versiones de WordPress y del tema

Nota: Después de releer este consejo, ahora me retracto de esta práctica ya que verificar cada función para ver si existe puede ralentizar tu sitio.

Verifica si las funciones están obsoletas directamente en tu tema.

Este es un ejemplo "podría ser así".

if ( ! function_exists( 'wp_some_fn' ) ) 
{
    $theme_data = wp_get_theme();
    $error = new WP_Error( 'wp_some_fn', sprintf( __( 'La función %1$s está obsoleta. Por favor informa al autor', TEXTDOMAIN ), "Tema: {$theme_data->Name}: Versión {$theme_data->Version}" );

    // abortar
    if ( is_wp_error( $error ) )
        return print $error->get_error_message();
} 
// else if no error - la función existe y funciona
wp_some_fn();

Para un manejo de errores adecuado/mejores prácticas, consulta esta respuesta: enlace

Podrías incluso incluir la $cause dentro de la función. Esto te ayudará a ti y a tus usuarios a mantenerse al tanto de las funciones o clases en tu tema que podrían cambiar.

Usa Nombres Adecuados

Nombra hooks y filtros (clases, funciones y variables), de modo que las personas puedan identificarlos incluso dentro de un año, cuando ya no recuerden de dónde viene ese trozo de código. No importa si los nombres de hooks/filtros son largos. Ej. tunombredeproyecto_hook/filtro_quéhace.

• Si tu archivo contiene una clase llamada "dbdbInit", entonces el archivo que contiene la clase debería llamarse "dbdbInit.class.php".
• Si dentro de tu clase dbdbInit tienes una función que registra tipos de posts personalizados, llámala registrar_tipos_de_posts_personalizados().
• Si tienes un array que contiene los nombres de los tipos de posts personalizados, entonces llama a la variable donde se asigna el array $nombres_de_tipos_de_posts_personalizados.
• Si tienes una función que maneja un array, escribe function manipulador_de_array( $array ) { // maneja el array }.
• Intenta nombrar las cosas de manera que sepas qué hace o a qué pertenece solo por su nombre.

Otra cosa: Si tienes que depurar código, en el 99% de los casos recibirás mensajes no solo de tu código, sino también de WordPress. Por eso, intenta usar el mismo prefijo, por ejemplo "dbdb", para tus clases, funciones públicas y variables/objetos. De esta manera, podrás encontrarlos fácilmente entre cientos de archivos. (WordPress carga 64 archivos antes que tu tema y alrededor de 1,550 funciones, sin contar hooks y filtros).

Desacoplar del código principal de WordPress

Un plugin debería reducir el impacto de la API de WordPress al mínimo necesario para separar el código del plugin del código de WordPress. Esto reduce el impacto de los cambios dentro del código base de WordPress en el plugin. Además, mejora la compatibilidad multiplataforma de tu código de plugin.

Esto no significa no usar funciones de WordPress (úsalas, como sugiere Reutilizar funciones existentes), sino no entrelazar demasiado tu código con funciones de WordPress, sino separar la lógica de negocio de tu plugin de la funcionalidad de WordPress.

Usar opciones de WordPress para cadenas de salida de plugins

Para que el plugin sea fácil de usar y personalizable, todas las cadenas de salida deberían poder modificarse. La mejor manera de hacer esto es usar las opciones de WordPress (wp-options) para almacenar las cadenas de salida y proporcionar una interfaz de backend para cambiar los valores predeterminados. El plugin no debería usar cadenas mostradas que no puedan cambiarse fácilmente usando el backend del plugin.

Por ejemplo: Sociable - te da la capacidad de cambiar la frase que aparece antes de la parte de los íconos "compartir y disfrutar:"

Usa los hooks de desinstalación, activación y desactivación

Existen tres hooks diferentes para esto:

• Desinstalación register_uninstall_hook();
• Desactivación register_deactivation_hook();
• Activación register_activation_hook();

Puedes encontrar aquí una instrucción detallada con un ejemplo funcional..