|
| 1 | +<?php |
| 2 | +// phpcs:disable WordPress.Security.NonceVerification.Recommended |
| 3 | + |
| 4 | +namespace Idearia; |
| 5 | + |
| 6 | +defined( 'ABSPATH' ) || exit; |
| 7 | + |
| 8 | +/** |
| 9 | + * Crea una pagina di opzioni di WordPress e mostrala come |
| 10 | + * voce di menu a se stante oppure come sottovoce di un menu |
| 11 | + * esistente. |
| 12 | + * |
| 13 | + * Per creare una pagina estendi questa classe e sovrascrivi |
| 14 | + * i seguenti CAMPI OBBLIGATORI: |
| 15 | + * |
| 16 | + * - $label => titolo della pagina e nome della voce di menu |
| 17 | + * - $slug => slug unico della voce di menu |
| 18 | + * - getSections() => funzione che ritorna le sezioni della pagina, |
| 19 | + * solitamente renderizzate come tabs |
| 20 | + * - getFields() => funzione che ritorna le opzioni vere e proprie, |
| 21 | + * raggruppate per sezione |
| 22 | + * |
| 23 | + * Per maggiore controllo sovrascrivi i seguenti CAMPI OPZIONALI: |
| 24 | + * - $position => posizione relativa della voce di menu |
| 25 | + * - $parentSlug => se vuoi che la pagina sia una sottovoce di un |
| 26 | + * menu esistente, specifica qui lo slug del menu; altrimenti |
| 27 | + * verrà creato un menu madre ad hoc con etichetta $label |
| 28 | + * - $menuLabel => per specificare un'etichetta del menu |
| 29 | + * diversa da $label |
| 30 | + * - view() => funzione che stampa l'HTML; lascia vuoto se |
| 31 | + * verrà usato un semplice layout dove ogni sezione è un tab. |
| 32 | + * |
| 33 | + * Ricordati di caricare la classe nel bootstrap del tuo plugin. |
| 34 | + */ |
| 35 | +abstract class SettingsPage { |
| 36 | + |
| 37 | + /** |
| 38 | + * Nome della pagina, apparirà sia come titolo della pagina che |
| 39 | + * come etichetta della voce di menu |
| 40 | + */ |
| 41 | + protected $label; // obbligatorio |
| 42 | + |
| 43 | + /** |
| 44 | + * Slug della pagina |
| 45 | + */ |
| 46 | + protected $slug; // obbligatorio |
| 47 | + |
| 48 | + /** |
| 49 | + * Posizione della voce di menu nella sidebar |
| 50 | + */ |
| 51 | + protected $position = null; |
| 52 | + |
| 53 | + /** |
| 54 | + * Menu madre a cui far appartenere questa pagina (ad es. |
| 55 | + * options-general.php). |
| 56 | + * |
| 57 | + * Se lasci vuoto, verrà creato appositamente un nuovo menu |
| 58 | + * madre con slug $parentSlug e con etichetta $label. |
| 59 | + */ |
| 60 | + protected $parentSlug = ''; |
| 61 | + |
| 62 | + /** |
| 63 | + * Etichetta del menu madre. Lascia vuoto se vuoi che coincida |
| 64 | + * con $label, oppure se il menu non ha altre pagine oltre |
| 65 | + * questa. |
| 66 | + * |
| 67 | + * Ignorata se viene specificato un valore per $parentSlug. |
| 68 | + */ |
| 69 | + protected $menuLabel = ''; |
| 70 | + /** |
| 71 | + * Priorità della voce di menu nel filtro WordPress admin_menu |
| 72 | + */ |
| 73 | + protected $filterPriority = 10; |
| 74 | + |
| 75 | + /** |
| 76 | + * Istanza della classe che si interfaccia con le |
| 77 | + * Settings API di WordPress; verrà impostato nel |
| 78 | + * constructor automaticamente |
| 79 | + */ |
| 80 | + private $api; |
| 81 | + |
| 82 | + public function __construct() { |
| 83 | + $this->api = new SettingsApi; |
| 84 | + add_action( 'admin_menu', array( $this, 'admin_menu' ), $this->filterPriority ); |
| 85 | + add_action( 'admin_init', array( $this, 'admin_init' ) ); |
| 86 | + } |
| 87 | + |
| 88 | + /** |
| 89 | + * Callback che registra tutti i nostri settings usando l'API |
| 90 | + */ |
| 91 | + public function admin_init() { |
| 92 | + $this->api->set_sections( $this->getSections() ); |
| 93 | + $this->api->set_fields( $this->getFields() ); |
| 94 | + $this->api->admin_init(); |
| 95 | + } |
| 96 | + |
| 97 | + /** |
| 98 | + * Aggiungi alla sidebar la voce di menu |
| 99 | + */ |
| 100 | + public function admin_menu() { |
| 101 | + // Se la pagina è una sottovoce di un menu madre esistente... |
| 102 | + if ( ! empty( $this->parentSlug ) ) { |
| 103 | + add_submenu_page( $this->parentSlug, $this->label, $this->label, 'manage_options', $this->slug, [ $this, 'view' ], $this->position ); |
| 104 | + } |
| 105 | + // Se il menu madre va creato... |
| 106 | + else { |
| 107 | + // Caso in cui l'etichetta del menu madre è diversa da quella |
| 108 | + // della sottovoce di menu (https://wordpress.stackexchange.com/a/66499/86662) |
| 109 | + if ( ! empty( $this->menuLabel ) ) { |
| 110 | + add_menu_page( $this->menuLabel, $this->menuLabel, 'manage_options', $this->slug, '__return_true', '', $this->position ); |
| 111 | + add_submenu_page( $this->slug, $this->label, $this->label, 'manage_options', $this->slug, [ $this, 'view' ] ); |
| 112 | + } |
| 113 | + // Caso in cui non ci interessa differenziare, ad es. perché non ci sono |
| 114 | + // altre pagine di menu nel menu madre |
| 115 | + else { |
| 116 | + add_menu_page( $this->label, $this->label, 'manage_options', $this->slug, [ $this, 'view' ], '', $this->position ); |
| 117 | + } |
| 118 | + } |
| 119 | + } |
| 120 | + |
| 121 | + /** |
| 122 | + * Funzione usata per renderizzare l'HTML; di default usiamo |
| 123 | + * il layout a tabs. |
| 124 | + */ |
| 125 | + public function view() { |
| 126 | + $this->view_template_tabs(); |
| 127 | + } |
| 128 | + |
| 129 | + /** |
| 130 | + * Template che mostra un tab per ogni sezione |
| 131 | + */ |
| 132 | + protected function view_template_tabs() { |
| 133 | + echo '<div class="wrap ' . 'admin-options-' . $this->slug . '">'; |
| 134 | + $this->api->show_navigation(); |
| 135 | + $this->api->show_forms(); |
| 136 | + echo '</div>'; |
| 137 | + } |
| 138 | + |
| 139 | +} |
0 commit comments