Docs: Clarify that `WP_Theme::get()`, `::display()`, and several related methods treat the `Tags` theme header as an array.

Props david.binda.
Fixes #48005.
Built from https://develop.svn.wordpress.org/trunk@46751


git-svn-id: http://core.svn.wordpress.org/trunk@46551 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2019-11-20 08:31:03 +00:00
parent 8e4b0c2c45
commit cca5c825ed
2 changed files with 16 additions and 13 deletions

View File

@ -734,7 +734,7 @@ final class WP_Theme implements ArrayAccess {
* @since 3.4.0 * @since 3.4.0
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @return string|false String on success, false on failure. * @return string|array|false String or array (for Tags header) on success, false on failure.
*/ */
public function get( $header ) { public function get( $header ) {
if ( ! isset( $this->headers[ $header ] ) ) { if ( ! isset( $this->headers[ $header ] ) ) {
@ -773,7 +773,8 @@ final class WP_Theme implements ArrayAccess {
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param bool $markup Optional. Whether to mark up the header. Defaults to true. * @param bool $markup Optional. Whether to mark up the header. Defaults to true.
* @param bool $translate Optional. Whether to translate the header. Defaults to true. * @param bool $translate Optional. Whether to translate the header. Defaults to true.
* @return string|false Processed header, false on failure. * @return string|array|false Processed header. An array for Tags if `$markup` is false, string otherwise.
* False on failure.
*/ */
public function display( $header, $markup = true, $translate = true ) { public function display( $header, $markup = true, $translate = true ) {
$value = $this->get( $header ); $value = $this->get( $header );
@ -805,8 +806,8 @@ final class WP_Theme implements ArrayAccess {
* @staticvar array $header_tags_with_a * @staticvar array $header_tags_with_a
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param string $value Value to sanitize. * @param string $value Value to sanitize.
* @return mixed * @return string|array An array for Tags header, string otherwise.
*/ */
private function sanitize_header( $header, $value ) { private function sanitize_header( $header, $value ) {
switch ( $header ) { switch ( $header ) {
@ -824,7 +825,8 @@ final class WP_Theme implements ArrayAccess {
'em' => true, 'em' => true,
'strong' => true, 'strong' => true,
); );
$value = wp_kses( $value, $header_tags );
$value = wp_kses( $value, $header_tags );
break; break;
case 'Author': case 'Author':
// There shouldn't be anchor tags in Author, but some themes like to be challenging. // There shouldn't be anchor tags in Author, but some themes like to be challenging.
@ -840,7 +842,8 @@ final class WP_Theme implements ArrayAccess {
'em' => true, 'em' => true,
'strong' => true, 'strong' => true,
); );
$value = wp_kses( $value, $header_tags_with_a );
$value = wp_kses( $value, $header_tags_with_a );
break; break;
case 'ThemeURI': case 'ThemeURI':
case 'AuthorURI': case 'AuthorURI':
@ -864,9 +867,9 @@ final class WP_Theme implements ArrayAccess {
* *
* @staticvar string $comma * @staticvar string $comma
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param string $value Value to mark up. * @param string|array $value Value to mark up. An array for Tags header, string otherwise.
* @param string $translate Whether the header has been translated. * @param string $translate Whether the header has been translated.
* @return string Value, marked up. * @return string Value, marked up.
*/ */
private function markup_header( $header, $value, $translate ) { private function markup_header( $header, $value, $translate ) {
@ -910,9 +913,9 @@ final class WP_Theme implements ArrayAccess {
* *
* @staticvar array $tags_list * @staticvar array $tags_list
* *
* @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags. * @param string $header Theme header. Name, Description, Author, Version, ThemeURI, AuthorURI, Status, Tags.
* @param string $value Value to translate. * @param string|array $value Value to translate. An array for Tags header, string otherwise.
* @return string Translated value. * @return string|array Translated value. An array for Tags header, string otherwise.
*/ */
private function translate_header( $header, $value ) { private function translate_header( $header, $value ) {
switch ( $header ) { switch ( $header ) {

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-alpha-46750'; $wp_version = '5.4-alpha-46751';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.