O mnie

@

Plan

• Potęga WordPress
• Wstęp do wtyczek
• Podstawowe zasady
• Panel administracyjny
• Baza danych
• Dodatki
• Ulubione

Potęga WordPress

• Liczba pobrań tygodniowo - 645k (druga Joomla! - 86,5k)
• Z 1 mln najpopularniejszych witryn w rankingu Aleksy - 53,6%
• Liczba książek - 83 (23 w 2011r.)
• Dostępność developerów (z grupy 42k portali elance.com, guru.com) - 56,5%
• Najwyższa rozpoznawalność
• Łatwy system szablonów
• System wtyczek
  17 240 wtyczek w katalogu WP
  239 054 027 pobrań wtyczek

Cechy API systemu WordPress

• Architektura Event-Driven (zdarzeniowa)
• Hooks - ponad 1 500
• Actions
  • has_action(); add_action(); do_action(); do_action_ref_array(); did_action(); remove_action(); remove_all_actions()
• Filters
  • has_filter(); add_filter(); apply_filters(); current_filter(); merge_filters(); remove_filter(); remove_all_filters();
• Możliwość skorzystania z OOP i z trybu strukturalnego

Organizacja kodu wtyczki

• Rozdzielenie zadań na funkcje
• Użycie OOP
• Odpowiednie nazewnictwo
• Wielojęzykowość
• Oddzielenie logiki od prezentacji
• Ułatwienia w modyfikacji wyglądu
• Dokumentacja, kontrola wersji, changelog
• Testy i bezpieczeństwo
• Screeny wtyczki!

Źródła inspiracji

• Własne potrzeby
• Czytelnicy bloga lub strony
• Zgłaszane zapytania na forach, na WP Support
• Integracje z pojawiającymi się nowymi aplikacjami, skryptami, stronami
• Istniejące (nieutrzymywane) wtyczki

Nazewnictwo i lokalizacje

• Nazwa wtyczki
• Pliki wtyczki - 1 plik vs katalog z plikami
• Dokumentacja w PHPDoc
• plugin_dir_path() oraz plugins_url()
• readme.txt - hostowanie wtyczek na stronie WP
• Licencja - GPL2 (jak WP) lub kompatybilna

Minimum wtyczki - nagłówek (screen)

Przykład użycia add_action

if ( !class_exists("WordCampPoznan2011") ){ // ok, droga wolna
    class WordCampPoznan2011 {
        function init(){
            echo '<p class="pwrdby_wcpon">
		        Powerd by <strong>WordCampPoznan2011</strong>
		    </p>';
        }
    }
    $wcpoz = new WordCampPoznan2011();
    if ( $wcpoz ) {
        add_action('in_admin_footer', array($wcpoz, 'init'));
    }
}

Przykład użycia add_action (screen)

Przykład użycia add_filter

if ( !class_exists("WordCampPoznan2011") ){ // ok, droga wolna
    class WordCampPoznan2011 {
        function init($input){
            echo $input.'<p class="pwrdby_wcpon">
		        Powerd by <strong>WordCampPoznan2011</strong>
		    </p>';
        }
    }
    $wcpoz = new WordCampPoznan2011();
    if ( $wcpoz ) {
        add_filter('the_content', array($wcpoz, 'init'));
    }
}

Przykład użycia add_filter (screen)

Panel administracyjny

• Podmenu Ustawienia

  add_options_page($page_title, $menu_title, $capability, $menu_slug, $function);

• Nowa grupa menu

  add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function,
      $icon_url,$position);
  add_submenu_page($parent_slug, $page_title, $menu_title, $capability, $menu_slug,
      $function);

• Submenu istniejących pozycji
  • kokpit, wpisy, media, odnośniki, strony, komentarze, wygląd, wtyczki, użytkownicy, narzędzia, ustawienia

  add_strona_page($page_title, $menu_title, $capability, $menu_slug, $function);

Panel administracyjny (screen)

Obsługa ustawień

• Wybór opcji do konfiguracji
• Zapis domyślnych ustawień przy aktywowaniu wtyczki
• Stworzenie strony z formualrzem ustawień
• Zapis ustawień do bazy jeśli formularz został wysłany
• Edycja lub usunięcie ustawień po wyłączeniu wtyczki

Obsługa ustawień (2)

• Definicja kilku przydatnych stałych

  define('WORDCAMP_PLUGIN_VERSION','0.1.7');
  define('WORDCAMP_PLUGIN_LONGNAME','wordcamp');
  define('WORDCAMP_PLUGIN_SHORTNAME','wcpoz');
  define('WORDCAMP_PLUGIN_OPTIONS','WordCampPoznan2011PluginOptions');
  define('WORDCAMP_PLUGIN_BASEDIR',dirname(plugin_basename(__FILE__)));
  define('WORDCAMP_PLUGIN_BASEURL',plugins_url('',__FILE__));

• Zmienna klasy przechowująca domyślne wartości

  protected static $default_options = array(
      'twitter_hashtag' => WORDCAMP_PLUGIN_SHORTNAME,
      'last_version' => WORDCAMP_PLUGIN_VERSION
  );

Obsługa ustawień (3)

• Metoda zapisująca domyślną konfigurację

  public static function plugin_activate(){
      $options = get_option(WORDCAMP_PLUGIN_OPTIONS);
      if ( empty($options['last_version']) || 
          $options['last_version'] == WORDCAMP_PLUGIN_VERSION
      ){
          $options = self::$default_options;
          update_option(WORDCAMP_PLUGIN_OPTIONS,$options);
      }
  }

• Rejestracja metody przy aktywowaniu wtyczki

  register_activation_hook( __FILE__, 
      array('WordCampPoznan2011','plugin_activate') 
  );

Obsługa ustawień (4)

• Metoda wywoływana przy deaktywacji wtyczki

  public static function plugin_deactivate(){
      $options = get_option(WORDCAMP_PLUGIN_OPTIONS);
      if ( $options['last_activate'] ){
          $options['last_activate'] = '';
      }
      update_option(WORDCAMP_PLUGIN_OPTIONS,$options);
  }

• Rejestracja metody przy deaktywowaniu wtyczki

  register_deactivation_hook( __FILE__, 
      array('WordCampPoznan2011','plugin_deactivate') 
  );

Obsługa ustawień (5)

• Zapis ustawień do bazy

  $options = get_option(WORDCAMP_PLUGIN_OPTIONS);
  if ( !empty($_POST['update_wordcamp2011_options']) ){
      foreach ( $options as $opt_key => $opt_value){
          if ( isset($_POST[$opt_key]) ){
              $options[$opt_key] = $_POST[$opt_key];
          }
      }
      update_option(WORDCAMP_PLUGIN_OPTIONS, $options);
  }

Panel administracyjny (screen)

Dodawanie JavaScript i CSS

• JavaScript

  wp_register_script( $handle, $src, $deps, $ver, $in_footer )

  wp_enqueue_script( $handle, $src, $deps, $ver, $in_footer );

• CSS

  wp_register_style( $handle, $src, $deps, $ver, $media );

  wp_enqueue_style( $handle, $src, $deps, $ver, $media );

Link do ustawień na karcie wtyczek

• Metoda dodająca link do strony z ustawieniami

  public static function options_link($links){
      if ( !current_user_can('manage_options') ){ return $links; }
      $settings_link = '<a href="'.admin_url('admin.php').'?page=wordcamp" 
           title="Ustawienia" class="edit"<Ustawienia</a>';
      array_unshift( $links, $settings_link );
      return $links;
  }

• Ustawienie filtra

  add_filter('plugin_action_links_'.WORDCAMP_PLUGIN_BASEDIR.'/wordcamppoznan2011.php', 
      array('WordCampPoznan2011','options_link')
  );

System pomocy kontekstowej

public static $wcpoz;
public static function init_admin_menu(){

    WordCampPoznan2011::$wcpoz = add_options_page('WordCamp Poznań 2011', 
        'WordCamp Poznań', 'manage_options', 'wordcamp-poznan', 
        array('WordCampPoznan2011', 'wordcamp_poznan_options'));
			
    add_filter(
        'contextual_help', array('WordCampPoznan2011','contextual_help'), 10, 3
    );
}
public static function contextual_help($contextual_help, $screen_id, $screen){
    if ($screen_id == WordCampPoznan2011::$wcpoz) {
        $contextual_help = '<p>WordCamp Poznań 2011 - Pomoc kontekstowa.</p>';
    }
    return $contextual_help;
}

Kokpit

• Metoda dodająca link do strony z ustawieniami

  public static function add_dashboard_widget(){
      if ( !current_user_can('manage_options') ){ return $links; }
      $options = get_option(WORDCAMP_PLUGIN_OPTIONS);
  	echo '
  Aktaulny HashTag:
  '.$options[''].'
  ';
  }
  public static function add_dashboard() {
      if ( !current_user_can('manage_options') ){ return; }
  	wp_add_dashboard_widget( WORDCAMP_PLUGIN_LONGNAME,'WordCamp Poznań', 
              array('WordCampPoznan2011','add_dashboard_widget') 
      );
  }

• Wywołanie akcji

  add_action('wp_dashboard_setup', array('WordCampPoznan2011','add_dashboard') );

AdminBar

• Metoda dodająca link do paska administratora

  public static function add_adminbar() {
      global $wp_admin_bar;
      if ( !current_user_can('manage_options') || !is_admin_bar_showing()){
          return;
      }
      $wp_admin_bar->add_menu(array( 'id' => 'wordcamp', 'title' => 'WordCamp', 
          'href' => admin_url('admin.php').'?page=wordcamp'));
      $wp_admin_bar->add_menu(array( 'parent' => 'wordcamp', 'title' => 'Informacje',
          'href' => admin_url('admin.php').'?page=wordcamp'));
      $wp_admin_bar->add_menu(array( 'parent' => 'wordcamp', 'title' => 'Ustawienia',
          'href' => admin_url('admin.php').'?page=wordcamsettings'));
  }

• Wywołanie akcji

  add_action('admin_bar_menu', array('WordCampPoznan2011','add_adminbar'),100);

Dodatki (screen)

Wynik działania wtyczki (screen)

Warto pisać wtyczki?

• Oszczędność czasu
• Zyski z datków
• Płatne rozszerzenia, wsparcie
• Szansa na zdobycie kontraktów,
  klientów
• Linki zewnętrzne
• Sława i splendor