X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..4feeb71a9d812a9ae371c28a3d8b442a4394ded7:/wp-includes/general-template.php diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php index 61665ad5..aaff39ef 100644 --- a/wp-includes/general-template.php +++ b/wp-includes/general-template.php @@ -17,8 +17,6 @@ * * @since 1.5.0 * - * @uses locate_template() - * * @param string $name The name of the specialised header. */ function get_header( $name = null ) { @@ -38,14 +36,13 @@ function get_header( $name = null ) { $templates = array(); $name = (string) $name; - if ( '' !== $name ) + if ( '' !== $name ) { $templates[] = "header-{$name}.php"; + } $templates[] = 'header.php'; - // Backward compat code will be removed in a future release - if ('' == locate_template($templates, true)) - load_template( ABSPATH . WPINC . '/theme-compat/header.php'); + locate_template( $templates, true ); } /** @@ -59,8 +56,6 @@ function get_header( $name = null ) { * * @since 1.5.0 * - * @uses locate_template() - * * @param string $name The name of the specialised footer. */ function get_footer( $name = null ) { @@ -80,14 +75,13 @@ function get_footer( $name = null ) { $templates = array(); $name = (string) $name; - if ( '' !== $name ) + if ( '' !== $name ) { $templates[] = "footer-{$name}.php"; + } - $templates[] = 'footer.php'; + $templates[] = 'footer.php'; - // Backward compat code will be removed in a future release - if ('' == locate_template($templates, true)) - load_template( ABSPATH . WPINC . '/theme-compat/footer.php'); + locate_template( $templates, true ); } /** @@ -101,8 +95,6 @@ function get_footer( $name = null ) { * * @since 1.5.0 * - * @uses locate_template() - * * @param string $name The name of the specialised sidebar. */ function get_sidebar( $name = null ) { @@ -127,9 +119,7 @@ function get_sidebar( $name = null ) { $templates[] = 'sidebar.php'; - // Backward compat code will be removed in a future release - if ('' == locate_template($templates, true)) - load_template( ABSPATH . WPINC . '/theme-compat/sidebar.php'); + locate_template( $templates, true ); } /** @@ -150,8 +140,6 @@ function get_sidebar( $name = null ) { * * @since 3.0.0 * - * @uses locate_template() - * * @param string $slug The slug name for the generic template. * @param string $name The name of the specialised template. */ @@ -159,7 +147,7 @@ function get_template_part( $slug, $name = null ) { /** * Fires before the specified template part file is loaded. * - * The dynamic portion of the hook name, $slug, refers to the slug name + * The dynamic portion of the hook name, `$slug`, refers to the slug name * for the generic template part. * * @since 3.0.0 @@ -198,8 +186,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 ) { /** @@ -234,7 +222,7 @@ function get_search_form( $echo = true ) { $form = ''; @@ -276,8 +264,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() ) @@ -307,9 +295,6 @@ function wp_loginout($redirect = '', $echo = true) { * * @since 2.7.0 * - * @uses wp_nonce_url() To protect against CSRF. - * @uses site_url() To generate the log out URL. - * * @param string $redirect Path to redirect to on logout. * @return string A log out URL. */ @@ -334,16 +319,12 @@ 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 * - * @uses site_url() To generate the log in URL. - * - * @param string $redirect Path to redirect to on login. - * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false. + * @param string $redirect Path to redirect to on login. + * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false. * @return string A log in URL. */ function wp_login_url($redirect = '', $force_reauth = false) { @@ -359,22 +340,20 @@ function wp_login_url($redirect = '', $force_reauth = false) { * Filter the login URL. * * @since 2.8.0 + * @since 4.2.0 The `$force_reauth` parameter was added. * - * @param string $login_url The login URL. - * @param string $redirect The path to redirect to on login, if supplied. + * @param string $login_url The login URL. + * @param string $redirect The path to redirect to on login, if supplied. + * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. */ - return apply_filters( 'login_url', $login_url, $redirect ); + return apply_filters( 'login_url', $login_url, $redirect, $force_reauth ); } /** - * Returns the user registration URL. - * * Returns the URL that allows the user to register on the site. * * @since 3.6.0 * - * @uses site_url() To generate the registration URL. - * * @return string User registration URL. */ function wp_registration_url() { @@ -389,20 +368,43 @@ function wp_registration_url() { } /** - * Provides a simple login form for use anywhere within WordPress. By default, it echoes - * the HTML immediately. Pass array('echo'=>false) to return the string instead. + * Provides a simple login form for use anywhere within WordPress. + * + * The login format HTML is echoed by default. Pass a false value for `$echo` to return it instead. * * @since 3.0.0 * - * @param array $args Configuration options to modify the form output. - * @return string|null String when retrieving, null when displaying. + * @param array $args { + * Optional. Array of options to control the form output. Default empty array. + * + * @type bool $echo Whether to display the login form or return the form HTML code. + * Default true (echo). + * @type string $redirect URL to redirect to. Must be absolute, as in "https://example.com/mypage/". + * Default is to redirect back to the request URI. + * @type string $form_id ID attribute value for the form. Default 'loginform'. + * @type string $label_username Label for the username or email address field. Default 'Username or Email'. + * @type string $label_password Label for the password field. Default 'Password'. + * @type string $label_remember Label for the remember field. Default 'Remember Me'. + * @type string $label_log_in Label for the submit button. Default 'Log In'. + * @type string $id_username ID attribute value for the username field. Default 'user_login'. + * @type string $id_password ID attribute value for the password field. Default 'user_pass'. + * @type string $id_remember ID attribute value for the remember field. Default 'rememberme'. + * @type string $id_submit ID attribute value for the submit button. Default 'wp-submit'. + * @type bool $remember Whether to display the "rememberme" checkbox in the form. + * @type string $value_username Default value for the username field. Default empty. + * @type bool $value_remember Whether the "Remember Me" checkbox should be checked by default. + * Default false (unchecked). + * + * } + * @return string|void String when retrieving. */ function wp_login_form( $args = array() ) { $defaults = array( 'echo' => true, - 'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], // Default redirect is back to the current page + // Default 'redirect' value takes the user back to the request URI. + 'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], 'form_id' => 'loginform', - 'label_username' => __( 'Username' ), + 'label_username' => __( 'Username or Email' ), 'label_password' => __( 'Password' ), 'label_remember' => __( 'Remember Me' ), 'label_log_in' => __( 'Log In' ), @@ -412,7 +414,8 @@ function wp_login_form( $args = array() ) { 'id_submit' => 'wp-submit', 'remember' => true, 'value_username' => '', - 'value_remember' => false, // Set this to true to default the "Remember me" checkbox to checked + // Set 'value_remember' to true to default the "Remember me" checkbox to checked. + 'value_remember' => false, ); /** @@ -490,14 +493,10 @@ 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 * - * @uses site_url() To generate the lost password URL - * * @param string $redirect Path to redirect to on login. * @return string Lost password URL. */ @@ -528,20 +527,21 @@ function wp_lostpassword_url( $redirect = '' ) { * * @since 1.5.0 * - * @param string $before Text to output before the link (defaults to
  • ). - * @param string $after Text to output after the link (defaults to
  • ). - * @param boolean $echo Default to echo and not return the link. - * @return string|null String when retrieving, null when displaying. + * @param string $before Text to output before the link. Default `
  • `. + * @param string $after Text to output after the link. Default `
  • `. + * @param bool $echo Default to echo and not return the link. + * @return string|void String when retrieving. */ function wp_register( $before = '
  • ', $after = '
  • ', $echo = true ) { - if ( ! is_user_logged_in() ) { if ( get_option('users_can_register') ) $link = $before . '' . __('Register') . '' . $after; else $link = ''; - } else { + } elseif ( current_user_can( 'read' ) ) { $link = $before . '' . __('Site Admin') . '' . $after; + } else { + $link = ''; } /** @@ -571,7 +571,7 @@ function wp_register( $before = '
  • ', $after = '
  • ', $echo = true ) { * * @since 1.5.0 * - * @link http://trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action. + * @link https://core.trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action. */ function wp_meta() { /** @@ -583,48 +583,76 @@ function wp_meta() { } /** - * Display information about the blog. + * Displays information about the current site. * - * @see get_bloginfo() For possible values for the parameter. * @since 0.71 * - * @param string $show What to display. + * @see get_bloginfo() For possible `$show` values + * + * @param string $show Optional. Site information to display. Default empty. */ -function bloginfo( $show='' ) { +function bloginfo( $show = '' ) { echo get_bloginfo( $show, 'display' ); } /** - * Retrieve information about the blog. - * - * Some show parameter values are deprecated and will be removed in future - * versions. These options will trigger the _deprecated_argument() function. - * The deprecated blog info options are listed in the function contents. - * - * The possible values for the 'show' parameter are listed below. - *
      - *
    1. url - Blog URI to homepage.
    2. - *
    3. wpurl - Blog URI path to WordPress.
    4. - *
    5. description - Secondary title
    6. - *
    - * - * The feed URL options can be retrieved from 'rdf_url' (RSS 0.91), - * 'rss_url' (RSS 1.0), 'rss2_url' (RSS 2.0), or 'atom_url' (Atom feed). The - * comment feeds can be retrieved from the 'comments_atom_url' (Atom comment - * feed) or 'comments_rss2_url' (RSS 2.0 comment feed). + * Retrieves information about the current site. + * + * Possible values for `$show` include: + * + * - 'name' - Site title (set in Settings > General) + * - 'description' - Site tagline (set in Settings > General) + * - 'wpurl' - The WordPress address (URL) (set in Settings > General) + * - 'url' - The Site address (URL) (set in Settings > General) + * - 'admin_email' - Admin email (set in Settings > General) + * - 'charset' - The "Encoding for pages and feeds" (set in Settings > Reading) + * - 'version' - The current WordPress version + * - 'html_type' - The content-type (default: "text/html"). Themes and plugins + * can override the default value using the {@see 'pre_option_html_type'} filter + * - 'text_direction' - The text direction determined by the site's language. is_rtl() + * should be used instead + * - 'language' - Language code for the current site + * - 'stylesheet_url' - URL to the stylesheet for the active theme. An active child theme + * will take precedence over this value + * - 'stylesheet_directory' - Directory path for the active theme. An active child theme + * will take precedence over this value + * - 'template_url' / 'template_directory' - URL of the active theme's directory. An active + * child theme will NOT take precedence over this value + * - 'pingback_url' - The pingback XML-RPC file URL (xmlrpc.php) + * - 'atom_url' - The Atom feed URL (/feed/atom) + * - 'rdf_url' - The RDF/RSS 1.0 feed URL (/feed/rfd) + * - 'rss_url' - The RSS 0.92 feed URL (/feed/rss) + * - 'rss2_url' - The RSS 2.0 feed URL (/feed) + * - 'comments_atom_url' - The comments Atom feed URL (/comments/feed) + * - 'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed) + * + * Some `$show` values are deprecated and will be removed in future versions. + * These options will trigger the _deprecated_argument() function. + * + * Deprecated arguments include: + * + * - 'siteurl' - Use 'url' instead + * - 'home' - Use 'url' instead * * @since 0.71 * - * @param string $show Blog info to retrieve. - * @param string $filter How to filter what is retrieved. + * @global string $wp_version + * + * @param string $show Optional. Site info to retrieve. Default empty (site name). + * @param string $filter Optional. How to filter what is retrieved. Default 'raw'. * @return string Mostly string values, might be empty. */ function get_bloginfo( $show = '', $filter = 'raw' ) { - switch( $show ) { case 'home' : // DEPRECATED case 'siteurl' : // DEPRECATED - _deprecated_argument( __FUNCTION__, '2.2', sprintf( __('The %s option is deprecated for the family of bloginfo() functions.' ), $show ) . ' ' . sprintf( __( 'Use the %s option instead.' ), 'url' ) ); + _deprecated_argument( __FUNCTION__, '2.2', sprintf( + /* translators: 1: 'siteurl'/'home' argument, 2: bloginfo() function name, 3: 'url' argument */ + __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s option instead.' ), + '' . $show . '', + 'bloginfo()', + 'url' + ) ); case 'url' : $output = home_url(); break; @@ -680,11 +708,24 @@ function get_bloginfo( $show = '', $filter = 'raw' ) { $output = $wp_version; break; case 'language': - $output = get_locale(); - $output = str_replace('_', '-', $output); + /* translators: Translate this to the correct language tag for your locale, + * see https://www.w3.org/International/articles/language-tags/ for reference. + * Do not translate into your own language. + */ + $output = __( 'html_lang_attribute' ); + if ( 'html_lang_attribute' === $output || preg_match( '/[^a-zA-Z0-9-]/', $output ) ) { + $output = get_locale(); + $output = str_replace( '_', '-', $output ); + } break; case 'text_direction': - //_deprecated_argument( __FUNCTION__, '2.2', sprintf( __('The %s option is deprecated for the family of bloginfo() functions.' ), $show ) . ' ' . sprintf( __( 'Use the %s function instead.' ), 'is_rtl()' ) ); + _deprecated_argument( __FUNCTION__, '2.2', sprintf( + /* translators: 1: 'text_direction' argument, 2: bloginfo() function name, 3: is_rtl() function name */ + __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s function instead.' ), + '' . $show . '', + 'bloginfo()', + 'is_rtl()' + ) ); if ( function_exists( 'is_rtl' ) ) { $output = is_rtl() ? 'rtl' : 'ltr'; } else { @@ -730,6 +771,297 @@ function get_bloginfo( $show = '', $filter = 'raw' ) { return $output; } +/** + * Returns the Site Icon URL. + * + * @since 4.3.0 + * + * @param int $size Optional. Size of the site icon. Default 512 (pixels). + * @param string $url Optional. Fallback url if no site icon is found. Default empty. + * @param int $blog_id Optional. ID of the blog to get the site icon for. Default current blog. + * @return string Site Icon URL. + */ +function get_site_icon_url( $size = 512, $url = '', $blog_id = 0 ) { + if ( is_multisite() && (int) $blog_id !== get_current_blog_id() ) { + switch_to_blog( $blog_id ); + } + + $site_icon_id = get_option( 'site_icon' ); + + if ( $site_icon_id ) { + if ( $size >= 512 ) { + $size_data = 'full'; + } else { + $size_data = array( $size, $size ); + } + $url = wp_get_attachment_image_url( $site_icon_id, $size_data ); + } + + if ( is_multisite() && ms_is_switched() ) { + restore_current_blog(); + } + + /** + * Filter the site icon URL. + * + * @site 4.4.0 + * + * @param string $url Site icon URL. + * @param int $size Size of the site icon. + * @param int $blog_id ID of the blog to get the site icon for. + */ + return apply_filters( 'get_site_icon_url', $url, $size, $blog_id ); +} + +/** + * Displays the Site Icon URL. + * + * @since 4.3.0 + * + * @param int $size Optional. Size of the site icon. Default 512 (pixels). + * @param string $url Optional. Fallback url if no site icon is found. Default empty. + * @param int $blog_id Optional. ID of the blog to get the site icon for. Default current blog. + */ +function site_icon_url( $size = 512, $url = '', $blog_id = 0 ) { + echo esc_url( get_site_icon_url( $size, $url, $blog_id ) ); +} + +/** + * Whether the site has a Site Icon. + * + * @since 4.3.0 + * + * @param int $blog_id Optional. ID of the blog in question. Default current blog. + * @return bool Whether the site has a site icon or not. + */ +function has_site_icon( $blog_id = 0 ) { + return (bool) get_site_icon_url( 512, '', $blog_id ); +} + +/** + * Determines whether the site has a custom logo. + * + * @since 4.5.0 + * + * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog. + * @return bool Whether the site has a custom logo or not. + */ +function has_custom_logo( $blog_id = 0 ) { + if ( is_multisite() && (int) $blog_id !== get_current_blog_id() ) { + switch_to_blog( $blog_id ); + } + + $custom_logo_id = get_theme_mod( 'custom_logo' ); + + if ( is_multisite() && ms_is_switched() ) { + restore_current_blog(); + } + + return (bool) $custom_logo_id; +} + +/** + * Returns a custom logo, linked to home. + * + * @since 4.5.0 + * + * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog. + * @return string Custom logo markup. + */ +function get_custom_logo( $blog_id = 0 ) { + $html = ''; + + if ( is_multisite() && (int) $blog_id !== get_current_blog_id() ) { + switch_to_blog( $blog_id ); + } + + $custom_logo_id = get_theme_mod( 'custom_logo' ); + + // We have a logo. Logo is go. + if ( $custom_logo_id ) { + $html = sprintf( '', + esc_url( home_url( '/' ) ), + wp_get_attachment_image( $custom_logo_id, 'full', false, array( + 'class' => 'custom-logo', + 'itemprop' => 'logo', + ) ) + ); + } + + // If no logo is set but we're in the Customizer, leave a placeholder (needed for the live preview). + elseif ( is_customize_preview() ) { + $html = sprintf( '', + esc_url( home_url( '/' ) ) + ); + } + + if ( is_multisite() && ms_is_switched() ) { + restore_current_blog(); + } + + /** + * Filter the custom logo output. + * + * @since 4.5.0 + * + * @param string $html Custom logo HTML output. + */ + return apply_filters( 'get_custom_logo', $html ); +} + +/** + * Displays a custom logo, linked to home. + * + * @since 4.5.0 + * + * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog. + */ +function the_custom_logo( $blog_id = 0 ) { + echo get_custom_logo( $blog_id ); +} + +/** + * Returns document title for the current page. + * + * @since 4.4.0 + * + * @global int $page Page number of a single post. + * @global int $paged Page number of a list of posts. + * + * @return string Tag with the document title. + */ +function wp_get_document_title() { + + /** + * Filter the document title before it is generated. + * + * Passing a non-empty value will short-circuit wp_get_document_title(), + * returning that value instead. + * + * @since 4.4.0 + * + * @param string $title The document title. Default empty string. + */ + $title = apply_filters( 'pre_get_document_title', '' ); + if ( ! empty( $title ) ) { + return $title; + } + + global $page, $paged; + + $title = array( + 'title' => '', + ); + + // If it's a 404 page, use a "Page not found" title. + if ( is_404() ) { + $title['title'] = __( 'Page not found' ); + + // If it's a search, use a dynamic search results title. + } elseif ( is_search() ) { + /* translators: %s: search phrase */ + $title['title'] = sprintf( __( 'Search Results for “%s”' ), get_search_query() ); + + // If on the front page, use the site title. + } elseif ( is_front_page() ) { + $title['title'] = get_bloginfo( 'name', 'display' ); + + // If on a post type archive, use the post type archive title. + } elseif ( is_post_type_archive() ) { + $title['title'] = post_type_archive_title( '', false ); + + // If on a taxonomy archive, use the term title. + } elseif ( is_tax() ) { + $title['title'] = single_term_title( '', false ); + + /* + * If we're on the blog page that is not the homepage or + * a single post of any post type, use the post title. + */ + } elseif ( is_home() || is_singular() ) { + $title['title'] = single_post_title( '', false ); + + // If on a category or tag archive, use the term title. + } elseif ( is_category() || is_tag() ) { + $title['title'] = single_term_title( '', false ); + + // If on an author archive, use the author's display name. + } elseif ( is_author() && $author = get_queried_object() ) { + $title['title'] = $author->display_name; + + // If it's a date archive, use the date as the title. + } elseif ( is_year() ) { + $title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) ); + + } elseif ( is_month() ) { + $title['title'] = get_the_date( _x( 'F Y', 'monthly archives date format' ) ); + + } elseif ( is_day() ) { + $title['title'] = get_the_date(); + } + + // Add a page number if necessary. + if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) { + $title['page'] = sprintf( __( 'Page %s' ), max( $paged, $page ) ); + } + + // Append the description or site title to give context. + if ( is_front_page() ) { + $title['tagline'] = get_bloginfo( 'description', 'display' ); + } else { + $title['site'] = get_bloginfo( 'name', 'display' ); + } + + /** + * Filter the separator for the document title. + * + * @since 4.4.0 + * + * @param string $sep Document title separator. Default '-'. + */ + $sep = apply_filters( 'document_title_separator', '-' ); + + /** + * Filter the parts of the document title. + * + * @since 4.4.0 + * + * @param array $title { + * The document title parts. + * + * @type string $title Title of the viewed page. + * @type string $page Optional. Page number if paginated. + * @type string $tagline Optional. Site description when on home page. + * @type string $site Optional. Site title when not on home page. + * } + */ + $title = apply_filters( 'document_title_parts', $title ); + + $title = implode( " $sep ", array_filter( $title ) ); + $title = wptexturize( $title ); + $title = convert_chars( $title ); + $title = esc_html( $title ); + $title = capital_P_dangit( $title ); + + return $title; +} + +/** + * Displays title tag with content. + * + * @ignore + * @since 4.1.0 + * @since 4.4.0 Improved title output replaced `wp_title()`. + * @access private + */ +function _wp_render_title_tag() { + if ( ! current_theme_supports( 'title-tag' ) ) { + return; + } + + echo '' . wp_get_document_title() . '' . "\n"; +} + /** * Display or retrieve page title for all areas of blog. * @@ -747,36 +1079,41 @@ function get_bloginfo( $show = '', $filter = 'raw' ) { * * @since 1.0.0 * - * @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. + * @global WP_Locale $wp_locale + * + * @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. */ -function wp_title($sep = '»', $display = true, $seplocation = '') { +function wp_title( $sep = '»', $display = true, $seplocation = '' ) { global $wp_locale; - $m = get_query_var('m'); - $year = get_query_var('year'); - $monthnum = get_query_var('monthnum'); - $day = get_query_var('day'); - $search = get_query_var('s'); - $title = ''; + $m = get_query_var( 'm' ); + $year = get_query_var( 'year' ); + $monthnum = get_query_var( 'monthnum' ); + $day = get_query_var( 'day' ); + $search = get_query_var( 's' ); + $title = ''; - $t_sep = '%WP_TITILE_SEP%'; // Temporary separator, for accurate flipping, if necessary + $t_sep = '%WP_TITLE_SEP%'; // Temporary separator, for accurate flipping, if necessary // If there is a post - if ( is_single() || ( is_home() && !is_front_page() ) || ( is_page() && !is_front_page() ) ) { + if ( is_single() || ( is_home() && ! is_front_page() ) || ( is_page() && ! is_front_page() ) ) { $title = single_post_title( '', false ); } // If there's a post type archive if ( is_post_type_archive() ) { $post_type = get_query_var( 'post_type' ); - if ( is_array( $post_type ) ) + if ( is_array( $post_type ) ) { $post_type = reset( $post_type ); + } $post_type_object = get_post_type_object( $post_type ); - if ( ! $post_type_object->has_archive ) + if ( ! $post_type_object->has_archive ) { $title = post_type_archive_title( '', false ); + } } // If there's a category or tag @@ -788,7 +1125,7 @@ function wp_title($sep = '»', $display = true, $seplocation = '') { if ( is_tax() ) { $term = get_queried_object(); if ( $term ) { - $tax = get_taxonomy( $term->taxonomy ); + $tax = get_taxonomy( $term->taxonomy ); $title = single_term_title( $tax->labels->name . $t_sep, false ); } } @@ -796,45 +1133,50 @@ function wp_title($sep = '»', $display = true, $seplocation = '') { // If there's an author if ( is_author() && ! is_post_type_archive() ) { $author = get_queried_object(); - if ( $author ) + if ( $author ) { $title = $author->display_name; + } } // Post type archives with has_archive should override terms. - if ( is_post_type_archive() && $post_type_object->has_archive ) + if ( is_post_type_archive() && $post_type_object->has_archive ) { $title = post_type_archive_title( '', false ); + } // If there's a month - if ( is_archive() && !empty($m) ) { - $my_year = substr($m, 0, 4); - $my_month = $wp_locale->get_month(substr($m, 4, 2)); - $my_day = intval(substr($m, 6, 2)); - $title = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' ); + if ( is_archive() && ! empty( $m ) ) { + $my_year = substr( $m, 0, 4 ); + $my_month = $wp_locale->get_month( substr( $m, 4, 2 ) ); + $my_day = intval( substr( $m, 6, 2 ) ); + $title = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' ); } // If there's a year - if ( is_archive() && !empty($year) ) { + if ( is_archive() && ! empty( $year ) ) { $title = $year; - if ( !empty($monthnum) ) - $title .= $t_sep . $wp_locale->get_month($monthnum); - if ( !empty($day) ) - $title .= $t_sep . zeroise($day, 2); + if ( ! empty( $monthnum ) ) { + $title .= $t_sep . $wp_locale->get_month( $monthnum ); + } + if ( ! empty( $day ) ) { + $title .= $t_sep . zeroise( $day, 2 ); + } } // If it's a search if ( is_search() ) { /* translators: 1: separator, 2: search phrase */ - $title = sprintf(__('Search Results %1$s %2$s'), $t_sep, strip_tags($search)); + $title = sprintf( __( 'Search Results %1$s %2$s' ), $t_sep, strip_tags( $search ) ); } // If it's a 404 page if ( is_404() ) { - $title = __('Page not found'); + $title = __( 'Page not found' ); } $prefix = ''; - if ( !empty($title) ) + if ( ! empty( $title ) ) { $prefix = " $sep "; + } /** * Filter the parts of the page title. @@ -845,10 +1187,10 @@ function wp_title($sep = '»', $display = true, $seplocation = '') { */ $title_array = apply_filters( 'wp_title_parts', explode( $t_sep, $title ) ); - // Determines position of the separator and direction of the breadcrumb + // Determines position of the separator and direction of the breadcrumb if ( 'right' == $seplocation ) { // sep on right, so reverse the order $title_array = array_reverse( $title_array ); - $title = implode( " $sep ", $title_array ) . $prefix; + $title = implode( " $sep ", $title_array ) . $prefix; } else { $title = $prefix . implode( " $sep ", $title_array ); } @@ -858,18 +1200,18 @@ function wp_title($sep = '»', $display = true, $seplocation = '') { * * @since 2.0.0 * - * @param string $title Page title. - * @param string $sep Title separator. + * @param string $title Page title. + * @param string $sep Title separator. * @param string $seplocation Location of the separator (left or right). */ $title = apply_filters( 'wp_title', $title, $sep, $seplocation ); // Send it out - if ( $display ) + if ( $display ) { echo $title; - else + } else { return $title; - + } } /** @@ -884,11 +1226,11 @@ function wp_title($sep = '»', $display = true, $seplocation = '') { * * @since 0.71 * - * @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. + * @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|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) ) @@ -917,9 +1259,9 @@ function single_post_title($prefix = '', $display = true) { * * @since 3.1.0 * - * @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. + * @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|void Title when retrieving, null when displaying or failure. */ function post_type_archive_title( $prefix = '', $display = true ) { if ( ! is_post_type_archive() ) @@ -950,19 +1292,15 @@ function post_type_archive_title( $prefix = '', $display = true ) { /** * Display or retrieve page title for category archive. * - * This is useful for category template file or files, because it is optimized - * for category page title and with less overhead than {@link wp_title()}. - * - * It does not support placing the separator after the title, but by leaving the - * prefix parameter empty, you can set the title separator manually. The prefix - * does not automatically place a space between the prefix, so if there should - * be a space, the parameter value will need to have it at the end. + * Useful for category template files for displaying the category page title. + * The prefix does not automatically place a space between the prefix, so if + * there should be a space, the parameter value will need to have it at the end. * * @since 0.71 * - * @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. + * @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|void Title when retrieving. */ function single_cat_title( $prefix = '', $display = true ) { return single_term_title( $prefix, $display ); @@ -971,19 +1309,15 @@ function single_cat_title( $prefix = '', $display = true ) { /** * Display or retrieve page title for tag post archive. * - * Useful for tag template files for displaying the tag page title. It has less - * overhead than {@link wp_title()}, because of its limited implementation. - * - * It does not support placing the separator after the title, but by leaving the - * prefix parameter empty, you can set the title separator manually. The prefix + * Useful for tag template files for displaying the tag page title. The prefix * does not automatically place a space between the prefix, so if there should * be a space, the parameter value will need to have it at the end. * * @since 2.3.0 * - * @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. + * @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|void Title when retrieving. */ function single_tag_title( $prefix = '', $display = true ) { return single_term_title( $prefix, $display ); @@ -993,18 +1327,14 @@ function single_tag_title( $prefix = '', $display = true ) { * Display or retrieve page title for taxonomy term archive. * * Useful for taxonomy term template files for displaying the taxonomy term page title. - * It has less overhead than {@link wp_title()}, because of its limited implementation. - * - * It does not support placing the separator after the title, but by leaving the - * prefix parameter empty, you can set the title separator manually. The prefix - * does not automatically place a space between the prefix, so if there should + * The prefix does not automatically place a space between the prefix, so if there should * be a space, the parameter value will need to have it at the end. * * @since 3.1.0 * - * @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. + * @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|void Title when retrieving. */ function single_term_title( $prefix = '', $display = true ) { $term = get_queried_object(); @@ -1055,20 +1385,18 @@ function single_term_title( $prefix = '', $display = true ) { /** * Display or retrieve page title for post archive based on date. * - * Useful for when the template only needs to display the month and year, if - * either are available. Optimized for just this purpose, so if it is all that - * is needed, should be better than {@link wp_title()}. - * - * It does not support placing the separator after the title, but by leaving the - * prefix parameter empty, you can set the title separator manually. The prefix - * does not automatically place a space between the prefix, so if there should - * be a space, the parameter value will need to have it at the end. + * Useful for when the template only needs to display the month and year, + * if either are available. The prefix does not automatically place a space + * between the prefix, so if there should be a space, the parameter value + * will need to have it at the end. * * @since 0.71 * - * @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. + * @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|void Title when retrieving. */ function single_month_title($prefix = '', $display = true ) { global $wp_locale; @@ -1095,6 +1423,121 @@ function single_month_title($prefix = '', $display = true ) { echo $result; } +/** + * Display the archive title based on the queried object. + * + * @since 4.1.0 + * + * @see get_the_archive_title() + * + * @param string $before Optional. Content to prepend to the title. Default empty. + * @param string $after Optional. Content to append to the title. Default empty. + */ +function the_archive_title( $before = '', $after = '' ) { + $title = get_the_archive_title(); + + if ( ! empty( $title ) ) { + echo $before . $title . $after; + } +} + +/** + * Retrieve the archive title based on the queried object. + * + * @since 4.1.0 + * + * @return string Archive title. + */ +function get_the_archive_title() { + if ( is_category() ) { + $title = sprintf( __( 'Category: %s' ), single_cat_title( '', false ) ); + } elseif ( is_tag() ) { + $title = sprintf( __( 'Tag: %s' ), single_tag_title( '', false ) ); + } elseif ( is_author() ) { + $title = sprintf( __( 'Author: %s' ), '' . get_the_author() . '' ); + } elseif ( is_year() ) { + $title = sprintf( __( 'Year: %s' ), get_the_date( _x( 'Y', 'yearly archives date format' ) ) ); + } elseif ( is_month() ) { + $title = sprintf( __( 'Month: %s' ), get_the_date( _x( 'F Y', 'monthly archives date format' ) ) ); + } elseif ( is_day() ) { + $title = sprintf( __( 'Day: %s' ), get_the_date( _x( 'F j, Y', 'daily archives date format' ) ) ); + } elseif ( is_tax( 'post_format' ) ) { + if ( is_tax( 'post_format', 'post-format-aside' ) ) { + $title = _x( 'Asides', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-gallery' ) ) { + $title = _x( 'Galleries', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-image' ) ) { + $title = _x( 'Images', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-video' ) ) { + $title = _x( 'Videos', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-quote' ) ) { + $title = _x( 'Quotes', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-link' ) ) { + $title = _x( 'Links', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-status' ) ) { + $title = _x( 'Statuses', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-audio' ) ) { + $title = _x( 'Audio', 'post format archive title' ); + } elseif ( is_tax( 'post_format', 'post-format-chat' ) ) { + $title = _x( 'Chats', 'post format archive title' ); + } + } elseif ( is_post_type_archive() ) { + $title = sprintf( __( 'Archives: %s' ), post_type_archive_title( '', false ) ); + } elseif ( is_tax() ) { + $tax = get_taxonomy( get_queried_object()->taxonomy ); + /* translators: 1: Taxonomy singular name, 2: Current taxonomy term */ + $title = sprintf( __( '%1$s: %2$s' ), $tax->labels->singular_name, single_term_title( '', false ) ); + } else { + $title = __( 'Archives' ); + } + + /** + * Filter the archive title. + * + * @since 4.1.0 + * + * @param string $title Archive title to be displayed. + */ + return apply_filters( 'get_the_archive_title', $title ); +} + +/** + * Display category, tag, or term description. + * + * @since 4.1.0 + * + * @see get_the_archive_description() + * + * @param string $before Optional. Content to prepend to the description. Default empty. + * @param string $after Optional. Content to append to the description. Default empty. + */ +function the_archive_description( $before = '', $after = '' ) { + $description = get_the_archive_description(); + if ( $description ) { + echo $before . $description . $after; + } +} + +/** + * Retrieve category, tag, or term description. + * + * @since 4.1.0 + * + * @return string Archive description. + */ +function get_the_archive_description() { + /** + * Filter the archive description. + * + * @since 4.1.0 + * + * @see term_description() + * + * @param string $description Archive description to be displayed. + */ + return apply_filters( 'get_the_archive_description', term_description() ); +} + /** * Retrieve archive link content based on predefined or custom code. * @@ -1103,7 +1546,7 @@ function single_month_title($prefix = '', $display = true ) { * elements). Custom content is also supported using the before and after * parameters. * - * The 'link' format uses the link HTML element with the archives + * The 'link' format uses the `` HTML element with the **archives** * relationship. The before and after parameters are not used. The text * parameter is used to describe the link. * @@ -1121,11 +1564,11 @@ function single_month_title($prefix = '', $display = true ) { * * @since 1.0.0 * - * @param string $url URL to archive. - * @param string $text Archive text description. + * @param string $url URL to archive. + * @param string $text Archive text description. * @param string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom. - * @param string $before Optional. - * @param string $after Optional. + * @param string $before Optional. Content to prepend to the description. Default empty. + * @param string $after Optional. Content to append to the description. Default empty. * @return string HTML link content for archive. */ function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') { @@ -1145,21 +1588,29 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after = * Filter the archive link content. * * @since 2.6.0 + * @since 4.5.0 Added the `$url`, `$text`, `$format`, `$before`, and `$after` parameters. * * @param string $link_html The archive HTML link content. + * @param string $url URL to archive. + * @param string $text Archive text description. + * @param string $format Link format. Can be 'link', 'option', 'html', or custom. + * @param string $before Content to prepend to the description. + * @param string $after Content to append to the description. */ - $link_html = apply_filters( 'get_archives_link', $link_html ); - - return $link_html; + return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after ); } /** * Display archive links based on type and format. * * @since 1.2.0 + * @since 4.4.0 $post_type arg was added. * * @see get_archives_link() * + * @global wpdb $wpdb + * @global WP_Locale $wp_locale + * * @param string|array $args { * Default archive links arguments. Optional. * @@ -1177,11 +1628,12 @@ function get_archives_link($url, $text, $format = 'html', $before = '', $after = * @type string $before Markup to prepend to the beginning of each link. Default empty. * @type string $after Markup to append to the end of each link. Default empty. * @type bool $show_post_count Whether to display the post count alongside the link. Default false. - * @type bool $echo Whether to echo or return the links list. Default 1|true to echo. + * @type bool|int $echo Whether to echo or return the links list. Default 1|true to echo. * @type string $order Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'. * Default 'DESC'. + * @type string $post_type Post type. Default 'post'. * } - * @return string|null String when retrieving, null when displaying. + * @return string|void String when retrieving. */ function wp_get_archives( $args = '' ) { global $wpdb, $wp_locale; @@ -1191,10 +1643,17 @@ function wp_get_archives( $args = '' ) { 'format' => 'html', 'before' => '', 'after' => '', 'show_post_count' => false, 'echo' => 1, 'order' => 'DESC', + 'post_type' => 'post' ); $r = wp_parse_args( $args, $defaults ); + $post_type_object = get_post_type_object( $r['post_type'] ); + if ( ! is_post_type_viewable( $post_type_object ) ) { + return; + } + $r['post_type'] = $post_type_object->name; + if ( '' == $r['type'] ) { $r['type'] = 'monthly'; } @@ -1212,21 +1671,7 @@ function wp_get_archives( $args = '' ) { // this is what will separate dates on weekly archive links $archive_week_separator = '–'; - // over-ride general date format ? 0 = no: use the date format set in Options, 1 = yes: over-ride - $archive_date_format_over_ride = 0; - - // options for daily archive (only if you over-ride the general date format) - $archive_day_date_format = 'Y/m/d'; - - // options for weekly archive (only if you over-ride the general date format) - $archive_week_start_date_format = 'Y/m/d'; - $archive_week_end_date_format = 'Y/m/d'; - - if ( ! $archive_date_format_over_ride ) { - $archive_day_date_format = get_option( 'date_format' ); - $archive_week_start_date_format = get_option( 'date_format' ); - $archive_week_end_date_format = get_option( 'date_format' ); - } + $sql_where = $wpdb->prepare( "WHERE post_type = %s AND post_status = 'publish'", $r['post_type'] ); /** * Filter the SQL WHERE clause for retrieving archives. @@ -1236,7 +1681,7 @@ function wp_get_archives( $args = '' ) { * @param string $sql_where Portion of SQL query containing the WHERE clause. * @param array $r An array of default arguments. */ - $where = apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r ); + $where = apply_filters( 'getarchives_where', $sql_where, $r ); /** * Filter the SQL JOIN clause for retrieving archives. @@ -1270,6 +1715,9 @@ function wp_get_archives( $args = '' ) { $after = $r['after']; foreach ( (array) $results as $result ) { $url = get_month_link( $result->year, $result->month ); + if ( 'post' !== $r['post_type'] ) { + $url = add_query_arg( 'post_type', $r['post_type'], $url ); + } /* translators: 1: month name, 2: 4-digit year */ $text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $result->month ), $result->year ); if ( $r['show_post_count'] ) { @@ -1290,6 +1738,9 @@ function wp_get_archives( $args = '' ) { $after = $r['after']; foreach ( (array) $results as $result) { $url = get_year_link( $result->year ); + if ( 'post' !== $r['post_type'] ) { + $url = add_query_arg( 'post_type', $r['post_type'], $url ); + } $text = sprintf( '%d', $result->year ); if ( $r['show_post_count'] ) { $r['after'] = ' (' . $result->posts . ')' . $after; @@ -1303,15 +1754,17 @@ function wp_get_archives( $args = '' ) { $key = "wp_get_archives:$key:$last_changed"; if ( ! $results = wp_cache_get( $key, 'posts' ) ) { $results = $wpdb->get_results( $query ); - $cache[ $key ] = $results; wp_cache_set( $key, $results, 'posts' ); } if ( $results ) { $after = $r['after']; foreach ( (array) $results as $result ) { $url = get_day_link( $result->year, $result->month, $result->dayofmonth ); + if ( 'post' !== $r['post_type'] ) { + $url = add_query_arg( 'post_type', $r['post_type'], $url ); + } $date = sprintf( '%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth ); - $text = mysql2date( $archive_day_date_format, $date ); + $text = mysql2date( get_option( 'date_format' ), $date ); if ( $r['show_post_count'] ) { $r['after'] = ' (' . $result->posts . ')' . $after; } @@ -1335,9 +1788,12 @@ function wp_get_archives( $args = '' ) { $arc_year = $result->yr; $arc_w_last = $result->week; $arc_week = get_weekstartend( $result->yyyymmdd, get_option( 'start_of_week' ) ); - $arc_week_start = date_i18n( $archive_week_start_date_format, $arc_week['start'] ); - $arc_week_end = date_i18n( $archive_week_end_date_format, $arc_week['end'] ); + $arc_week_start = date_i18n( get_option( 'date_format' ), $arc_week['start'] ); + $arc_week_end = date_i18n( get_option( 'date_format' ), $arc_week['end'] ); $url = sprintf( '%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&', '=', $result->week ); + if ( 'post' !== $r['post_type'] ) { + $url = add_query_arg( 'post_type', $r['post_type'], $url ); + } $text = $arc_week_start . $archive_week_separator . $arc_week_end; if ( $r['show_post_count'] ) { $r['after'] = ' (' . $result->posts . ')' . $after; @@ -1347,7 +1803,7 @@ function wp_get_archives( $args = '' ) { } } } elseif ( ( 'postbypost' == $r['type'] ) || ('alpha' == $r['type'] ) ) { - $orderby = ( 'alpha' == $r['type'] ) ? 'post_title ASC ' : 'post_date DESC '; + $orderby = ( 'alpha' == $r['type'] ) ? 'post_title ASC ' : 'post_date DESC, ID DESC '; $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit"; $key = md5( $query ); $key = "wp_get_archives:$key:$last_changed"; @@ -1397,70 +1853,81 @@ function calendar_week_mod($num) { * no posts for the month, then it will not be displayed. * * @since 1.0.0 - * @uses calendar_week_mod() + * + * @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. + * @param bool $echo Optional, default is true. Set to false for return. + * @return string|void String when retrieving. */ -function get_calendar($initial = true, $echo = true) { +function get_calendar( $initial = true, $echo = true ) { global $wpdb, $m, $monthnum, $year, $wp_locale, $posts; $key = md5( $m . $monthnum . $year ); - if ( $cache = wp_cache_get( 'get_calendar', 'calendar' ) ) { - if ( is_array($cache) && isset( $cache[ $key ] ) ) { - if ( $echo ) { - /** This filter is documented in wp-includes/general-template.php */ - echo apply_filters( 'get_calendar', $cache[$key] ); - return; - } else { - /** This filter is documented in wp-includes/general-template.php */ - return apply_filters( 'get_calendar', $cache[$key] ); - } + $cache = wp_cache_get( 'get_calendar', 'calendar' ); + + if ( $cache && is_array( $cache ) && isset( $cache[ $key ] ) ) { + /** This filter is documented in wp-includes/general-template.php */ + $output = apply_filters( 'get_calendar', $cache[ $key ] ); + + if ( $echo ) { + echo $output; + return; } + + return $output; } - if ( !is_array($cache) ) + if ( ! is_array( $cache ) ) { $cache = array(); + } // Quick check. If we have no posts at all, abort! - if ( !$posts ) { + if ( ! $posts ) { $gotsome = $wpdb->get_var("SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1"); - if ( !$gotsome ) { + if ( ! $gotsome ) { $cache[ $key ] = ''; wp_cache_set( 'get_calendar', $cache, 'calendar' ); return; } } - if ( isset($_GET['w']) ) - $w = ''.intval($_GET['w']); - + if ( isset( $_GET['w'] ) ) { + $w = (int) $_GET['w']; + } // week_begins = 0 stands for Sunday - $week_begins = intval(get_option('start_of_week')); + $week_begins = (int) get_option( 'start_of_week' ); + $ts = current_time( 'timestamp' ); // Let's figure out when we are - if ( !empty($monthnum) && !empty($year) ) { - $thismonth = ''.zeroise(intval($monthnum), 2); - $thisyear = ''.intval($year); - } elseif ( !empty($w) ) { + if ( ! empty( $monthnum ) && ! empty( $year ) ) { + $thismonth = zeroise( intval( $monthnum ), 2 ); + $thisyear = (int) $year; + } elseif ( ! empty( $w ) ) { // We need to get the month from MySQL - $thisyear = ''.intval(substr($m, 0, 4)); - $d = (($w - 1) * 7) + 6; //it seems MySQL's weeks disagree with PHP's + $thisyear = (int) substr( $m, 0, 4 ); + //it seems MySQL's weeks disagree with PHP's + $d = ( ( $w - 1 ) * 7 ) + 6; $thismonth = $wpdb->get_var("SELECT DATE_FORMAT((DATE_ADD('{$thisyear}0101', INTERVAL $d DAY) ), '%m')"); - } elseif ( !empty($m) ) { - $thisyear = ''.intval(substr($m, 0, 4)); - if ( strlen($m) < 6 ) - $thismonth = '01'; - else - $thismonth = ''.zeroise(intval(substr($m, 4, 2)), 2); + } elseif ( ! empty( $m ) ) { + $thisyear = (int) substr( $m, 0, 4 ); + if ( strlen( $m ) < 6 ) { + $thismonth = '01'; + } else { + $thismonth = zeroise( (int) substr( $m, 4, 2 ), 2 ); + } } else { - $thisyear = gmdate('Y', current_time('timestamp')); - $thismonth = gmdate('m', current_time('timestamp')); + $thisyear = gmdate( 'Y', $ts ); + $thismonth = gmdate( 'm', $ts ); } - $unixmonth = mktime(0, 0 , 0, $thismonth, 1, $thisyear); - $last_day = date('t', $unixmonth); + $unixmonth = mktime( 0, 0 , 0, $thismonth, 1, $thisyear ); + $last_day = date( 't', $unixmonth ); // Get the next and previous month and year with at least one post $previous = $wpdb->get_row("SELECT MONTH(post_date) AS month, YEAR(post_date) AS year @@ -1479,19 +1946,23 @@ function get_calendar($initial = true, $echo = true) { /* translators: Calendar caption: 1: month name, 2: 4-digit year */ $calendar_caption = _x('%1$s %2$s', 'calendar caption'); $calendar_output = ' - + '; $myweek = array(); - for ( $wdcount=0; $wdcount<=6; $wdcount++ ) { - $myweek[] = $wp_locale->get_weekday(($wdcount+$week_begins)%7); + for ( $wdcount = 0; $wdcount <= 6; $wdcount++ ) { + $myweek[] = $wp_locale->get_weekday( ( $wdcount + $week_begins ) % 7 ); } foreach ( $myweek as $wd ) { - $day_name = (true == $initial) ? $wp_locale->get_weekday_initial($wd) : $wp_locale->get_weekday_abbrev($wd); - $wd = esc_attr($wd); + $day_name = $initial ? $wp_locale->get_weekday_initial( $wd ) : $wp_locale->get_weekday_abbrev( $wd ); + $wd = esc_attr( $wd ); $calendar_output .= "\n\t\t"; } @@ -1503,7 +1974,9 @@ function get_calendar($initial = true, $echo = true) { '; if ( $previous ) { - $calendar_output .= "\n\t\t".''; + $calendar_output .= "\n\t\t".''; } else { $calendar_output .= "\n\t\t".''; } @@ -1511,7 +1984,9 @@ function get_calendar($initial = true, $echo = true) { $calendar_output .= "\n\t\t".''; if ( $next ) { - $calendar_output .= "\n\t\t".''; + $calendar_output .= "\n\t\t".''; } else { $calendar_output .= "\n\t\t".''; } @@ -1523,6 +1998,8 @@ function get_calendar($initial = true, $echo = true) { '; + $daywithpost = array(); + // Get days with posts $dayswithposts = $wpdb->get_results("SELECT DISTINCT DAYOFMONTH(post_date) FROM $wpdb->posts WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00' @@ -1532,67 +2009,55 @@ function get_calendar($initial = true, $echo = true) { foreach ( (array) $dayswithposts as $daywith ) { $daywithpost[] = $daywith[0]; } - } else { - $daywithpost = array(); } - if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'camino') !== false || stripos($_SERVER['HTTP_USER_AGENT'], 'safari') !== false) - $ak_title_separator = "\n"; - else - $ak_title_separator = ', '; - - $ak_titles_for_day = array(); - $ak_post_titles = $wpdb->get_results("SELECT ID, post_title, DAYOFMONTH(post_date) as dom " - ."FROM $wpdb->posts " - ."WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00' " - ."AND post_date <= '{$thisyear}-{$thismonth}-{$last_day} 23:59:59' " - ."AND post_type = 'post' AND post_status = 'publish'" - ); - if ( $ak_post_titles ) { - foreach ( (array) $ak_post_titles as $ak_post_title ) { - - /** This filter is documented in wp-includes/post-template.php */ - $post_title = esc_attr( apply_filters( 'the_title', $ak_post_title->post_title, $ak_post_title->ID ) ); - - if ( empty($ak_titles_for_day['day_'.$ak_post_title->dom]) ) - $ak_titles_for_day['day_'.$ak_post_title->dom] = ''; - if ( empty($ak_titles_for_day["$ak_post_title->dom"]) ) // first one - $ak_titles_for_day["$ak_post_title->dom"] = $post_title; - else - $ak_titles_for_day["$ak_post_title->dom"] .= $ak_title_separator . $post_title; - } + // See how much we should pad in the beginning + $pad = calendar_week_mod( date( 'w', $unixmonth ) - $week_begins ); + if ( 0 != $pad ) { + $calendar_output .= "\n\t\t".''; } - // See how much we should pad in the beginning - $pad = calendar_week_mod(date('w', $unixmonth)-$week_begins); - if ( 0 != $pad ) - $calendar_output .= "\n\t\t".''; + $newrow = false; + $daysinmonth = (int) date( 't', $unixmonth ); - $daysinmonth = intval(date('t', $unixmonth)); for ( $day = 1; $day <= $daysinmonth; ++$day ) { - if ( isset($newrow) && $newrow ) + if ( isset($newrow) && $newrow ) { $calendar_output .= "\n\t\n\t\n\t\t"; + } $newrow = false; - if ( $day == gmdate('j', current_time('timestamp')) && $thismonth == gmdate('m', current_time('timestamp')) && $thisyear == gmdate('Y', current_time('timestamp')) ) + if ( $day == gmdate( 'j', $ts ) && + $thismonth == gmdate( 'm', $ts ) && + $thisyear == gmdate( 'Y', $ts ) ) { $calendar_output .= ''; - if ( 6 == calendar_week_mod(date('w', mktime(0, 0 , 0, $thismonth, $day, $thisyear))-$week_begins) ) + if ( 6 == calendar_week_mod( date( 'w', mktime(0, 0 , 0, $thismonth, $day, $thisyear ) ) - $week_begins ) ) { $newrow = true; + } } - $pad = 7 - calendar_week_mod(date('w', mktime(0, 0 , 0, $thismonth, $day, $thisyear))-$week_begins); - if ( $pad != 0 && $pad != 7 ) - $calendar_output .= "\n\t\t".''; - + $pad = 7 - calendar_week_mod( date( 'w', mktime( 0, 0 , 0, $thismonth, $day, $thisyear ) ) - $week_begins ); + if ( $pad != 0 && $pad != 7 ) { + $calendar_output .= "\n\t\t".''; + } $calendar_output .= "\n\t\n\t\n\t
    ' . sprintf($calendar_caption, $wp_locale->get_month($thismonth), date('Y', $unixmonth)) . '' . sprintf( + $calendar_caption, + $wp_locale->get_month( $thismonth ), + date( 'Y', $unixmonth ) + ) . '
    $day_name
    « ' . $wp_locale->get_month_abbrev($wp_locale->get_month($previous->month)) . '« ' . + $wp_locale->get_month_abbrev( $wp_locale->get_month( $previous->month ) ) . + '  ' . $wp_locale->get_month_abbrev($wp_locale->get_month($next->month)) . ' »' . + $wp_locale->get_month_abbrev( $wp_locale->get_month( $next->month ) ) . + ' » 
      
    '; - else + } else { $calendar_output .= ''; + } - if ( in_array($day, $daywithpost) ) // any posts today? - $calendar_output .= '$day"; - else + if ( in_array( $day, $daywithpost ) ) { + // any posts today? + $date_format = date( _x( 'F j, Y', 'daily archives date format' ), strtotime( "{$thisyear}-{$thismonth}-{$day}" ) ); + $label = sprintf( __( 'Posts published on %s' ), $date_format ); + $calendar_output .= sprintf( + '%s', + get_day_link( $thisyear, $thismonth, $day ), + esc_attr( $label ), + $day + ); + } else { $calendar_output .= $day; + } $calendar_output .= '  
    "; $cache[ $key ] = $calendar_output; @@ -1607,11 +2072,10 @@ function get_calendar($initial = true, $echo = true) { * @param string $calendar_output HTML output of the calendar. */ echo apply_filters( 'get_calendar', $calendar_output ); - } else { - /** This filter is documented in wp-includes/general-template.php */ - return apply_filters( 'get_calendar', $calendar_output ); + return; } - + /** This filter is documented in wp-includes/general-template.php */ + return apply_filters( 'get_calendar', $calendar_output ); } /** @@ -1623,10 +2087,6 @@ function get_calendar($initial = true, $echo = true) { function delete_get_calendar_cache() { wp_cache_delete( 'get_calendar', 'calendar' ); } -add_action( 'save_post', 'delete_get_calendar_cache' ); -add_action( 'delete_post', 'delete_get_calendar_cache' ); -add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' ); -add_action( 'update_option_gmt_offset', 'delete_get_calendar_cache' ); /** * Display all of the allowed tags in HTML format with attributes. @@ -1635,7 +2095,8 @@ add_action( 'update_option_gmt_offset', '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. */ @@ -1651,7 +2112,7 @@ function allowed_tags() { } $allowed .= '> '; } - return htmlentities($allowed); + return htmlentities( $allowed ); } /***** Date/Time tags *****/ @@ -1679,17 +2140,19 @@ function the_date_xml() { * * @since 0.71 * - * @uses get_the_date() - * @param string $d Optional. PHP date format defaults to the date_format option if not specified. + * @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. + * @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|void String if retrieving. */ function the_date( $d = '', $before = '', $after = '', $echo = true ) { global $currentday, $previousday; - if ( $currentday != $previousday ) { + if ( is_new_day() ) { $the_date = $before . get_the_date( $d ) . $after; $previousday = $currentday; @@ -1711,8 +2174,6 @@ function the_date( $d = '', $before = '', $after = '', $echo = true ) { else return $the_date; } - - return null; } /** @@ -1725,7 +2186,7 @@ function the_date( $d = '', $before = '', $after = '', $echo = true ) { * * @param string $d Optional. PHP date format defaults to the date_format option if not specified. * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post. - * @return string|bool Date the current post was written. False on failure. + * @return false|string Date the current post was written. False on failure. */ function get_the_date( $d = '', $post = null ) { $post = get_post( $post ); @@ -1758,14 +2219,13 @@ function get_the_date( $d = '', $post = null ) { * * @since 2.1.0 * - * @param string $d Optional. PHP date format defaults to the date_format option if not specified. + * @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. + * @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|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; /** @@ -1843,7 +2303,7 @@ function the_time( $d = '' ) { * was written. Either 'G', 'U', or php date format defaults * to the value specified in the time_format option. Default empty. * @param int|WP_Post $post WP_Post object or ID. Default is global $post object. - * @return string|int|bool Formatted date string or Unix timestamp. False on failure. + * @return false|string Formatted date string or Unix timestamp. False on failure. */ function get_the_time( $d = '', $post = null ) { $post = get_post($post); @@ -1881,7 +2341,7 @@ function get_the_time( $d = '', $post = null ) { * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false. * @param int|WP_Post $post WP_Post object or ID. Default is global $post object. * @param bool $translate Whether to translate the time string. Default false. - * @return string|int|bool Formatted date string or Unix timestamp. False on failure. + * @return false|string|int Formatted date string or Unix timestamp. False on failure. */ function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) { $post = get_post($post); @@ -1968,7 +2428,7 @@ function get_the_modified_time($d = '') { * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false. * @param int|WP_Post $post WP_Post object or ID. Default is global $post object. * @param bool $translate Whether to translate the time string. Default false. - * @return string|int|bool Formatted date string or Unix timestamp. False on failure. + * @return false|string Formatted date string or Unix timestamp. False on failure. */ function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) { $post = get_post($post); @@ -1999,8 +2459,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 - * @uses $post + * + * @global WP_Locale $wp_locale */ function the_weekday() { global $wp_locale; @@ -2013,8 +2473,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 ); } /** @@ -2025,6 +2484,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. */ @@ -2101,8 +2564,27 @@ function feed_links( $args = array() ) { $args = wp_parse_args( $args, $defaults ); - echo '\n"; - echo '\n"; + /** + * Filter whether to display the posts feed link. + * + * @since 4.4.0 + * + * @param bool $show Whether to display the posts feed link. Default true. + */ + if ( apply_filters( 'feed_links_show_posts_feed', true ) ) { + echo '\n"; + } + + /** + * Filter whether to display the comments feed link. + * + * @since 4.4.0 + * + * @param bool $show Whether to display the comments feed link. Default true. + */ + if ( apply_filters( 'feed_links_show_comments_feed', true ) ) { + echo '\n"; + } } /** @@ -2122,6 +2604,8 @@ function feed_links_extra( $args = array() ) { 'cattitle' => __('%1$s %2$s %3$s Category Feed'), /* translators: 1: blog name, 2: separator(raquo), 3: tag name */ 'tagtitle' => __('%1$s %2$s %3$s Tag Feed'), + /* translators: 1: blog name, 2: separator(raquo), 3: term name, 4: taxonomy singular name */ + 'taxtitle' => __('%1$s %2$s %3$s %4$s Feed'), /* translators: 1: blog name, 2: separator(raquo), 3: author name */ 'authortitle' => __('%1$s %2$s Posts by %3$s Feed'), /* translators: 1: blog name, 2: separator(raquo), 3: search phrase */ @@ -2162,6 +2646,11 @@ function feed_links_extra( $args = array() ) { $title = sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $term->name ); $href = get_tag_feed_link( $term->term_id ); } + } elseif ( is_tax() ) { + $term = get_queried_object(); + $tax = get_taxonomy( $term->taxonomy ); + $title = sprintf( $args['taxtitle'], get_bloginfo('name'), $args['separator'], $term->name, $tax->labels->singular_name ); + $href = get_term_feed_link( $term->term_id, $term->taxonomy ); } elseif ( is_author() ) { $author_id = intval( get_query_var('author') ); @@ -2188,7 +2677,7 @@ function feed_links_extra( $args = array() ) { * @since 2.0.0 */ function rsd_link() { - echo '\n"; + echo '' . "\n"; } /** @@ -2231,6 +2720,40 @@ function wp_no_robots() { echo "\n"; } +/** + * Display site icon meta tags. + * + * @since 4.3.0 + * + * @link http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#rel-icon HTML5 specification link icon. + */ +function wp_site_icon() { + if ( ! has_site_icon() && ! is_customize_preview() ) { + return; + } + + $meta_tags = array( + sprintf( '', esc_url( get_site_icon_url( 32 ) ) ), + sprintf( '', esc_url( get_site_icon_url( 192 ) ) ), + sprintf( '', esc_url( get_site_icon_url( 180 ) ) ), + sprintf( '', esc_url( get_site_icon_url( 270 ) ) ), + ); + + /** + * Filter the site icon meta tags, so Plugins can add their own. + * + * @since 4.3.0 + * + * @param array $meta_tags Site Icon meta elements. + */ + $meta_tags = apply_filters( 'site_icon_meta_tags', $meta_tags ); + $meta_tags = array_filter( $meta_tags ); + + foreach ( $meta_tags as $meta_tag ) { + echo "$meta_tag\n"; + } +} + /** * Whether the user should have a WYSIWIG editor. * @@ -2239,10 +2762,17 @@ 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() { - global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE; + global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE, $is_edge; if ( !isset($wp_rich_edit) ) { $wp_rich_edit = false; @@ -2250,7 +2780,7 @@ function user_can_richedit() { if ( get_user_option( 'rich_editing' ) == 'true' || ! is_user_logged_in() ) { // default to 'true' for logged out users if ( $is_safari ) { $wp_rich_edit = ! wp_is_mobile() || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval( $match[1] ) >= 534 ); - } elseif ( $is_gecko || $is_chrome || $is_IE || ( $is_opera && !wp_is_mobile() ) ) { + } elseif ( $is_gecko || $is_chrome || $is_IE || $is_edge || ( $is_opera && !wp_is_mobile() ) ) { $wp_rich_edit = true; } } @@ -2297,23 +2827,23 @@ function wp_default_editor() { * Renders an editor. * * Using this function is the proper way to output all needed components for both TinyMCE and Quicktags. - * _WP_Editors should not be used directly. See http://core.trac.wordpress.org/ticket/17144. + * _WP_Editors should not be used directly. See https://core.trac.wordpress.org/ticket/17144. * * NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason * running wp_editor() inside of a metabox is not a good idea unless only Quicktags is used. * On the post edit screen several actions can be used to include additional editors * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'. - * See http://core.trac.wordpress.org/ticket/19173 for more information. + * See https://core.trac.wordpress.org/ticket/19173 for more information. * - * @see wp-includes/class-wp-editor.php + * @see _WP_Editors::editor() * @since 3.3.0 * - * @param string $content Initial content for the editor. + * @param string $content Initial content for the editor. * @param string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /[a-z]+/. - * @param array $settings See _WP_Editors::editor(). + * @param array $settings See _WP_Editors::editor(). */ function wp_editor( $content, $editor_id, $settings = array() ) { - if ( ! class_exists( '_WP_Editors' ) ) + if ( ! class_exists( '_WP_Editors', false ) ) require( ABSPATH . WPINC . '/class-wp-editor.php' ); _WP_Editors::editor($content, $editor_id, $settings); @@ -2326,10 +2856,9 @@ function wp_editor( $content, $editor_id, $settings = array() ) { * to ensure that it is safe for placing in an html attribute. * * @since 2.3.0 - * @uses esc_attr() * * @param bool $escaped Whether the result is escaped. Default true. - * Only use when you are later escaping it. Do not use unescaped. + * Only use when you are later escaping it. Do not use unescaped. * @return string */ function get_search_query( $escaped = true ) { @@ -2353,7 +2882,6 @@ function get_search_query( $escaped = true ) { * The search query string is passed through {@link esc_attr()} * to ensure that it is safe for placing in an html attribute. * - * @uses esc_attr() * @since 2.1.0 */ function the_search_query() { @@ -2368,16 +2896,16 @@ function the_search_query() { } /** - * Display the language attributes for the html tag. + * Gets the language attributes for the html tag. * * Builds up a set of html attributes containing the text direction and language * information for the page. * - * @since 2.1.0 + * @since 4.3.0 * - * @param string $doctype The type of html document (xhtml|html). + * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'. */ -function language_attributes($doctype = 'html') { +function get_language_attributes( $doctype = 'html' ) { $attributes = array(); if ( function_exists( 'is_rtl' ) && is_rtl() ) @@ -2397,10 +2925,27 @@ function language_attributes($doctype = 'html') { * Filter the language attributes for display in the html tag. * * @since 2.5.0 + * @since 4.3.0 Added the `$doctype` parameter. * * @param string $output A space-separated list of language attributes. + * @param string $doctype The type of html document (xhtml|html). */ - echo apply_filters( 'language_attributes', $output ); + return apply_filters( 'language_attributes', $output, $doctype ); +} + +/** + * Displays the language attributes for the html tag. + * + * Builds up a set of html attributes containing the text direction and language + * information for the page. + * + * @since 2.1.0 + * @since 4.3.0 Converted into a wrapper for get_language_attributes(). + * + * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'. + */ +function language_attributes( $doctype = 'html' ) { + echo get_language_attributes( $doctype ); } /** @@ -2451,25 +2996,48 @@ function language_attributes($doctype = 'html') { * * @since 2.1.0 * - * @param string|array $args Optional. Override defaults. - * @return array|string String of page links or array of page links. + * @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. + * + * @type string $base Base of the paginated url. Default empty. + * @type string $format Format for the pagination structure. Default empty. + * @type int $total The total amount of pages. Default is the value WP_Query's + * `max_num_pages` or 1. + * @type int $current The current page number. Default is 'paged' query var or 1. + * @type bool $show_all Whether to show all pages. Default false. + * @type int $end_size How many numbers on either the start and the end list edges. + * Default 1. + * @type int $mid_size How many numbers to either side of the current pages. Default 2. + * @type bool $prev_next Whether to include the previous and next links in the list. Default true. + * @type bool $prev_text The previous page text. Default '« Previous'. + * @type bool $next_text The next page text. Default '« Previous'. + * @type string $type Controls format of the returned value. Possible values are 'plain', + * 'array' and 'list'. Default is 'plain'. + * @type array $add_args An array of query args to add. Default false. + * @type string $add_fragment A string to append to each link. Default empty. + * @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|void String of page links or array of page links. */ function paginate_links( $args = '' ) { global $wp_query, $wp_rewrite; - $total = ( isset( $wp_query->max_num_pages ) ) ? $wp_query->max_num_pages : 1; - $current = ( get_query_var( 'paged' ) ) ? intval( get_query_var( 'paged' ) ) : 1; + // Setting up default values based on the current URL. $pagenum_link = html_entity_decode( get_pagenum_link() ); - $query_args = array(); $url_parts = explode( '?', $pagenum_link ); - if ( isset( $url_parts[1] ) ) { - wp_parse_str( $url_parts[1], $query_args ); - } + // Get max pages and current page out of the current query, if available. + $total = isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1; + $current = get_query_var( 'paged' ) ? intval( get_query_var( 'paged' ) ) : 1; - $pagenum_link = remove_query_arg( array_keys( $query_args ), $pagenum_link ); - $pagenum_link = trailingslashit( $pagenum_link ) . '%_%'; + // Append the format placeholder to the base URL. + $pagenum_link = trailingslashit( $url_parts[0] ) . '%_%'; + // URL base depends on permalink settings. $format = $wp_rewrite->using_index_permalinks() && ! strpos( $pagenum_link, 'index.php' ) ? 'index.php/' : ''; $format .= $wp_rewrite->using_permalinks() ? user_trailingslashit( $wp_rewrite->pagination_base . '/%#%', 'paged' ) : '?paged=%#%'; @@ -2485,7 +3053,7 @@ function paginate_links( $args = '' ) { 'end_size' => 1, 'mid_size' => 2, 'type' => 'plain', - 'add_args' => false, // array of query args to add + 'add_args' => array(), // array of query args to add 'add_fragment' => '', 'before_page_number' => '', 'after_page_number' => '' @@ -2493,6 +3061,28 @@ function paginate_links( $args = '' ) { $args = wp_parse_args( $args, $defaults ); + if ( ! is_array( $args['add_args'] ) ) { + $args['add_args'] = array(); + } + + // Merge additional query vars found in the original URL into 'add_args' array. + if ( isset( $url_parts[1] ) ) { + // Find the format argument. + $format = explode( '?', str_replace( '%_%', $args['format'], $args['base'] ) ); + $format_query = isset( $format[1] ) ? $format[1] : ''; + wp_parse_str( $format_query, $format_args ); + + // Find the query args of the requested URL. + wp_parse_str( $url_parts[1], $url_query_args ); + + // Remove the format argument from the array of query arguments, to avoid overwriting custom format. + foreach ( $format_args as $format_arg => $format_arg_value ) { + unset( $url_query_args[ $format_arg ] ); + } + + $args['add_args'] = array_merge( $args['add_args'], urlencode_deep( $url_query_args ) ); + } + // Who knows what else people pass in $args $total = (int) $args['total']; if ( $total < 2 ) { @@ -2507,7 +3097,7 @@ function paginate_links( $args = '' ) { if ( $mid_size < 0 ) { $mid_size = 2; } - $add_args = is_array( $args['add_args'] ) ? $args['add_args'] : false; + $add_args = $args['add_args']; $r = ''; $page_links = array(); $dots = false; @@ -2580,18 +3170,27 @@ function paginate_links( $args = '' ) { * Registers an admin colour scheme css file. * * Allows a plugin to register a new admin colour scheme. For example: - * - * wp_admin_css_color('classic', __('Classic'), admin_url("css/colors-classic.css"), - * array('#07273E', '#14568A', '#D54E21', '#2683AE')); - * + * + * wp_admin_css_color( 'classic', __( 'Classic' ), admin_url( "css/colors-classic.css" ), array( + * '#07273E', '#14568A', '#D54E21', '#2683AE' + * ) ); * * @since 2.5.0 * - * @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. - * @param array $colors Optional An array of CSS color definitions which are used to give the user a feel for the theme. - * @param array $icons Optional An array of CSS color definitions used to color any SVG icons + * @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 color scheme. + * @param array $colors Optional. An array of CSS color definition strings which are used + * to give the user a feel for the theme. + * @param array $icons { + * Optional. CSS color definitions used to color any SVG icons. + * + * @type string $base SVG icon base color. + * @type string $focus SVG icon color on focus. + * @type string $current SVG icon color of current admin menu link. + * } */ function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) { global $_wp_admin_css_colors; @@ -2611,15 +3210,17 @@ 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' : ''; - $suffix .= defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min'; + $suffix .= SCRIPT_DEBUG ? '' : '.min'; wp_admin_css_color( 'fresh', _x( 'Default', 'admin color scheme' ), false, - array( '#222', '#333', '#0074a2', '#2ea2cc' ), - array( 'base' => '#999', 'focus' => '#2ea2cc', 'current' => '#fff' ) + array( '#222', '#333', '#0073aa', '#00a0d2' ), + array( 'base' => '#82878c', 'focus' => '#00a0d2', 'current' => '#fff' ) ); // Other color schemes are not available when running out of src @@ -2678,6 +3279,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') ) { @@ -2713,21 +3315,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. + * @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 ( !is_a($wp_styles, '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 @@ -2820,7 +3417,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 ) ) { @@ -2857,13 +3454,13 @@ function get_the_generator( $type = '' ) { $gen = ''; break; case 'atom': - $gen = 'WordPress'; + $gen = 'WordPress'; break; case 'rss2': - $gen = 'http://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . ''; + $gen = 'https://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . ''; break; case 'rdf': - $gen = ''; + $gen = ''; break; case 'comment': $gen = ''; @@ -2876,11 +3473,11 @@ function get_the_generator( $type = '' ) { /** * Filter the HTML for the retrieved generator type. * - * The dynamic portion of the hook name, $type, refers to the generator type. + * The dynamic portion of the hook name, `$type`, refers to the generator type. * * @since 2.5.0 * - * @param string $gen The HTML markup output to 'wp_head()'. + * @param string $gen The HTML markup output to {@see wp_head()}. * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom', * 'rss2', 'rdf', 'comment', 'export'. */ @@ -2896,7 +3493,7 @@ function get_the_generator( $type = '' ) { * * @param mixed $checked One of the values to compare * @param mixed $current (true) The other value to compare if not just true - * @param bool $echo Whether to echo or just return the string + * @param bool $echo Whether to echo or just return the string * @return string html attribute or empty string */ function checked( $checked, $current = true, $echo = true ) { @@ -2911,8 +3508,8 @@ function checked( $checked, $current = true, $echo = true ) { * @since 1.0.0 * * @param mixed $selected One of the values to compare - * @param mixed $current (true) The other value to compare if not just true - * @param bool $echo Whether to echo or just return the string + * @param mixed $current (true) The other value to compare if not just true + * @param bool $echo Whether to echo or just return the string * @return string html attribute or empty string */ function selected( $selected, $current = true, $echo = true ) { @@ -2927,8 +3524,8 @@ function selected( $selected, $current = true, $echo = true ) { * @since 3.0.0 * * @param mixed $disabled One of the values to compare - * @param mixed $current (true) The other value to compare if not just true - * @param bool $echo Whether to echo or just return the string + * @param mixed $current (true) The other value to compare if not just true + * @param bool $echo Whether to echo or just return the string * @return string html attribute or empty string */ function disabled( $disabled, $current = true, $echo = true ) { @@ -2943,10 +3540,10 @@ function disabled( $disabled, $current = true, $echo = true ) { * @since 2.8.0 * @access private * - * @param mixed $helper One of the values to compare - * @param mixed $current (true) The other value to compare if not just true - * @param bool $echo Whether to echo or just return the string - * @param string $type The type of checked|selected|disabled we are doing + * @param mixed $helper One of the values to compare + * @param mixed $current (true) The other value to compare if not just true + * @param bool $echo Whether to echo or just return the string + * @param string $type The type of checked|selected|disabled we are doing * @return string html attribute or empty string */ function __checked_selected_helper( $helper, $current, $echo, $type ) {