Skip to content

Commit 5aa6c9a

Browse files
committed
Rename get_bloginfo parameter to $site_info, maybe.
1 parent 7cf23fe commit 5aa6c9a

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

src/wp-includes/general-template.php

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -765,7 +765,7 @@ function bloginfo( $show = '' ) {
765765
/**
766766
* Retrieves information about the current site.
767767
*
768-
* Possible values for `$show` include:
768+
* Possible values for `$site_info` include:
769769
*
770770
* - 'name' - Site title (set in Settings > General)
771771
* - 'description' - Site tagline (set in Settings > General)
@@ -793,7 +793,7 @@ function bloginfo( $show = '' ) {
793793
* - 'comments_atom_url' - The comments Atom feed URL (/comments/feed)
794794
* - 'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed)
795795
*
796-
* Some `$show` values are deprecated and will be removed in future versions.
796+
* Some `$site_info` values are deprecated and will be removed in future versions.
797797
* These options will trigger the _deprecated_argument() function.
798798
*
799799
* Deprecated arguments include:
@@ -805,12 +805,12 @@ function bloginfo( $show = '' ) {
805805
*
806806
* @global string $wp_version The WordPress version string.
807807
*
808-
* @param string $show Optional. Site info to retrieve. Default empty (site name).
809-
* @param string $filter Optional. How to filter what is retrieved. Default 'raw'.
808+
* @param string $site_info Optional. Site info to retrieve. Default empty (site name).
809+
* @param string $filter Optional. How to filter what is retrieved. Default 'raw'.
810810
* @return string Mostly string values, might be empty.
811811
*/
812-
function get_bloginfo( $show = '', $filter = 'raw' ) {
813-
switch ( $show ) {
812+
function get_bloginfo( $site_info = '', $filter = 'raw' ) {
813+
switch ( $site_info ) {
814814
case 'home': // Deprecated.
815815
case 'siteurl': // Deprecated.
816816
_deprecated_argument(
@@ -819,7 +819,7 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
819819
sprintf(
820820
/* translators: 1: 'siteurl'/'home' argument, 2: bloginfo() function name, 3: 'url' argument. */
821821
__( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s option instead.' ),
822-
'<code>' . $show . '</code>',
822+
'<code>' . $site_info . '</code>',
823823
'<code>bloginfo()</code>',
824824
'<code>url</code>'
825825
)
@@ -900,7 +900,7 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
900900
sprintf(
901901
/* translators: 1: 'text_direction' argument, 2: bloginfo() function name, 3: is_rtl() function name. */
902902
__( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s function instead.' ),
903-
'<code>' . $show . '</code>',
903+
'<code>' . $site_info . '</code>',
904904
'<code>bloginfo()</code>',
905905
'<code>is_rtl()</code>'
906906
)
@@ -919,29 +919,29 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
919919

920920
if ( 'display' === $filter ) {
921921
if (
922-
str_contains( $show, 'url' )
923-
|| str_contains( $show, 'directory' )
924-
|| str_contains( $show, 'home' )
922+
str_contains( $site_info, 'url' )
923+
|| str_contains( $site_info, 'directory' )
924+
|| str_contains( $site_info, 'home' )
925925
) {
926926
/**
927927
* Filters the URL returned by get_bloginfo().
928928
*
929929
* @since 2.0.5
930930
*
931-
* @param string $output The URL returned by bloginfo().
932-
* @param string $show Type of information requested.
931+
* @param string $output The URL returned by bloginfo().
932+
* @param string $site_info Type of information requested.
933933
*/
934-
$output = apply_filters( 'bloginfo_url', $output, $show );
934+
$output = apply_filters( 'bloginfo_url', $output, $site_info );
935935
} else {
936936
/**
937937
* Filters the site information returned by get_bloginfo().
938938
*
939939
* @since 0.71
940940
*
941-
* @param mixed $output The requested non-URL site information.
942-
* @param string $show Type of information requested.
941+
* @param mixed $output The requested non-URL site information.
942+
* @param string $site_info Type of information requested.
943943
*/
944-
$output = apply_filters( 'bloginfo', $output, $show );
944+
$output = apply_filters( 'bloginfo', $output, $site_info );
945945
}
946946
}
947947

0 commit comments

Comments
 (0)