Ticket #7335: 7335-anonymous-actions.2.diff

src/bp-core/bp-core-actions.php

@@ -30 +30 @@
  *
  *           v--WordPress Actions       v--BuddyPress Sub-actions
  */
-add_action( 'plugins_loaded',          'bp_loaded',                 10    );
-add_action( 'init',                    'bp_init',                   10    );
-add_action( 'rest_api_init',           'bp_rest_api_init',          20    ); // After WP core.
-add_action( 'customize_register',      'bp_customize_register',     20    ); // After WP core.
+add_action( 'plugins_loaded',          function() {
+
+        /**
+         * Fires on the 'plugins_loaded' hook, which fires after BP's core plugin files have been loaded.
+         *
+         * @since 1.2.5
+         */
+        do_action( 'bp_loaded' );
+}, 10 );
+add_action( 'init',                    function() {
+
+        /**
+         * Fires on the 'init' hook, BuddyPress' main initialization hook.
+         *
+         * @since 1.2.0
+         */
+        do_action( 'bp_init' );
+}, 10 );
+add_action( 'rest_api_init',           function() {
+
+        /**
+         * Fires on the 'rest_api_init' hook, where BuddyPress registers REST API endpoints.
+         *
+         * @since 2.6.0
+         */
+        do_action( 'bp_rest_api_init' );
+}, 20 ); // After WP core.
+add_action( 'customize_register',      function( WP_Customize_Manager $customizer ) {
+
+        /**
+         * Fires once the Customizer has loaded, allow scripts and styles to be initialized.
+         *
+         * @since 2.5.0
+         *
+         * @param WP_Customize_Manager $customizer Customizer instance.
+         */
+        do_action( 'bp_customize_register', $customizer );
+}, 20 ); // After WP core.
 add_action( 'parse_query',             'bp_parse_query',            2     ); // Early for overrides.
-add_action( 'wp',                      'bp_ready',                  10    );
-add_action( 'set_current_user',        'bp_setup_current_user',     10    );
-add_action( 'setup_theme',             'bp_setup_theme',            10    );
-add_action( 'after_setup_theme',       'bp_after_setup_theme',      100   ); // After WP themes.
-add_action( 'wp_enqueue_scripts',      'bp_enqueue_scripts',        10    );
-add_action( 'enqueue_embed_scripts',   'bp_enqueue_embed_scripts',  10    );
-add_action( 'admin_bar_menu',          'bp_setup_admin_bar',        20    ); // After WP core.
-add_action( 'template_redirect',       'bp_template_redirect',      10    );
-add_action( 'widgets_init',            'bp_widgets_init',           10    );
-add_action( 'generate_rewrite_rules',  'bp_generate_rewrite_rules', 10    );
+add_action( 'wp',                      function() {
+
+        /**
+         * Fires on the 'wp' hook, which runs after BP is set up and the page is about to render.
+         *
+         * @since 1.6.0
+         */
+        do_action( 'bp_ready' );
+}, 10 );
+add_action( 'set_current_user',        function() {
+
+        /**
+         * Fires on the set_current_user hook for the current user setup process.
+         *
+         * @since 1.7.0
+         */
+        do_action( 'bp_setup_current_user' );
+}, 10 );
+add_action( 'setup_theme',             function() {
+
+        /**
+         * Fires on the 'setup_theme' hook.
+         *
+         * @since 1.6.0
+         */
+        do_action( 'bp_setup_theme' );
+}, 10 );
+add_action( 'after_setup_theme',       function() {
+
+        /**
+         * Fires on the 'after_setup_theme' hook.
+         *
+         * @since 1.7.0
+         */
+        do_action( 'bp_after_setup_theme' );
+}, 100 ); // After WP themes.
+add_action( 'wp_enqueue_scripts',      function() {
+
+        /**
+         * Fires on the 'wp_enqueue_scripts' hook, where BP enqueues its CSS and JS.
+         *
+         * @since 1.6.0
+         */
+        do_action( 'bp_enqueue_scripts' );
+}, 10 );
+add_action( 'enqueue_embed_scripts',   function() {
+
+        if ( ! is_buddypress() ) {
+                return;
+        }
+
+        /**
+         * Enqueue CSS and JS files for BuddyPress embeds.
+         *
+         * @since 2.6.0
+         */
+        do_action( 'bp_enqueue_embed_scripts' );
+}, 10 );
+add_action( 'admin_bar_menu',          function() {
+        if ( bp_use_wp_admin_bar() ) {
+
+                /**
+                 * Fires on the 'admin_bar_menu' hook, where plugins should add items to the WP admin bar.
+                 *
+                 * This hook will only fire if bp_use_wp_admin_bar() returns true.
+                 *
+                 * @since 1.5.0
+                 */
+                do_action( 'bp_setup_admin_bar' );
+        }
+}, 20 ); // After WP core.
+add_action( 'template_redirect',       function() {
+
+        /**
+         * Fires on the 'template_redirect' hook.
+         *
+         * @since 1.6.0
+         */
+        do_action( 'bp_template_redirect' );
+}, 10 );
+add_action( 'widgets_init',            function() {
+
+        /**
+         * Fires on the 'widgets_init' hook, which runs after widgets have been set up.
+         *
+         * Hooked to 'widgets_init'.
+         *
+         * @since 1.6.0
+         */
+        do_action( 'bp_widgets_init' );
+}, 10 );
+add_action( 'generate_rewrite_rules',  function( $wp_rewrite ) {
+
+        /**
+         * Fires on the 'generate_rewrite_rules' hook.
+         *
+         * @since 1.7.0
+         *
+         * @param WP_Rewrite $wp_rewrite WP_Rewrite object. Passed by reference.
+         */
+        do_action_ref_array( 'bp_generate_rewrite_rules', array( &$wp_rewrite ) );
+}, 10 );
 
 /**
  * The bp_loaded hook - Attached to 'plugins_loaded' above.
@@ -53 +179 @@
  * The load order helps to execute code at the correct time.
  *                                                      v---Load order
  */
-add_action( 'bp_loaded', 'bp_setup_components',         2  );
-add_action( 'bp_loaded', 'bp_include',                  4  );
-add_action( 'bp_loaded', 'bp_setup_cache_groups',       5  );
-add_action( 'bp_loaded', 'bp_setup_widgets',            6  );
-add_action( 'bp_loaded', 'bp_register_theme_packages',  12 );
-add_action( 'bp_loaded', 'bp_register_theme_directory', 14 );
+add_action( 'bp_loaded', function() {
+
+        /**
+         * Fires on the 'bp_loaded' action, where plugins should initialize components.
+         *
+         * @since 1.6.0
+         */
+        do_action( 'bp_setup_components' );
+}, 2 );
+
+add_action( 'bp_loaded', function() {
+
+        /**
+         * Fires on the 'bp_loaded' action, where plugins should include files.
+         *
+         * @since 1.2.5
+         */
+         do_action( 'bp_include' );
+}, 4 );
+add_action( 'bp_loaded', function() {
+
+        /**
+         * Fires on the 'bp_loaded' hook, where cache groups are registered.
+         *
+         * @since 2.2.0
+         */
+        do_action( 'bp_setup_cache_groups' );
+}, 5 );
+add_action( 'bp_loaded', function() {
+
+        /**
+         * Fires on the 'bp_loaded' hook, where plugins should register widgets.
+         *
+         * @since 1.2.0
+         */
+        do_action( 'bp_register_widgets' );
+}, 6 );
+add_action( 'bp_loaded', function() {
+
+        /**
+         * Fires on the 'bp_loaded' hook.
+         *
+         * @since 1.7.0
+         */
+        do_action( 'bp_register_theme_packages' );
+}, 12 );
+add_action( 'bp_loaded', function() {
+
+        /**
+         * Fires on the 'bp_loaded' function.
+         *
+         * The main action used registering theme directories.
+         *
+         * @since 1.7.0
+         */
+        do_action( 'bp_register_theme_directory' );
+}, 14 );
 
 /**
  * The bp_init hook - Attached to 'init' above.
@@ -67 +244 @@
  * The load order helps to execute code at the correct time.
  *                                                   v---Load order
  */
-add_action( 'bp_init', 'bp_register_post_types',     2  );
-add_action( 'bp_init', 'bp_register_taxonomies',     2  );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where plugins should register post types.
+         *
+         * @since 2.5.0
+         */
+        do_action( 'bp_register_post_types' );
+}, 2 );
+
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where plugins should register taxonomies.
+         *
+         * @since 2.2.0
+         */
+        do_action( 'bp_register_taxonomies' );
+}, 2 );
+
 add_action( 'bp_init', 'bp_core_set_uri_globals',    2  );
-add_action( 'bp_init', 'bp_setup_globals',           4  );
-add_action( 'bp_init', 'bp_setup_canonical_stack',   5  );
-add_action( 'bp_init', 'bp_setup_nav',               6  );
-add_action( 'bp_init', 'bp_setup_title',             8  );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where plugins should initialize global settings.
+         *
+         * @since 1.2.0
+         */
+        do_action( 'bp_setup_globals' );
+}, 4 );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where plugins should set up their canonical URL.
+         *
+         * @since 2.1.0
+         */
+        do_action( 'bp_setup_canonical_stack' );
+}, 5 );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where plugins should register their navigation items.
+         *
+         * @since 1.2.0
+         */
+        do_action( 'bp_setup_nav' );
+}, 6 );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where plugins should modify the page title.
+         *
+         * @since 1.5.0
+         */
+        do_action( 'bp_setup_title' );
+}, 8 );
 add_action( 'bp_init', 'bp_core_load_admin_bar_css', 12 );
-add_action( 'bp_init', 'bp_add_rewrite_tags',        20 );
-add_action( 'bp_init', 'bp_add_rewrite_rules',       30 );
-add_action( 'bp_init', 'bp_add_permastructs',        40 );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where BP adds its custom rewrite tags.
+         *
+         * @since 1.8.0
+         */
+        do_action( 'bp_add_rewrite_tags' );
+}, 20 );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where BP adds its custom rewrite rules.
+         *
+         * @since 1.9.0
+         */
+        do_action( 'bp_add_rewrite_rules' );
+}, 30 );
+add_action( 'bp_init', function() {
+
+        /**
+         * Fires on the 'bp_init' hook, where BP adds its BP-specific permalink structure.
+         *
+         * @since 1.9.0
+         */
+        do_action( 'bp_add_permastructs' );
+}, 40 );
 
 /**
  * The bp_register_taxonomies hook - Attached to 'bp_init' @ priority 2 above.
  */
-add_action( 'bp_register_taxonomies', 'bp_register_member_types' );
+add_action( 'bp_register_taxonomies', function() {
+
+        /**
+         * Fires on the bp_register_taxonomies hook, so plugins can register member types.
+         *
+         * @since 2.3.0
+         */
+        do_action( 'bp_register_member_types' );
+} );
 
 /**
  * The bp_template_redirect hook - Attached to 'template_redirect' above.
@@ -96 +355 @@
  *                                                           v---Load order
  */
 add_action( 'bp_template_redirect', 'bp_redirect_canonical', 2  );
-add_action( 'bp_template_redirect', 'bp_actions',            4  );
-add_action( 'bp_template_redirect', 'bp_screens',            6  );
-add_action( 'bp_template_redirect', 'bp_post_request',       10 );
-add_action( 'bp_template_redirect', 'bp_get_request',        10 );
+add_action( 'bp_template_redirect', function() {
+
+        /**
+         * Fires on the 'bp_actions' hook, which runs just before rendering.
+         *
+         * @since 1.5.0
+         */
+        do_action( 'bp_actions' );
+}, 4 );
+add_action( 'bp_template_redirect', function() {
+
+        /**
+         * Fires on the 'bp_template_redirect' hook, which runs just before rendering.
+         *
+         * Runs just after 'bp_actions'. Use this hook to attach your template loaders.
+         *
+         * @since 1.5.0
+         */
+        do_action( 'bp_screens' );
+}, 6 );
+add_action( 'bp_template_redirect', function() {
+
+        // Bail if not a POST action.
+        if ( ! bp_is_post_request() ) {
+                return;
+        }
+
+        // Bail if no action.
+        if ( empty( $_POST['action'] ) ) {
+                return;
+        }
+
+        // Sanitize the POST action.
+        $action = sanitize_key( $_POST['action'] );
+
+        /**
+         * Fires at the end of the bp_template_redirect callback for BuddyPress.
+         *
+         * This dynamic action is probably the one you want to use. It narrows down
+         * the scope of the 'action' without needing to check it in your function.
+         *
+         * @since 1.9.0
+         */
+        do_action( 'bp_post_request_' . $action );
+
+        /**
+         * Fires at the end of the bp_template_redirect callback for BuddyPress.
+         *
+         * Use this static action if you don't mind checking the 'action' yourself.
+         *
+         * @since 1.9.0
+         *
+         * @param string $action The action being run.
+         */
+        do_action( 'bp_post_request', $action );
+}, 10 );
+add_action( 'bp_template_redirect', function() {
+
+        // Bail if not a POST action.
+        if ( ! bp_is_get_request() ) {
+                return;
+        }
+
+        // Bail if no action.
+        if ( empty( $_GET['action'] ) ) {
+                return;
+        }
+
+        // Sanitize the GET action.
+        $action = sanitize_key( $_GET['action'] );
+
+        /**
+         * Fires at the end of the bp_template_redirect callback for BuddyPress.
+         *
+         * This dynamic action is probably the one you want to use. It narrows down
+         * the scope of the 'action' without needing to check it in your function.
+         *
+         * @since 1.9.0
+         */
+        do_action( 'bp_get_request_' . $action );
+
+        /**
+         * Fires at the end of the bp_template_redirect callback for BuddyPress.
+         *
+         * Use this static action if you don't mind checking the 'action' yourself.
+         *
+         * @since 1.9.0
+         *
+         * @param string $action The action being run.
+         */
+        do_action( 'bp_get_request', $action );
+}, 10 );
 
 /**
  * Add the BuddyPress functions file and the Theme Compat Default features.

src/bp-core/bp-core-filters.php

@@ -40 +40 @@
  *
  *           v--WordPress Actions       v--BuddyPress Sub-actions
  */
-add_filter( 'request',                 'bp_request',             10    );
-add_filter( 'template_include',        'bp_template_include',    10    );
-add_filter( 'login_redirect',          'bp_login_redirect',      10, 3 );
+add_filter( 'request',                 function( $query_vars = array() ) {
+
+        /**
+         * Filters the query_vars for the current request.
+         *
+         * @since 1.7.0
+         *
+         * @param array $query_vars Array of query variables.
+         */
+        return apply_filters( 'bp_request', $query_vars );
+}, 10 );
+add_filter( 'template_include',        function( $template = '' ) {
+
+        /**
+         * Filters the template to use with template_include.
+         *
+         * @since 1.6.0
+         *
+         * @param string $template The path of the template to include.
+         */
+        return apply_filters( 'bp_template_include', $template );
+}, 10 );
+add_filter( 'login_redirect',          function( $redirect_to = '', $redirect_to_raw = '', $user = false ) {
+
+        /**
+         * Filters the URL to redirect to after login.
+         *
+         * @since 1.7.0
+         *
+         * @param string           $redirect_to     The redirect destination URL.
+         * @param string           $redirect_to_raw The requested redirect destination URL passed as a parameter.
+         * @param WP_User|WP_Error $user            WP_User object if login was successful, WP_Error object otherwise.
+         */
+        return apply_filters( 'bp_login_redirect', $redirect_to, $redirect_to_raw, $user );
+}, 10, 3 );
 add_filter( 'map_meta_cap',            'bp_map_meta_caps',       10, 4 );
 
 // Add some filters to feedback messages.

src/bp-core/bp-core-theme-compatibility.php

@@ -720 +720 @@
 
                 // Add BuddyPress's head action to wp_head.
                 if ( ! has_action( 'wp_head', 'bp_head' ) ) {
-                        add_action( 'wp_head', 'bp_head' );
+                        add_action( 'wp_head', function() {
+
+                                /**
+                                 * Fires on the 'wp_head' hook, which runs on 'wp_head'.
+                                 *
+                                 * @since 1.6.0
+                                 */
+                                do_action( 'bp_head' );
+                        } );
                 }
         }