_cleanup_header_comment( string $str )

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.

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

Description

See also

Parameters

$str

(string) (Required) Header comment to clean up.

Return

(string)

Source

File: wp-includes/functions.php 

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

Changelog

Version Description
2.8.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/_cleanup_header_comment