WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

_cleanup_header_comment()

_cleanup_header_comment( string $str ): string

In this article

Back to top

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness. Use https://core.trac.wordpress.org/ticket/8497 instead.

Strips close comment and close php tags from file headers used by WP.

Description

See also

Parameters

$strstringrequired
Header comment to clean up.

Return

string

Source

function _cleanup_header_comment( $str ) {
	return trim( preg_replace( '/\s*(?:\*\/|\?>).*/', '', $str ) );
}

View all references View on Trac View on GitHub

Used byDescription
WP_Theme::get_post_templates()wp-includes/class-wp-theme.php

Returns the theme’s post templates.

get_file_description()wp-admin/includes/file.php

Gets the description for standard WordPress theme files.

get_file_data()wp-includes/functions.php

Retrieves metadata from a file.

Changelog

VersionDescription
2.8.0Introduced.

User Contributed Notes

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