wp_body_open()

Fire the wp_body_open action.

Contents

Description Description

See ‘wp_body_open’.

Top ↑

Source Source

File: wp-includes/general-template.php 

function wp_body_open() {
	/**
	 * Triggered after the opening body tag.
	 *
	 * @since 5.2.0
	 */
	do_action( 'wp_body_open' );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/general-template.php: wp_body_open

Triggered after the opening body tag.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.

Top ↑

Changelog Changelog

Changelog
Version Description
5.2.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note
    Contributed by Rami Yushuvaev —

    WordPress theme developers should use `wp_head()`, `wp_body_open()` and `wp_footer()` functions in their themes (read this for more information).

    The new WordPress theme structure:

    <html>
  <head>

    ..
    ..

    <?php wp_head(); ?>

  </head>
  <body>

    <?php wp_body_open(); ?>

    ..
    ..

    <?php wp_footer(); ?>

  </body>
</html>

    Expand full source codeCollapse full source code

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Mehedi Hasan —

    I Think This is the best way for add wp_body_open(); function for backwards compatibility

    Step 1 : Checked if function is exits, if not exits then make a function called wp_body_open();

    Example:

    if ( ! function_exists( 'wp_body_open' ) ) {
    function wp_body_open() {
        do_action( 'wp_body_open' );
    }
}

    Then put the function after the body tag.

    Example:

    <html>
  <head>
 
    ..
    ..
 
    <?php wp_head(); ?>
 
  </head>
  <body>
 
    <?php wp_body_open(); ?>
 
    ..
    ..
 
    <?php wp_footer(); ?>
 
  </body>
</html>

    Expand full source codeCollapse full source code

  4. Skip to note 4 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by julianoe —

    How can I use this to my advantage as a plugin developer? How to make sure my code is included if the WP version is 5.2+ but the theme is older and/or does not include wp_body_open?

    Here is a working solution suggested by @danieliser on this ticket answer.

    <?php
add_action( 'wp_body_open', 'wpdocs_my_function' );
add_action( 'wp_footer', 'wpdocs_my_function' );

function wpdocs_my_function() {
    if ( doing_action( 'wp_body_open' ) ) {
        remove_action ( 'wp_footer', 'wpdocs_my_function' );
    }

    // do stuff.
}

    This way if you want to include code from your plugin just after the body tag opened by a theme that is up to date with good practices, and if it’s not, your code gets included the old way with wp_footer.

  5. Skip to note 5 content
    You must log in to vote on the helpfulness of this noteVote results for this note: -4You must log in to vote on the helpfulness of this note
    Contributed by Ahir Hemant —

    Custom Theme Hooks

    Many themes use their own custom actions at the beginning of body tag. They should consider migrating to the core wp_body_open action.

    For backwards compatibility, when injecting custom code, theme developers can use conditional logic to hook to the right action

    function custom_code() {
    return '<!-- some code -->';
}

if ( did_action( 'wp_body_open' ) ) {
    add_action( 'wp_body_open', 'custom_code' );
} else {
    add_action( 'custom_theme_hook', 'custom_code' );
}

You must log in before being able to contribute a note or feedback.