wp_sidebar_description

The timeline below displays how wordpress function wp_sidebar_description has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 6.5

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars The registered sidebars.
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return wp_kses($wp_registered_sidebars[$id]['description'], 'sidebar_description');
    }
}

WordPress Version: 5.1

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars Registered sidebars.
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return wp_kses($wp_registered_sidebars[$id]['description'], 'sidebar_description');
    }
}

WordPress Version: 9.7

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return wp_kses($wp_registered_sidebars[$id]['description'], 'sidebar_description');
    }
}

WordPress Version: 9.3

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return esc_html($wp_registered_sidebars[$id]['description']);
    }
}

WordPress Version: .20

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return wp_kses($wp_registered_sidebars[$id]['description'], 'sidebar_description');
    }
}

WordPress Version: 9.2

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return esc_html($wp_registered_sidebars[$id]['description']);
    }
}

WordPress Version: .10

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return wp_kses($wp_registered_sidebars[$id]['description'], 'sidebar_description');
    }
}

WordPress Version: 4.3

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @global array $wp_registered_sidebars
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return esc_html($wp_registered_sidebars[$id]['description']);
    }
}

WordPress Version: 4.1

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @param string $id sidebar ID.
 * @return string Sidebar description, if available. Null on failure to retrieve description.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return esc_html($wp_registered_sidebars[$id]['description']);
    }
}

WordPress Version: 3.7

/**
 * Retrieve description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
 * @param int|string $id sidebar ID.
 * @return string Sidebar description, if available. Null on failure to retrieve description.
 */
function wp_sidebar_description($id)
{
    if (!is_scalar($id)) {
        return;
    }
    global $wp_registered_sidebars;
    if (isset($wp_registered_sidebars[$id]['description'])) {
        return esc_html($wp_registered_sidebars[$id]['description']);
    }
}