Plugins no WordPress: Fazendo o Negócio Direito

IntroducaoPadroes

DesenvolvimentoConsideracoes Finais

Plugins no WordPressFazendo o Negocio Direito

Vinicius Massuchetto

Campus Party Brasil 2013

Fevereiro de 2013

Vinicius Massuchetto Plugins no WordPress

IntroducaoPadroes

ApresentacaoSobre a PalestraMotivacaoAvancando a Ideia

Apresentacao

@vmassuchetto

http://github.com/vmassuchetto

http://bitbucket.org/vmassuchetto

Apresentacao disponıvel em:http://vinicius.soylocoporti.org.br/?p=2191

IntroducaoPadroes

Sobre a Palestra

Motivacao, dificuldades e vantagens dos metodosPadroes de desenvolvimento no WordPressEstrutura de codigoInterfaces com o WordPressFerramentas uteis ja presentes no WordPress

IntroducaoPadroes

Motivacao

IntroducaoPadroes

Motivos para se criar um plugin

Funcionalidade inexistenteDiferente implementacao de uma funcionalidade existenteCodigos de tema portaveisImplementacoes modulares para clientesForks para ajustes e extensoes de plugins existentes

IntroducaoPadroes

Perguntas

Demonstracao, apoio ou funcionalidade crıtica?Comunidade, visibilidade ou emprego?Tempo para suporte?

IntroducaoPadroes

Dificuldades em se escrever um plugin

PHP X WordPressCultura de leitura de documentacao e inspecao de codigoBarreira de idioma

IntroducaoPadroes

Vantagens de se seguir algumas boas praticas

Codigo legıvelPadronizacao de estruturasMelhor aprendizado de outros desenvolvedoresMelhor manutencao do codigoExtensibilidadeDistributividade na comunidade do software livre

IntroducaoPadroes

Pensando Em Um Plugin

Definicao de escopo e pesquisa de funcionalidadesSe parecer redundante, perguntar e descrever a ideia emlistas e forunsEscolha de nome unico e relevanteAvaliacao do uso de outras tecnologias e frameworks

IntroducaoPadroes

Primeiro PadraoArquivosPadroes de CodigoPadroes de SQL

IntroducaoPadroes

Primeiro Padrao

IntroducaoPadroes

Arquivos

Nomear o diretorio e os arquivos coerentementeIncluir somente arquivos necessarios e sob demanda nocodigoPermitir que o diretorio do plugin mude usando funcoescomo:

plugins url

plugin dir url

plugin dir path

IntroducaoPadroes

Nomeacao

./some-plugin

+ sp.js

+ somelib.js

+ sp.php <-- arquivo principal

+ sp-functions.php

+ sp-admin.php

+ sp-cache.php

IntroducaoPadroes

Inclusao Condicional

if ( is_admin() ){

/* interface administrativa */

add_action ...

add_filter ...

} else {

/* frontend */

add_action ...

add_filter ...

IntroducaoPadroes

Padroes de Codigo

Ater-se aos padroes recomendados para codigo edocumentacaoNomear as estruturas e funcoes com um identificadorunicoClareza e melhor do que praticidade

IntroducaoPadroes

Tag PHP

Errado

<? /* code */ ?>

<?=$var?>

<% /* code */ %>

IntroducaoPadroes

Tag PHP

<?php /* code */ ?>

<?php echo $var; ?>

IntroducaoPadroes

Chaves

Errado

if(condition)

action1();

action2();

action3();

action4();

IntroducaoPadroes

Chaves

if ( condition ) {

action1();

action2();

} else {

action3();

action4();

IntroducaoPadroes

Funcoes

Errado

function some_function($param1=’foo’, $param2=’bar’) {

/* code */

class SomeClass {

/* code */

IntroducaoPadroes

Funcoes

function some_function( $param1 = ’foo’, $param2 = ’bar’ ) {

/* code */

class Some_Class {

/* code */

IntroducaoPadroes

Vetores

Errado

$x = $foo[$bar];

$x = $foo[ ’bar’ ];

IntroducaoPadroes

Vetores

$x = $foo[ $bar ];

$x = $foo[’bar’];

IntroducaoPadroes

Padroes de SQL

Evitar escrever consultasUtilizar filtros para a WP QueryEscrever as palavras SQL em caixa altaValidar os tipos de dados antes de utiliza-losUtilizar a wpdbSe precisar criar tabelas no banco, use $wpdb->prefix

IntroducaoPadroes

Exemplo de Consulta

Errado

$r = $wpdb->get_results("select * from wp_posts where post_date

> ’2012-08-25 00:00:00’");

IntroducaoPadroes

Exemplo de Consulta

$r = $wpdb->get_results( $wpdb->prepare(

SELECT ID, post_title, post_content

FROM $wpdb->posts

WHERE 1=1

AND post_date > ’%s’

, $some_date ) );

IntroducaoPadroes

EstruturaInterfacesScripts e EstilosFerramentasLiberando na Comunidade

IntroducaoPadroes

Constantes de debug no wp-config.php

WP DEBUG

WP DEBUG LOG

WP DEBUG DISPLAY

SCRIPT DEBUG

SAVEQUERIES

IntroducaoPadroes

Cabecalho

Todo plugin comeca pelo comeco..

* Plugin Name: Nome do Plugin

* Version: 0.01

* Description: Texto longo

* Author: Nome do Autor

* Contributors: Logins no WordPress.org

* Plugin URI: http://uma-url.com

IntroducaoPadroes

Estrutura Procedural

function callback1 () { /* code */ }

add_action( ’hook1’, ’callback1’ );

function callback2 () { /* code */ }

function callback3 ($param) { /* code */ return $param; }

add_filter( ’filter’, ’callback3’ );

IntroducaoPadroes

Estrutura Orientada a Objetos

class Some_Plugin {

function Some_Plugin() {

add_action( ’hook1’, array($this, ’hook1’ ));

function hook1 { /* code */ }

IntroducaoPadroes

Vantagens da Orientacao a Objetos em Plugins

Organiza o codigoMelhora a extensibilidadeReduz o impacto no escopo global do PHPAjuda a nao introduzir variaveis globais

IntroducaoPadroes

Ativacao

register activation hook

Criacao de opcoes padraoCriacao de tabelasExibicao de avisos para o usuario configurar o plugin

IntroducaoPadroes

Desativacao

register deactivation hook

Em geral nao deve causar nenhuma perda de dadosDesabilitar plugins dependentes

IntroducaoPadroes

Desinstalacao

register uninstall hook

Nao deve deixar nenhum dado residual no WordPressRemove opcoes do usuarioRemove tabelasAvisa o usuario antes de remover qualquer dado(admin notices)

IntroducaoPadroes

Inicializacao

* init()

Geralmente atraves de um procedimento inicializador

IntroducaoPadroes

Inicializacao

function someplugin_init () {

add_filter( ’filter’, ’callback3’ );

someplugin_init();

add_action( ’plugins_loaded’, ’someplugin_init’ );

IntroducaoPadroes

Inicializacao

class Some_Plugin {

function SomePlugin() {

new Some_Plugin();

add_action( ’plugins_loaded’,

array( ’Some_Plugin’, ’Some_Plugin’ ));

IntroducaoPadroes

Consultas

Sempre prefira a WP Query em loops estruturados:have posts

the post

IntroducaoPadroes

Consultas

Nunca fuja do loop:

<?php if ( have_posts() ) : ?>

<?php while ( have_posts() ) : the_post(); ?>

<?php // content ?>

<?php endwhile; ?>

<?php else : ?>

<?php // not found ?>

<?php endif; ?>

IntroducaoPadroes

Filtros de Consulta

posts where

posts join

posts orderby

posts groupby

IntroducaoPadroes

Banco de dados

Em ultimo caso, use a wpdb:query

prepare

insert

update

get var

IntroducaoPadroes

Tratando dados para consultas

$wpdb->get_var( $wpdb->prepare(

SELECT foo

FROM {$wpdb->table}

WHERE 1=1

AND bar_id = %d

AND bar_slug = %s

$id, $slug

IntroducaoPadroes

Uso de Acoes e Filtros

Base da construcao de plugins no WordPressCertificar-se de agendar os eventos e tratar os dadosadequadamente

IntroducaoPadroes

Implementacao de Acoes e Filtros

Oferecer extensibilidade aos dados geradosPossibilitar a insercao de novos procedimentos a medidaque eventos relevantes acontecem

IntroducaoPadroes

Implementacao de Acoes

function show_something() {

do_action( ’before_show_something’ );

/* something */

do_action( ’after_show_something’ );

function show_something_header() { /* header */ }

add_action( ’before_show_something’, ’show_something_header’ );

function show_something_footer() { /* footer */ }

add_action( ’after_show_something’, ’show_something_footer’ );

IntroducaoPadroes

Implementacao de Filtros

function get_something ( $param ) {

/* get $something */

return apply_filters( ’get_something’, $something );

function parse_something ( $something ) {

return preg_replace( $regex, $replace, $something );

add_filter( ’get_something’, ’parse_something’ );

IntroducaoPadroes

Implementacao de Acoes e Filtros

<form>

<?php foreach ( $field as $f ) : ?>

<?php $f = apply_filters( ’display_field’, $f ); ?>

<?php do_action( ’before_display_field’, $f ); ?>

<input

name="<?php echo $f[’name’]; ?>"

type="<?php echo $f[’type’]; ?>"

value="<?php echo $f[’value’]; ?>" />

<?php do_action( ’after_display_field’, $f ); ?>

<?php endforeach; ?>

<?php do_action( ’before_submit’ ); ?>

</form>

IntroducaoPadroes

Adicionando scripts

ErradoNo tema:

<html>

<head>

</head>

IntroducaoPadroes

Adicionando scripts

Errado

function custom_scripts() {

someCall();

</script>

add_action( ’custom_scripts’, ’wp_head’ );

IntroducaoPadroes

Enfileiradores de scripts

Funcoes:wp enqueue script

wp enqueue style

wp localize script

Hooks:wp enqueue scripts

admin enqueue scripts

IntroducaoPadroes

Incluindo scripts

wp_enqueue_script( ’jquery’ );

wp_enqueue_script( ’my_script’,

’my_script.js’, array( ’jquery’ ) );

add_action( ’wp_enqueue_scripts’, ’custom_scripts’ );

IntroducaoPadroes

Incluindo scripts com variaveis

wp_enqueue_script( ’jquery’ );

wp_enqueue_script( ’my_script’,

’my_script.js’, array( ’jquery’ ) );

$params = array(

’key1’ => ’val1’,

’key2’ => ’val2’

wp_localize_script( ’my_plugin’, ’params’, $params );

add_action( ’wp_enqueue_scripts’, ’custom_scripts’ );

IntroducaoPadroes

Incluindo scripts com variaveis: resultado

/* <![CDATA[ */

var params = {"key1":"val1","key2":"val2"};

/* ]]> */

</script>

IntroducaoPadroes

Internacionalizacao

Usar funcoes () e e()Carregar o arquivo MO

IntroducaoPadroes

Internacionalizacao

echo __( ’String a ser traduzida’, ’plugin_textdomain’ );

_e( ’String a ser traduzida’, ’plugin_textdomain’ );

printf(

__( ’String com um valor %s qualquer no meio’,

’plugin_textdomain’ ),

$string

IntroducaoPadroes

Internacionalizacao

function plugin_textdomain() {

load_plugin_textdomain( ’plugin_textdomain’, false,

dirname( plugin_basename( __FILE__ ) ) . ’/lang/’ );

add_action( ’plugins_loaded’, ’plugin_textdomain’ );

IntroducaoPadroes

Tratamento de Erros

IntroducaoPadroes

Tratamento de erros

Instanciacoes da WP ErrorVerificacao com is wp errorUtilizar a wp die para morrer elegantemente

IntroducaoPadroes

Tratamento de erros

function some_func( $param ) {

$error = false;

if ( ! empty( $param ) )

$error = new WP_Error( ’plugin_name’,

sprintf( __( ’Parametro %1$s invalido no arquivo

%2$s linha %3$s.’,

’plugin_textdomain’ ),

’$param’, __FILE__, __LINE__ ) );

if ( is_wp_error ( $error ) )

wp_die ( $error, ’Argumento invalido.’ );

/* func */

IntroducaoPadroes

Tratamento de erros com objetos

class Some_Plugin {

var $error;

function Some_Plugin() {

$this->error = new WP_Error ( ’plugin_name’ );

/* hooks */

IntroducaoPadroes

Classes e Funcoes Uteis

IntroducaoPadroes

Manipulacao de Dados

wp parse args

wp list filter

IntroducaoPadroes

Formatacao

is email

remove accents

sanitize title

sanitize email

seems utf8

zeroise

wptexturize

IntroducaoPadroes

Transients API

set transient

get transient

delete transient

IntroducaoPadroes

HTTP API

wp remote get

wp remote retrieve body

wp remote retrieve headers

IntroducaoPadroes

Object Cache

wp cache add

wp cache set

wp cache get

wp cache delete

wp cache flush

IntroducaoPadroes

wp schedule event

wp schedule single event

wp unschedule event

wp next scheduled

IntroducaoPadroes

Classes Uteis

SimplePie

PHPMailer

IntroducaoPadroes

Funcoes Uteis

wp mail

fetch feed

human time diff

IntroducaoPadroes

Liberando na comunidade

IntroducaoPadroes

Liberando na comunidade

Requerer hospedagem no repositorio SVN oficialEscrever a documentacaoFazer uma imagem de apresentacaoAvaliar requisicoes de suporte e gerenciar traducoes

IntroducaoPadroes

readme.txt de um plugin

=== Plugin Name ===

== Description ==

== Installation ==

== Frequently Asked Questions ==

== Screenshots ==

== Changelog ==

== Arbitrary section ==

IntroducaoPadroes

Consideracoes Finais

Interfaces altamente flexıveisConjunto de ferramentas amplo e disponıvelFacil acesso as informacoes pelo desenvolvedorNao tem desculpa para nao codificar e suportar um plugincom qualidade

IntroducaoPadroes

Referencias

Codex: Writing a Pluginshttp://codex.wordpress.org/Writing_a_Plugin

WordPress Answershttp://wordpress.stackexchange.com/questions/715/

objective-best-practices-for-plugin-development

Plugins no WordPress: Fazendo o Negócio Direito

Technology

Transcript of Plugins no WordPress: Fazendo o Negócio Direito

Desenvolvimento de uma ferramenta para auxiliar a construção de plugins

WordPress: Guia de desenvolvimento de Temas e Plugins

Wordpress Introdução a Plugins

Desenvolvimento de Plugins Para Eclipse - Treinamento

Fora do padrão no Revit Architecture: plugins e formas de ...damassets.autodesk.net/content/dam/au/Brasil-2014/documents/... · Fora do padrão no Revit Architecture: plugins e formas

Top Plugins de Segurança para WordPress

Search Plugins para Firefox

Comic-con Busk plugins

Tutorial 2a instalação de plugins do qgis v3

Conexão – Trajetória de sucesso – Fazendo a Diferençasindipneus.com.br/wordpress/wp-content/uploads/2013/04/revista_23.pdf · com o Sindipneus. Se não faz, está na hora de

Sistema de Plugins do ExpressoV3. Não espere, faça o seu!

WordCamp Porto Alegre 2018 - Plugin Territory...2018/05/12 · WordCamp São Paulo. 1. Introdução Arquitetura do WordPress, Temas e Plugins Arquitetura do WordPress Core Temas Plugins

Wordpress basico

Fazendo milagres com WordPress

Producer Bundle One-Sheet OL...profissionais de gravação e produção musical com pacote de plugins inclusos O pacote Musician Collection para Pro Tools I First inclui 23 plugins

lionslc2.org.brlionslc2.org.br/wordpress/wp-content/uploads/2016/05/LC... · Web view2016-05-17 · LIONS e LEO fazendo sua parte na Campanha Nacional de combate ao transmissor

Grails parte ii - plugins & rest

Silenciamentos e esquecimento nas Cabanagens do Grão-Pará. · Dossiê da Cabanagem também fazendo uso da mesma imagem. Fonte: cabanagem180 wordpress Em 1990, o fotografo Luiz Braga

Apresentacao WP Summit - 10+ Plugins de WordPress para desenvolvedores

Rafael Ossamu Togo · 2015. 9. 16. · segurança nos plugins utilizados, ou instalação de softwares mal intencionados ao instalar es-tes plugins. O WebRTC não veio para adicionar