Changeset 47467 for branches/5.4/src/wp-includes/admin-bar.php

Timestamp:

03/17/2020 07:26:34 PM (4 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].

Reviewed by whyisjake, SergeyBiryukov.
Merges [47455] to the 5.4 branch.
Fixes #47053.

Location:

branches/5.4

Files:

• . (modified) (1 prop)
• src/wp-includes/admin-bar.php (modified) (3 diffs)

branches/5.4/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;
 }