Changeset 47455 for trunk

Timestamp:

03/14/2020 03:59:22 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Toolbar: Move the logic for rendering the admin bar on wp_footer to wp_admin_bar_render().

Clarify in the function documentation that it is now called on wp_body_open action first, with wp_footer as a fallback.

Follow-up to [47221].

Fixes #47053.

Location:

trunk/src/wp-includes

Files:

• admin-bar.php (modified) (3 diffs)
• default-filters.php (modified) (1 diff)
• general-template.php (modified) (1 diff)

trunk/src/wp-includes/admin-bar.php

@@ -56 +56 @@
  * Renders the admin bar to the page based on the $wp_admin_bar->menu member var.
  *
- * This is called very late on the footer actions so that it will render after
- * anything else being added to the footer.
+ * This is called very early on the {@see 'wp_body_open'} action so that it will render
+ * before anything else being added to the page body.
+ *
+ * For backward compatibility with themes not using the 'wp_body_open' action,
+ * the function is also called late on {@see 'wp_footer'}.
  *
  * It includes the {@see 'admin_bar_menu'} action which should be used to hook in and
@@ -65 +68 @@
  *
  * @since 3.1.0
+ * @since 5.4.0 Called on 'wp_body_open' action first, with 'wp_footer' as a fallback.
  *
  * @global WP_Admin_Bar $wp_admin_bar
+ *
+ * @staticvar bool $rendered
  */
 function wp_admin_bar_render() {
     global $wp_admin_bar;
+    static $rendered = false;
+
+    if ( $rendered ) {
+        return;
+    }
 
     if ( ! is_admin_bar_showing() || ! is_object( $wp_admin_bar ) ) {
@@ -101 +112 @@
      */
     do_action( 'wp_after_admin_bar_render' );
+
+    $rendered = true;
 }
 

trunk/src/wp-includes/default-filters.php

@@ -539 +539 @@
 add_action( 'activate_header', '_wp_admin_bar_init' );
 add_action( 'wp_body_open', 'wp_admin_bar_render', 0 );
+add_action( 'wp_footer', 'wp_admin_bar_render', 1000 ); // Back-compat for themes not using `wp_body_open`.
 add_action( 'in_admin_header', 'wp_admin_bar_render', 0 );
 

trunk/src/wp-includes/general-template.php

@@ -2894 +2894 @@
 function wp_footer() {
     /**
-     * Sets up the Admin Bar if the current theme does not use `wp_body_open`.
-     *
-     * @since 5.4.0
-     */
-    if ( ! did_action( 'wp_body_open' ) ) {
-        add_action( 'wp_footer', 'wp_admin_bar_render', 1000 );
-    }
-    /**
      * Prints scripts or data before the closing body tag on the front end.
      *