Ticket #20189: 20189.diff

File 20189.diff, 3.5 KB (added by benbalter, 15 months ago)

Patch to deprecate bloginfo() in favor of siteinfo()

Line 
1Index: wp-includes/general-template.php
2===================================================================
3--- wp-includes/general-template.php    (revision 20037)
4+++ wp-includes/general-template.php    (working copy)
5@@ -361,19 +361,19 @@
6 }
7 
8 /**
9- * Display information about the blog.
10+ * Display information about the site.
11  *
12- * @see get_bloginfo() For possible values for the parameter.
13+ * @see get_siteinfo() For possible values for the parameter.
14  * @since 0.71
15  *
16  * @param string $show What to display.
17  */
18-function bloginfo( $show='' ) {
19-       echo get_bloginfo( $show, 'display' );
20+function siteinfo( $show='' ) {
21+       echo get_siteinfo( $show, 'display' );
22 }
23 
24 /**
25- * Retrieve information about the blog.
26+ * Retrieve information about the site.
27  *
28  * Some show parameter values are deprecated and will be removed in future
29  * versions. These options will trigger the _deprecated_argument() function.
30@@ -381,8 +381,8 @@
31  *
32  * The possible values for the 'show' parameter are listed below.
33  * <ol>
34- * <li><strong>url</strong> - Blog URI to homepage.</li>
35- * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>
36+ * <li><strong>url</strong> - Site URI to homepage.</li>
37+ * <li><strong>wpurl</strong> - Site URI path to WordPress.</li>
38  * <li><strong>description</strong> - Secondary title</li>
39  * </ol>
40  *
41@@ -393,11 +393,11 @@
42  *
43  * @since 0.71
44  *
45- * @param string $show Blog info to retrieve.
46+ * @param string $show site info to retrieve.
47  * @param string $filter How to filter what is retrieved.
48  * @return string Mostly string values, might be empty.
49  */
50-function get_bloginfo( $show = '', $filter = 'raw' ) {
51+function get_siteinfo( $show = '', $filter = 'raw' ) {
52 
53        switch( $show ) {
54                case 'home' : // DEPRECATED
55Index: wp-includes/deprecated.php
56===================================================================
57--- wp-includes/deprecated.php  (revision 20037)
58+++ wp-includes/deprecated.php  (working copy)
59@@ -2952,4 +2952,47 @@
60        if ( is_array( $themes ) && array_key_exists( $theme, $themes ) )
61                return $themes[$theme];
62        return null;
63+}
64+
65+/**
66+ * Display information about the site.
67+ *
68+ * @see get_siteinfo() For possible values for the parameter.
69+ * @since 0.71
70+ *
71+ * @param string $show What to display.
72+ */
73+function bloginfo( $show='' ) {
74+       _deprecated_function( __FUNCTION__, '3.4', 'siteinfo' );
75+       siteinfo( $show );
76+}
77+
78+/**
79+ * Retrieve information about the site.
80+ *
81+ * Some show parameter values are deprecated and will be removed in future
82+ * versions. These options will trigger the _deprecated_argument() function.
83+ * The deprecated blog info options are listed in the function contents.
84+ *
85+ * The possible values for the 'show' parameter are listed below.
86+ * <ol>
87+ * <li><strong>url</strong> - Site URI to homepage.</li>
88+ * <li><strong>wpurl</strong> - Site URI path to WordPress.</li>
89+ * <li><strong>description</strong> - Secondary title</li>
90+ * </ol>
91+ *
92+ * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91),
93+ * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The
94+ * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment
95+ * feed) or 'comments_rss2_url' (RSS 2.0 comment feed).
96+ *
97+ * @since 0.71
98+ *
99+ * @param string $show site info to retrieve.
100+ * @param string $filter How to filter what is retrieved.
101+ * @return string Mostly string values, might be empty.
102+ */
103+function get_bloginfo( $show = '', $filter = 'raw' ) {
104+       _deprecated_function( __FUNCTION__, '3.4', 'siteinfo()' );
105+       return get_siteinfo( $show, $filter );
106 }
107\ No newline at end of file