web-dev-qa-db-ja.com

Add_filterを使用するのに最適な場所はどこですか

私のプラグインのinitアクションフックでadd_filter関数を使うべきですか、それとも単にメインのプラグインスクリプトで使うべきですか？

時々私は人々があちこちでフィルタを使っているのを見つけて、そして私がinitフックに入れるならば、それはある場合には遅すぎるでしょう。

より一貫したコードスタイルを持つことができるように、action＆filterフックの優先順位に関する一般的なアドバイスはありますか？

pluginsplugin-developmentfiltersactions
10
Yoga

add_filter()とadd_action()はプラグインがロードされる前に利用可能です。そのため、プラグインまたはテーマの最初の行で両方を使用できます。

読みやすくするために、メインファイルの一番上にアクションを登録し、登録をフィルタ処理することをお勧めします。

  • プラグインでは、プラグインヘッダを持つファイル
  • テーマの中ではfunctions.php

その規則には例外があります。

  • 連鎖コールバック 。 この例wp_nav_menu_objectsの最初のフィルタが呼び出されたときだけ、shutdownのアクションを登録します。そのため、2番目のコールバックを最初のコールバックと同時に登録することはできません。

  • OOPスタイルコールバックを登録する前にクラスメンバーを設定しなければならないことがあります。 非常によく似た例 …を使う

    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
    }
}

    …クラスのインスタンス化が別のプラグインによって停止される可能性があり、子クラスはより多くの、または異なるフィルタとアクションを登録することができます。

グループ化に加えて、さらに一歩進んで他の開発者向けのカスタマイズを容易にするためのカスタムアクションを提供できます。
これは私が取り組んでいるテーマの一例です。

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' );

最後の行は重要です：子テーマやプラグインは今すぐt5_theme_hooks_registeredアクションにフックでき、以前のフックは登録解除できます。それは 優先度との戦い を節約するでしょう、そして私はいつでも my コールバックの優先度を変更することが自由です。

しかし、ソースコードの順序だけに頼らないでください。あなたがあなたのdocブロックに使用しているフックを記録してください。そのためにカスタムタグwp-hookを使用しています。これは同じテーマからのチェーンフックの例です。

/**
 * 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 );
}

これらの関数がどこで呼び出されているかを見るために上にスクロールする必要はありません。docブロックを見れば十分です。登録とコメントの両方を同期させる必要があるため、これにはある程度の労力が必要ですが、長期的には貴重な時間を節約できます。

12
fuxia