add_filter()
i add_action()
są dostępne przed załadowaniem jakiejkolwiek wtyczki. Możesz więc używać obu w pierwszym wierszu wtyczki lub motywu.
W celu zapewnienia czytelności zalecam grupowanie rejestracji akcji i filtrowanie u góry głównego pliku:
- we wtyczce plik z nagłówkiem wtyczki
- w temacie
functions.php
Istnieją wyjątki od tej reguły:
- Przykuty oddzwanianie . W tym przykładzie rejestruję akcję
shutdown
tylko wtedy, gdy wp_nav_menu_objects
został wywołany pierwszy filtr dla . Dlatego drugiego połączenia zwrotnego nie można zarejestrować w tym samym czasie, co pierwsze.
Styl OOP. Czasami musisz skonfigurować członków klasy, aby móc zarejestrować połączenia zwrotne. Korzystając z bardzo podobnego przykładu …
add_action(
'plugins_loaded',
array ( T5_Plugin_Class_Demo::get_instance(), 'plugin_setup' )
);
class T5_Plugin_Class_Demo
{
public function plugin_setup()
{
$this->plugin_url = plugins_url( '/', __FILE__ );
$this->plugin_path = plugin_dir_path( __FILE__ );
$this->load_language( 'plugin_unique_name' );
// more stuff: register actions and filters
}
}
… Widzimy, że tworzenie instancji klasy może zostać zatrzymane przez inną wtyczkę, a klasa potomna może zarejestrować więcej lub różne filtry i akcje.
Oprócz grupowania możesz pójść o krok dalej i zaoferować niestandardowe działanie, aby ułatwić dostosowanie dla innych programistów.
Oto przykład z motywu, nad którym pracuję:
add_action( 'activate_header', 't5_activate_screen' );
// wp_loaded is too late, WP customizer would not detect the features then.
add_action( 'after_setup_theme', 't5_setup_custom_background' );
add_action( 'after_setup_theme', 't5_setup_custom_header' );
add_filter( 'body_class', 't5_enhance_body_class' );
add_action( 'comment_form_before', 't5_enqueue_comment_reply' );
add_action( 'content_before', 't5_frontpage_widget' );
add_action( 'footer_before', 't5_loop_navigation' );
add_action( 'get_the_excerpt', 't5_excerpt_clean_up', 1 );
add_action( 'header_before', 't5_skiplink', 0, 0 );
add_filter( 'the_title', 't5_fill_empty_title', 20, 1 );
add_action( 'wp_enqueue_scripts', 't5_enqueue_style' );
add_action( 'wp_enqueue_scripts', 't5_enqueue_script' );
add_action( 'wp_loaded', 't5_setup' );
add_action( 'wp_loaded', 't5_page_enhancements' );
add_action( 'wp_loaded', 't5_post_format_support' );
add_action( 'wp_loaded', 't5_load_theme_language' );
add_action( 'wp_loaded', 't5_setup_sidebars' );
add_filter( 'wp_nav_menu_items', 't5_customize_top_menu', 10, 2 );
add_filter( 'wp_nav_menu_args', 't5_nav_menu_args', 10, 1 );
add_filter( 'wp_title', 't5_wp_title_filter', 20, 2 );
add_shortcode( 'gallery', 't5_shortcode_gallery' );
add_shortcode( 'wp_caption', 't5_shortcode_img_caption' );
add_shortcode( 'caption', 't5_shortcode_img_caption' );
// Use this action to unregister theme actions and filters.
do_action( 't5_theme_hooks_registered' );
Ostatnia linia jest ważna: motyw potomny lub wtyczka mogą teraz dołączyć do akcji t5_theme_hooks_registered
i wyrejestrować poprzedni zaczep. Że uratuje zmaga się z priorytetami , a ja jestem wolny, aby zmienić moje priorytety wywołań zwrotnych w dowolnym momencie.
Ale nie polegaj wyłącznie na porządku kodu źródłowego. Dokumentuj haki, których używasz w swoim bloku dokumentów. Używam do tego niestandardowego tagu wp-hook
. Oto przykład z połączonymi hakami z tego samego tematu:
/**
* Register handler for auto-generated excerpt.
*
* @wp-hook get_the_excerpt
* @param string $excerpt
* @return string
*/
function t5_excerpt_clean_up( $excerpt )
{
if ( ! empty ( $excerpt ) )
return $excerpt;
add_filter( 'the_content', 't5_excerpt_content' );
return $excerpt;
}
/**
* Strip parts from auto-generated excerpt.
*
* @wp-hook the_content
* @param string $content
* @return string
*/
function t5_excerpt_content( $content )
{
remove_filter( current_filter(), __FUNCTION__ );
return preg_replace( '~<(pre|table).*</\1>~ms', '', $content );
}
Nie musisz przewijać w górę, aby zobaczyć, gdzie wywoływane są te funkcje, wystarczy jedno spojrzenie na blok dokumentów. Wymaga to trochę wysiłku, ponieważ musisz zachować synchronizację, rejestrację i komentarz, ale na dłuższą metę oszczędza to cenny czas.