Organizarea Codului în Fișierul functions.php al Temei WordPress

Răspuns întârziat

Cum să includ fișierele corect:

function wpse1403_bootstrap()
{
    // Aici încărcăm din directorul nostru de includes
    // Acest lucru ia în considerare atât tema părinte cât și tema copil    
    locate_template( array( 'inc/foo.class.php' ), true, true );
}
add_action( 'after_setup_theme', 'wpse1403_bootstrap' );

Același lucru funcționează și în plugin-uri.

Cum să obții calea sau URL-ul corect

De asemenea, aruncați o privire la funcțiile API-ului pentru sistemul de fișiere, cum ar fi:

• home_url()
• plugin_dir_url()
• plugin_dir_path()
• admin_url()
• get_template_directory()
• get_template_directory_uri()
• get_stylesheet_directory()
• get_stylesheet_directory_uri()
• etc.

Cum să reduci numărul de include/require

Dacă trebuie să încarci toate fișierele dintr-un director, folosește

foreach ( glob( 'path/to/folder/*.php' ) as $file )
    include $file;

Ține minte că această metodă ignoră erorile (poate fi bună pentru producție)/fișierele care nu pot fi încărcate.

Pentru a modifica acest comportament, poți folosi o configurație diferită în timpul dezvoltării:

$files = ( defined( 'WP_DEBUG' ) AND WP_DEBUG )
    ? glob( 'path/to/folder/*.php', GLOB_ERR )
    : glob( 'path/to/folder/*.php' )

foreach ( $files as $file )
    include $file;

Editare: Abordare OOP/SPL

Revenind și văzând că acest răspuns primește din ce în ce mai multe voturi, m-am gândit să arăt cum fac asta în prezent - într-o lume cu PHP 5.3+. Următorul exemplu încarcă toate fișierele dintr-un subfolder al temei numit src/. Aici am bibliotecile care se ocupă de anumite sarcini precum meniuri, imagini, etc. Nu trebuie să te preocupi de nume, deoarece fiecare fișier este încărcat. Dacă ai alte subfoldere în acest director, acestea sunt ignorate.

\FilesystemIterator este înlocuitorul PHP 5.3+ pentru \DirectoryIterator. Ambele fac parte din PHP SPL. În timp ce PHP 5.2 permitea dezactivarea extensiei SPL (sub 1% din instalații făceau asta), acum SPL face parte din nucleul PHP.

<?php

namespace Theme;

$files = new \FilesystemIterator( __DIR__.'/src', \FilesystemIterator::SKIP_DOTS );
foreach ( $files as $file )
{
    /** @noinspection PhpIncludeInspection */
    ! $files->isDir() and include $files->getRealPath();
}

Anterior, când încă suportam PHP 5.2.x, foloseam următoarea soluție: Un \FilterIterator în directorul src/Filters pentru a prelua doar fișierele (și nu pointerii de foldere) și un \DirectoryIterator pentru buclă și încărcare.

namespace Theme;

use Theme\Filters\IncludesFilter;

$files = new IncludesFilter( new \DirectoryIterator( __DIR__.'/src' ) );
foreach ( $files as $file )
{
    include_once $files->current()->getRealPath();
}

\FilterIterator era la fel de simplu:

<?php

namespace Theme\Filters;

class IncludesFilter extends \FilterIterator
{
    public function accept()
    {
        return
            ! $this->current()->isDot()
            and $this->current()->isFile()
            and $this->current()->isReadable();
    }
}

Pe lângă faptul că PHP 5.2 este mort/EOL acum (și 5.3 de asemenea), mai este și faptul că este mai mult cod și încă un fișier în joc, așa că nu există niciun motiv să folosești versiunea mai veche și să suporți PHP 5.2.x.

Rezumat

EDITARE Modul evident corect este să folosești cod cu namespace, pregătit pentru încărcarea automată PSR-4 prin plasarea tuturor în directorul corespunzător definit prin namespace. Apoi folosește Composer și un composer.json pentru a gestiona dependențele și lasă-l să construiască automat încărcătorul PHP (care importă automat un fișier prin simplul apel use \<namespace>\ClassName). Acesta este standardul de facto în lumea PHP, cel mai simplu mod de a proceda și chiar mai automatizat și simplificat de WP Starter.

Îmi place să folosesc o funcție pentru fișierele dintr-un folder. Această abordare facilitează adăugarea de noi funcționalități atunci când adaug fișiere noi. Dar scriu întotdeauna în clase sau cu namespace-uri - oferă mai mult control asupra Namespace-ului funcțiilor, metodelor etc.

Mai jos un mic exemplu; dar folosesc și acordul despre class*.php

public function __construct() {

    $this->load_classes();
}

/**
 * Returnează un array de funcționalități, de asemenea
 * Scanează subfolderul pluginului "/classes"
 *
 * @since   0.1
 * @return  void
 */
protected function load_classes() {

    // încarcă toate fișierele cu modelul class-*.php din directorul classes
    foreach( glob( dirname( __FILE__ ) . '/classes/class-*.php' ) as $class )
        require_once $class;

}

În teme folosesc adesea un alt scenariu. Definești funcția fișierului extern într-un ID de suport, vezi exemplul. Acest lucru este util dacă vreau să dezactivez ușor funcționalitatea fișierului extern. Folosesc funcția WP core require_if_theme_supports() și se încarcă doar dacă ID-ul de suport este activ. În exemplul următor am definit acest ID de suport în linia dinainte de încărcarea fișierului.

    /**
     * Adaugă suport pentru Theme Customizer
     * 
     * @since  09/06/2012
     */
    add_theme_support( 'documentation_customizer', array( 'all' ) );
    // Include theme customizer pentru opțiunile temei, dacă tema are suport
    require_if_theme_supports( 
        'documentation_customizer',
        get_template_directory() . '/inc/theme-customize.php'
    );

Puteți vedea mai multe despre acest lucru în repo-ul acestei teme.

În ceea ce privește organizarea codului, în șablonul meu folosesc o funcție personalizată pentru a căuta un director numit "functions" în directorul temei. Dacă acesta nu există, îl creează. Apoi creează un array cu toate fișierele .php găsite în acel folder (dacă există) și rulează un include(); pentru fiecare dintre ele.

Astfel, de fiecare dată când am nevoie să adaug o nouă funcționalitate, pur și simplu adaug un fișier PHP în folderul "functions" și nu trebuie să mă preocup să-l integrez manual în site.

<?php
/* 
FUNCȚII pentru includerea automată a documentelor PHP din folderul functions.
*/
//dacă rulează pe php4, creează o funcție scandir
if (!function_exists('scandir')) {
  function scandir($directory, $sorting_order = 0) {
    $dh = opendir($directory);
    while (false !== ($filename = readdir($dh))) {
      $files[] = $filename;
    }
    if ($sorting_order == 0) {
      sort($files);
    } else {
      rsort($files);
    }
    return ($files);
  }
}
/*
* Această funcție returnează calea către folderul functions.
* Dacă folderul nu există, îl creează.
*/
function get_function_directory_extension($template_url = FALSE) {
  //obține URL-ul șablonului dacă nu este pasat
  if (!$template_url)$template_url = get_bloginfo('template_directory');


  //înlocuiește slash-urile cu puncte pentru explode
  $template_url_no_slash = str_replace('/', '.', $template_url);

  //creează array din URL
  $template_url_array = explode('.', $template_url_no_slash);

  //--taie array-ul

  //Calculează offset (avem nevoie doar de ultimele trei niveluri)
  //Este necesar pentru a obține directorul corect, nu cel pasat de server, deoarece scandir nu funcționează când sunt implicate alias-uri.
  $offset = count($template_url_array) - 3;

  //taie array-ul, păstrând doar până la folderul rădăcină WP (unde se află wp-config.php, de unde rulează front-end-ul)
  $template_url_array = array_splice($template_url_array, $offset, 3);
  //reconstruiește ca string
  $template_url_return_string = implode('/', $template_url_array);
  fb::log($template_url_return_string, 'Șablon'); //firephp

  //creează directorul curent de lucru cu extensia șablonului și directorul functions    
  //dacă e în admin, iese din folderul admin înainte de a stoca directorul de lucru, apoi revine
  if (is_admin()) {
    $admin_directory = getcwd();
    chdir("..");
    $current_working_directory = getcwd();
    chdir($admin_directory);
  } else {
    $current_working_directory = getcwd();
  }
  fb::log($current_working_directory, 'Director'); //firephp

  //metodă alternativă dacă chdir nu funcționează pe serverul tău (unele servere Windows s-ar putea să nu o suporte)
  //if (is_admin()) $current_working_directory = str_replace('/wp-admin','',$current_working_directory);

  $function_folder = $current_working_directory . '/' . $template_url_return_string . '/functions';


  if (!is_dir($function_folder)) mkdir($function_folder); //creează folderul dacă nu există deja (lazy, dar util... oarecum)
  //returnează calea
  return $function_folder;

}

//elimină elementele din array care nu au extensia .php
function only_php_files($scan_dir_list = false) {
  if (!$scan_dir_list || !is_array($scan_dir_list)) return false; //dacă elementul nu este dat sau nu este array, iese din funcție.
  foreach ($scan_dir_list as $key => $value) {
    if (!strpos($value, '.php')) {

      unset($scan_dir_list[$key]);
    }
  }
  return $scan_dir_list;
}
//rulează funcțiile pentru a crea folderul functions, îl selectează,
//îl scanează, filtrează doar documentele PHP apoi le include în functions

add_action('wp_head', fetch_php_docs_from_functions_folder(), 1);
function fetch_php_docs_from_functions_folder() {

  //obține directorul functions
  $functions_dir = get_function_directory_extension();
  //scanează directorul și elimină documentele non-PHP
  $all_php_docs = only_php_files(scandir($functions_dir));

  //include documentele PHP
  if (is_array($all_php_docs)) {
    foreach ($all_php_docs as $include) {
      include($functions_dir . '/' . $include);
    }
  }

}

Administrez un site cu aproximativ 50 de tipuri unice de pagini personalizate în mai multe limbi diferite, instalat pe o rețea. Împreună cu o TONĂ de plugin-uri.

Am fost nevoiți să împărțim totul la un moment dat. Un fișier functions.php cu 20-30k de linii de cod nu este deloc amuzant.

Am decis să refactorizăm complet tot codul pentru a gestiona mai bine baza de cod. Structura implicită a temei WordPress este bună pentru site-uri mici, dar nu și pentru cele mai mari.

Noul nostru functions.php conține doar ceea ce este necesar pentru a porni site-ul, dar nimic care aparține unei anumite pagini.

Layout-ul temei pe care îl folosim acum este similar cu modelul de design MCV, dar într-un stil de codare procedural.

De exemplu, pagina noastră pentru membri:

page-member.php. Responsabilă pentru inițializarea paginii. Apelarea funcțiilor corecte AJAX sau similare. Ar putea fi echivalentă cu partea de Controller în stilul MCV.

functions-member.php. Conține toate funcțiile legate de această pagină. Acesta este inclus și în alte pagini care au nevoie de funcții pentru membrii noștri.

content-member.php. Pregătește datele pentru HTML. Ar putea fi echivalentă cu Modelul în MCV.

layout-member.php. Partea HTML.

După ce am făcut aceste modificări, timpul de dezvoltare a scăzut cu ușurință cu 50%, iar acum proprietarul produsului are probleme să ne dea noi task-uri. :)

Din fișierul functions.php al temei copil:

    require_once( get_stylesheet_directory() . '/inc/custom.php' );

În functions.php, o modalitate mai elegantă de a apela un fișier necesar ar fi:

require_once locate_template('/inc/functions/shortcodes.php');

Am combinat răspunsurile lui @kaiser și @mikeschinkel.

Am toate personalizările pentru tema mea într-un folder /includes, iar în interiorul acestui folder am totul organizat în subfoldere.

Vreau ca doar /includes/admin și conținutul său să fie inclus când true === is_admin().

Dacă un folder este exclus în iterator_check_traversal_callback prin returnarea valorii false, atunci subdirectoarele sale nu vor fi iterate (sau transmise către iterator_check_traversal_callback).

/**
 *  Încarcă toate personalizările din /includes
 */
$includes_import_root = 
    new \RecursiveDirectoryIterator( __DIR__ . '/includes', \FilesystemIterator::SKIP_DOTS );

function iterator_check_traversal_callback( $current, $key, $iterator ) {
    $file_name = $current->getFilename();

    // Include doar fișierele *.php
    if ( ! $current->isDir() ) {
        return preg_match( '/^.+\.php$/i', $file_name );
    }

    // Nu include folderul /includes/admin când este site-ul public
    return 'admin' === $file_name
        ? is_admin()
        : true;
}

$iterator_filter = new \RecursiveCallbackFilterIterator(
    $includes_import_root, 'iterator_check_traversal_callback'
);

foreach ( new \RecursiveIteratorIterator( $iterator_filter ) as $file ) {
    include $file->getRealPath();
}