mirror of
https://github.com/WordPress/WordPress.git
synced 2025-01-03 15:08:10 +01:00
Cleanup doc blocks in general-template.php.
See #32444. Built from https://develop.svn.wordpress.org/trunk@32598 git-svn-id: http://core.svn.wordpress.org/trunk@32568 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor
parent
bbe2301960
commit
82f5d2e9b5
@ -190,8 +190,8 @@ function get_template_part( $slug, $name = null ) {
|
||||
*
|
||||
* @since 2.7.0
|
||||
*
|
||||
* @param boolean $echo Default to echo and not return the form.
|
||||
* @return string|null String when retrieving, null when displaying or if searchform.php exists.
|
||||
* @param bool $echo Default to echo and not return the form.
|
||||
* @return string|void String when $echo is false.
|
||||
*/
|
||||
function get_search_form( $echo = true ) {
|
||||
/**
|
||||
@ -268,8 +268,8 @@ function get_search_form( $echo = true ) {
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param string $redirect Optional path to redirect to on login/logout.
|
||||
* @param boolean $echo Default to echo and not return the link.
|
||||
* @return string|null String when retrieving, null when displaying.
|
||||
* @param bool $echo Default to echo and not return the link.
|
||||
* @return string|void String when retrieving.
|
||||
*/
|
||||
function wp_loginout($redirect = '', $echo = true) {
|
||||
if ( ! is_user_logged_in() )
|
||||
@ -323,8 +323,6 @@ function wp_logout_url($redirect = '') {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Log In URL.
|
||||
*
|
||||
* Returns the URL that allows the user to log in to the site.
|
||||
*
|
||||
* @since 2.7.0
|
||||
@ -356,8 +354,6 @@ function wp_login_url($redirect = '', $force_reauth = false) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the user registration URL.
|
||||
*
|
||||
* Returns the URL that allows the user to register on the site.
|
||||
*
|
||||
* @since 3.6.0
|
||||
@ -382,7 +378,7 @@ function wp_registration_url() {
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param array $args Configuration options to modify the form output.
|
||||
* @return string|null String when retrieving, null when displaying.
|
||||
* @return string|void String when retrieving.
|
||||
*/
|
||||
function wp_login_form( $args = array() ) {
|
||||
$defaults = array(
|
||||
@ -477,8 +473,6 @@ function wp_login_form( $args = array() ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Lost Password URL.
|
||||
*
|
||||
* Returns the URL that allows the user to retrieve the lost password
|
||||
*
|
||||
* @since 2.8.0
|
||||
@ -515,11 +509,10 @@ function wp_lostpassword_url( $redirect = '' ) {
|
||||
*
|
||||
* @param string $before Text to output before the link. Default `<li>`.
|
||||
* @param string $after Text to output after the link. Default `</li>`.
|
||||
* @param boolean $echo Default to echo and not return the link.
|
||||
* @return string|null String when retrieving, null when displaying.
|
||||
* @param bool $echo Default to echo and not return the link.
|
||||
* @return string|void String when retrieving.
|
||||
*/
|
||||
function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
|
||||
|
||||
if ( ! is_user_logged_in() ) {
|
||||
if ( get_option('users_can_register') )
|
||||
$link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __('Register') . '</a>' . $after;
|
||||
@ -600,12 +593,13 @@ function bloginfo( $show='' ) {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @global string $wp_version
|
||||
*
|
||||
* @param string $show Blog info to retrieve.
|
||||
* @param string $filter How to filter what is retrieved.
|
||||
* @return string Mostly string values, might be empty.
|
||||
*/
|
||||
function get_bloginfo( $show = '', $filter = 'raw' ) {
|
||||
|
||||
switch( $show ) {
|
||||
case 'home' : // DEPRECATED
|
||||
case 'siteurl' : // DEPRECATED
|
||||
@ -766,12 +760,16 @@ function _wp_render_title_tag() {
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @global WP_Locale $wp_locale
|
||||
* @global int $page
|
||||
* @global int $paged
|
||||
*
|
||||
* @param string $sep Optional, default is '»'. How to separate the various items within the page title.
|
||||
* @param bool $display Optional, default is true. Whether to display or retrieve title.
|
||||
* @param string $seplocation Optional. Direction to display title, 'right'.
|
||||
* @return string|null String on retrieve, null when displaying.
|
||||
* @return string|void String on retrieve.
|
||||
*/
|
||||
function wp_title($sep = '»', $display = true, $seplocation = '') {
|
||||
function wp_title( $sep = '»', $display = true, $seplocation = '' ) {
|
||||
global $wp_locale, $page, $paged;
|
||||
|
||||
$m = get_query_var('m');
|
||||
@ -918,9 +916,9 @@ function wp_title($sep = '»', $display = true, $seplocation = '') {
|
||||
*
|
||||
* @param string $prefix Optional. What to display before the title.
|
||||
* @param bool $display Optional, default is true. Whether to display or retrieve title.
|
||||
* @return string|null Title when retrieving, null when displaying or failure.
|
||||
* @return string|void Title when retrieving.
|
||||
*/
|
||||
function single_post_title($prefix = '', $display = true) {
|
||||
function single_post_title( $prefix = '', $display = true ) {
|
||||
$_post = get_queried_object();
|
||||
|
||||
if ( !isset($_post->post_title) )
|
||||
@ -951,7 +949,7 @@ function single_post_title($prefix = '', $display = true) {
|
||||
*
|
||||
* @param string $prefix Optional. What to display before the title.
|
||||
* @param bool $display Optional, default is true. Whether to display or retrieve title.
|
||||
* @return string|null Title when retrieving, null when displaying or failure.
|
||||
* @return string|void Title when retrieving, null when displaying or failure.
|
||||
*/
|
||||
function post_type_archive_title( $prefix = '', $display = true ) {
|
||||
if ( ! is_post_type_archive() )
|
||||
@ -994,7 +992,7 @@ function post_type_archive_title( $prefix = '', $display = true ) {
|
||||
*
|
||||
* @param string $prefix Optional. What to display before the title.
|
||||
* @param bool $display Optional, default is true. Whether to display or retrieve title.
|
||||
* @return string|null Title when retrieving, null when displaying or failure.
|
||||
* @return string|void Title when retrieving.
|
||||
*/
|
||||
function single_cat_title( $prefix = '', $display = true ) {
|
||||
return single_term_title( $prefix, $display );
|
||||
@ -1015,7 +1013,7 @@ function single_cat_title( $prefix = '', $display = true ) {
|
||||
*
|
||||
* @param string $prefix Optional. What to display before the title.
|
||||
* @param bool $display Optional, default is true. Whether to display or retrieve title.
|
||||
* @return string|null Title when retrieving, null when displaying or failure.
|
||||
* @return string|void Title when retrieving.
|
||||
*/
|
||||
function single_tag_title( $prefix = '', $display = true ) {
|
||||
return single_term_title( $prefix, $display );
|
||||
@ -1036,7 +1034,7 @@ function single_tag_title( $prefix = '', $display = true ) {
|
||||
*
|
||||
* @param string $prefix Optional. What to display before the title.
|
||||
* @param bool $display Optional, default is true. Whether to display or retrieve title.
|
||||
* @return string|null Title when retrieving, null when displaying or failure.
|
||||
* @return string|void Title when retrieving.
|
||||
*/
|
||||
function single_term_title( $prefix = '', $display = true ) {
|
||||
$term = get_queried_object();
|
||||
@ -1098,9 +1096,11 @@ function single_term_title( $prefix = '', $display = true ) {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @global WP_Locale $wp_locale
|
||||
*
|
||||
* @param string $prefix Optional. What to display before the title.
|
||||
* @param bool $display Optional, default is true. Whether to display or retrieve title.
|
||||
* @return string|null Title when retrieving, null when displaying or failure.
|
||||
* @return string|void Title when retrieving.
|
||||
*/
|
||||
function single_month_title($prefix = '', $display = true ) {
|
||||
global $wp_locale;
|
||||
@ -1297,9 +1297,7 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after =
|
||||
*
|
||||
* @param string $link_html The archive HTML link content.
|
||||
*/
|
||||
$link_html = apply_filters( 'get_archives_link', $link_html );
|
||||
|
||||
return $link_html;
|
||||
return apply_filters( 'get_archives_link', $link_html );
|
||||
}
|
||||
|
||||
/**
|
||||
@ -1309,6 +1307,9 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after =
|
||||
*
|
||||
* @see get_archives_link()
|
||||
*
|
||||
* @global wpdb $wpdb
|
||||
* @global WP_Locale $wp_locale
|
||||
*
|
||||
* @param string|array $args {
|
||||
* Default archive links arguments. Optional.
|
||||
*
|
||||
@ -1330,7 +1331,7 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after =
|
||||
* @type string $order Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
|
||||
* Default 'DESC'.
|
||||
* }
|
||||
* @return string|null String when retrieving, null when displaying.
|
||||
* @return string|void String when retrieving.
|
||||
*/
|
||||
function wp_get_archives( $args = '' ) {
|
||||
global $wpdb, $wp_locale;
|
||||
@ -1546,9 +1547,16 @@ function calendar_week_mod($num) {
|
||||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @global wpdb $wpdb
|
||||
* @global int $m
|
||||
* @global int $monthnum
|
||||
* @global int $year
|
||||
* @global WP_Locale $wp_locale
|
||||
* @global array $posts
|
||||
*
|
||||
* @param bool $initial Optional, default is true. Use initial calendar names.
|
||||
* @param bool $echo Optional, default is true. Set to false for return.
|
||||
* @return string|null String when retrieving, null when displaying.
|
||||
* @return string|void String when retrieving.
|
||||
*/
|
||||
function get_calendar($initial = true, $echo = true) {
|
||||
global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
|
||||
@ -1778,7 +1786,8 @@ function delete_get_calendar_cache() {
|
||||
* attributes are supported. As well as any plugins which want to display it.
|
||||
*
|
||||
* @since 1.0.1
|
||||
* @uses $allowedtags
|
||||
*
|
||||
* @global array $allowedtags
|
||||
*
|
||||
* @return string HTML allowed tags entity encoded.
|
||||
*/
|
||||
@ -1794,7 +1803,7 @@ function allowed_tags() {
|
||||
}
|
||||
$allowed .= '> ';
|
||||
}
|
||||
return htmlentities($allowed);
|
||||
return htmlentities( $allowed );
|
||||
}
|
||||
|
||||
/***** Date/Time tags *****/
|
||||
@ -1822,11 +1831,14 @@ function the_date_xml() {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @global string|int|bool $currentday
|
||||
* @global string|int|bool $previousday
|
||||
*
|
||||
* @param string $d Optional. PHP date format defaults to the date_format option if not specified.
|
||||
* @param string $before Optional. Output before the date.
|
||||
* @param string $after Optional. Output after the date.
|
||||
* @param bool $echo Optional, default is display. Whether to echo the date or return it.
|
||||
* @return string|null Null if displaying, string if retrieving.
|
||||
* @return string|void String if retrieving.
|
||||
*/
|
||||
function the_date( $d = '', $before = '', $after = '', $echo = true ) {
|
||||
global $currentday, $previousday;
|
||||
@ -1853,8 +1865,6 @@ function the_date( $d = '', $before = '', $after = '', $echo = true ) {
|
||||
else
|
||||
return $the_date;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
@ -1904,10 +1914,9 @@ function get_the_date( $d = '', $post = null ) {
|
||||
* @param string $before Optional. Output before the date.
|
||||
* @param string $after Optional. Output after the date.
|
||||
* @param bool $echo Optional, default is display. Whether to echo the date or return it.
|
||||
* @return string|null Null if displaying, string if retrieving.
|
||||
* @return string|void String if retrieving.
|
||||
*/
|
||||
function the_modified_date($d = '', $before='', $after='', $echo = true) {
|
||||
|
||||
function the_modified_date( $d = '', $before = '', $after = '', $echo = true ) {
|
||||
$the_modified_date = $before . get_the_modified_date($d) . $after;
|
||||
|
||||
/**
|
||||
@ -2141,7 +2150,8 @@ function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translat
|
||||
* Display the weekday on which the post was written.
|
||||
*
|
||||
* @since 0.71
|
||||
* @uses $wp_locale
|
||||
*
|
||||
* @global WP_Locale $wp_locale
|
||||
*/
|
||||
function the_weekday() {
|
||||
global $wp_locale;
|
||||
@ -2154,8 +2164,7 @@ function the_weekday() {
|
||||
*
|
||||
* @param string $the_weekday
|
||||
*/
|
||||
$the_weekday = apply_filters( 'the_weekday', $the_weekday );
|
||||
echo $the_weekday;
|
||||
echo apply_filters( 'the_weekday', $the_weekday );
|
||||
}
|
||||
|
||||
/**
|
||||
@ -2166,6 +2175,10 @@ function the_weekday() {
|
||||
*
|
||||
* @since 0.71
|
||||
*
|
||||
* @global WP_Locale $wp_locale
|
||||
* @global string|int|bool $currentday
|
||||
* @global string|int|bool $previousweekday
|
||||
*
|
||||
* @param string $before Optional Output before the date.
|
||||
* @param string $after Optional Output after the date.
|
||||
*/
|
||||
@ -2380,6 +2393,13 @@ function wp_no_robots() {
|
||||
*
|
||||
* @since 2.0.0
|
||||
*
|
||||
* @global bool $wp_rich_edit
|
||||
* @global bool $is_gecko
|
||||
* @global bool $is_opera
|
||||
* @global bool $is_safari
|
||||
* @global bool $is_chrome
|
||||
* @global bool $is_IE
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
function user_can_richedit() {
|
||||
@ -2590,6 +2610,9 @@ function language_attributes($doctype = 'html') {
|
||||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @global WP_Query $wp_query
|
||||
* @global WP_Rewrite $wp_rewrite
|
||||
*
|
||||
* @param string|array $args {
|
||||
* Optional. Array or string of arguments for generating paginated links for archives.
|
||||
*
|
||||
@ -2612,7 +2635,7 @@ function language_attributes($doctype = 'html') {
|
||||
* @type string $before_page_number A string to appear before the page number. Default empty.
|
||||
* @type string $after_page_number A string to append after the page number. Default empty.
|
||||
* }
|
||||
* @return array|string String of page links or array of page links.
|
||||
* @return array|string|void String of page links or array of page links.
|
||||
*/
|
||||
function paginate_links( $args = '' ) {
|
||||
global $wp_query, $wp_rewrite;
|
||||
@ -2770,6 +2793,8 @@ function paginate_links( $args = '' ) {
|
||||
*
|
||||
* @todo Properly document optional arguments as such
|
||||
*
|
||||
* @global array $_wp_admin_css_colors
|
||||
*
|
||||
* @param string $key The unique key for this theme.
|
||||
* @param string $name The name of the theme.
|
||||
* @param string $url The url of the css file containing the colour scheme.
|
||||
@ -2794,6 +2819,8 @@ function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = arra
|
||||
* Registers the default Admin color schemes
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
function register_admin_color_schemes() {
|
||||
$suffix = is_rtl() ? '-rtl' : '';
|
||||
@ -2861,6 +2888,7 @@ function register_admin_color_schemes() {
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param string $file file relative to wp-admin/ without its ".css" extension.
|
||||
* @return string
|
||||
*/
|
||||
function wp_admin_css_uri( $file = 'wp-admin' ) {
|
||||
if ( defined('WP_INSTALLING') ) {
|
||||
@ -2896,22 +2924,16 @@ function wp_admin_css_uri( $file = 'wp-admin' ) {
|
||||
* stylesheet link to that generated URL is printed.
|
||||
*
|
||||
* @since 2.3.0
|
||||
* @uses $wp_styles WordPress Styles Object
|
||||
*
|
||||
* @param string $file Optional. Style handle name or file name (without ".css" extension) relative
|
||||
* to wp-admin/. Defaults to 'wp-admin'.
|
||||
* @param bool $force_echo Optional. Force the stylesheet link to be printed rather than enqueued.
|
||||
*/
|
||||
function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
|
||||
global $wp_styles;
|
||||
if ( ! ( $wp_styles instanceof WP_Styles ) ) {
|
||||
$wp_styles = new WP_Styles();
|
||||
}
|
||||
|
||||
// For backward compatibility
|
||||
$handle = 0 === strpos( $file, 'css/' ) ? substr( $file, 4 ) : $file;
|
||||
|
||||
if ( $wp_styles->query( $handle ) ) {
|
||||
if ( wp_styles()->query( $handle ) ) {
|
||||
if ( $force_echo || did_action( 'wp_print_styles' ) ) // we already printed the style queue. Print this one immediately
|
||||
wp_print_styles( $handle );
|
||||
else // Add to style queue
|
||||
@ -3004,7 +3026,7 @@ function the_generator( $type ) {
|
||||
* @since 2.5.0
|
||||
*
|
||||
* @param string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export).
|
||||
* @return string The HTML content for the generator.
|
||||
* @return string|void The HTML content for the generator.
|
||||
*/
|
||||
function get_the_generator( $type = '' ) {
|
||||
if ( empty( $type ) ) {
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.3-alpha-32597';
|
||||
$wp_version = '4.3-alpha-32598';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user