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.

_cleanup_header_comment( string $str )

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

Description

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));
}

Expand Source Code View on GitHub

Used By

Used By
Used By	Description
wp-includes/class-wp-theme.php: WP_Theme::get_post_templates()	Returns the theme’s post templates.
wp-includes/functions.php: get_file_data()	Retrieve metadata from a file.
wp-admin/includes/file.php: get_file_description()	Get the description for standard ClassicPress theme files and other various standard ClassicPress files

Changelog

Changelog
Version	Description
WP-2.8.0	Introduced.