$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 );
}
/**
$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 );
}
/**
$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 );
}
/**
* the parent, then load it. If it doesn't exist, then the default search form
* will be displayed. The default search form is HTML, which will be displayed.
* There is a filter applied to the search form HTML in order to edit or replace
- * it. The filter is 'get_search_form'.
+ * it. The filter is {@see 'get_search_form'}.
*
* This function is primarily used by themes which want to hardcode the search
* form into the sidebar and also by the search widget in WordPress.
*
* There is also an action that is called whenever the function is run called,
- * 'pre_get_search_form'. This can be useful for outputting JavaScript that the
+ * {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the
* search relies on or various formatting that applies to the beginning of the
* search. To give a few examples of what it can be used for.
*
$format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml';
/**
- * Filter the HTML format of the search form.
+ * Filters the HTML format of the search form.
*
* @since 3.6.0
*
$form = '<form role="search" method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
<label>
<span class="screen-reader-text">' . _x( 'Search for:', 'label' ) . '</span>
- <input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search …', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" title="' . esc_attr_x( 'Search for:', 'label' ) . '" />
+ <input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search …', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" />
</label>
<input type="submit" class="search-submit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />
</form>';
}
/**
- * Filter the HTML output of the search form.
+ * Filters the HTML output of the search form.
*
* @since 2.7.0
*
if ( $echo ) {
/**
- * Filter the HTML output for the Log In/Log Out link.
+ * Filters the HTML output for the Log In/Log Out link.
*
* @since 1.5.0
*
}
/**
- * Returns the Log Out URL.
+ * Retrieves the logout URL.
*
* Returns the URL that allows the user to log out of the site.
*
* @since 2.7.0
*
* @param string $redirect Path to redirect to on logout.
- * @return string A log out URL.
+ * @return string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url().
*/
function wp_logout_url($redirect = '') {
$args = array( 'action' => 'logout' );
$logout_url = wp_nonce_url( $logout_url, 'log-out' );
/**
- * Filter the logout URL.
+ * Filters the logout URL.
*
* @since 2.8.0
*
- * @param string $logout_url The Log Out URL.
+ * @param string $logout_url The HTML-encoded logout URL.
* @param string $redirect Path to redirect to on logout.
*/
return apply_filters( 'logout_url', $logout_url, $redirect );
}
/**
- * Returns the URL that allows the user to log in to the site.
+ * Retrieves the login URL.
*
* @since 2.7.0
*
- * @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.
+ * @param string $redirect Path to redirect to on log in.
+ * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present.
+ * Default false.
+ * @return string The login URL. Not HTML-encoded.
*/
function wp_login_url($redirect = '', $force_reauth = false) {
$login_url = site_url('wp-login.php', 'login');
$login_url = add_query_arg('reauth', '1', $login_url);
/**
- * Filter the login URL.
+ * Filters 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 $login_url The login URL. Not HTML-encoded.
* @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.
*/
*/
function wp_registration_url() {
/**
- * Filter the user registration URL.
+ * Filters the user registration URL.
*
* @since 3.6.0
*
* @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 field. Default 'Username'.
+ * @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'.
// 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' ),
);
/**
- * Filter the default login form output arguments.
+ * Filters the default login form output arguments.
*
* @since 3.0.0
*
$args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
/**
- * Filter content to display at the top of the login form.
+ * Filters content to display at the top of the login form.
*
* The filter evaluates just following the opening form tag element.
*
$login_form_top = apply_filters( 'login_form_top', '', $args );
/**
- * Filter content to display in the middle of the login form.
+ * Filters content to display in the middle of the login form.
*
* The filter evaluates just following the location where the 'login-password'
* field is displayed.
$login_form_middle = apply_filters( 'login_form_middle', '', $args );
/**
- * Filter content to display at the bottom of the login form.
+ * Filters content to display at the bottom of the login form.
*
* The filter evaluates just preceding the closing form tag element.
*
$lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') );
/**
- * Filter the Lost Password URL.
+ * Filters the Lost Password URL.
*
* @since 2.8.0
*
}
/**
- * Filter the HTML link to the Registration or Admin page.
+ * Filters the HTML link to the Registration or Admin page.
*
* Users are sent to the admin page if logged-in, or the registration page
* if enabled and logged-out.
/**
* Theme container function for the 'wp_meta' action.
*
- * The 'wp_meta' action can have several purposes, depending on how you use it,
+ * The {@see 'wp_meta'} action can have several purposes, depending on how you use it,
* but one purpose might have been to allow for theme switching.
*
* @since 1.5.0
}
/**
- * 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 {@see _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. wpurl - Blog URI path to WordPress.
- * 3. description - Secondary title
- *
- * 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
*
* @global string $wp_version
*
- * @param string $show Blog info to retrieve.
- * @param string $filter How to filter what is retrieved.
+ * @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(
+ _deprecated_argument( __FUNCTION__, '2.2.0', 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.' ),
'<code>' . $show . '</code>',
$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(
+ _deprecated_argument( __FUNCTION__, '2.2.0', 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.' ),
'<code>' . $show . '</code>',
if ( 'display' == $filter ) {
if ( $url ) {
/**
- * Filter the URL returned by get_bloginfo().
+ * Filters the URL returned by get_bloginfo().
*
* @since 2.0.5
*
$output = apply_filters( 'bloginfo_url', $output, $show );
} else {
/**
- * Filter the site information returned by get_bloginfo().
+ * Filters the site information returned by get_bloginfo().
*
* @since 0.71
*
}
/**
- * Filter the site icon URL.
+ * Filters the site icon URL.
*
* @site 4.4.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( '<a href="%1$s" class="custom-logo-link" rel="home" itemprop="url">%2$s</a>',
+ 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( '<a href="%1$s" class="custom-logo-link" style="display:none;"><img class="custom-logo"/></a>',
+ esc_url( home_url( '/' ) )
+ );
+ }
+
+ if ( is_multisite() && ms_is_switched() ) {
+ restore_current_blog();
+ }
+
+ /**
+ * Filters the custom logo output.
+ *
+ * @since 4.5.0
+ * @since 4.6.0 Added the `$blog_id` parameter.
+ *
+ * @param string $html Custom logo HTML output.
+ * @param int $blog_id ID of the blog to get the custom logo for.
+ */
+ return apply_filters( 'get_custom_logo', $html, $blog_id );
+}
+
+/**
+ * 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.
*
function wp_get_document_title() {
/**
- * Filter the document title before it is generated.
+ * Filters the document title before it is generated.
*
* Passing a non-empty value will short-circuit wp_get_document_title(),
* returning that value instead.
}
/**
- * Filter the separator for the document title.
+ * Filters the separator for the document title.
*
* @since 4.4.0
*
$sep = apply_filters( 'document_title_separator', '-' );
/**
- * Filter the parts of the document title.
+ * Filters the parts of the document title.
*
* @since 4.4.0
*
* important, which is the page that the user is looking at.
*
* There are also SEO benefits to having the blog title after or to the 'right'
- * or the page title. However, it is mostly common sense to have the blog title
+ * of the page title. However, it is mostly common sense to have the blog title
* to the right with most browsers supporting tabs. You can achieve this by
* using the seplocation parameter and setting the value to 'right'. This change
- * was introduced around 2.5.0, in case backwards compatibility of themes is
+ * was introduced around 2.5.0, in case backward compatibility of themes is
* important.
*
* @since 1.0.0
$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() ) ) {
}
/**
- * Filter the parts of the page title.
+ * Filters the parts of the page title.
*
* @since 4.0.0
*
}
/**
- * Filter the text of the page title.
+ * Filters the text of the page title.
*
* @since 2.0.0
*
return;
/**
- * Filter the page title for a single post.
+ * Filters the page title for a single post.
*
* @since 0.71
*
$post_type_obj = get_post_type_object( $post_type );
/**
- * Filter the post type archive title.
+ * Filters the post type archive title.
*
* @since 3.1.0
*
if ( is_category() ) {
/**
- * Filter the category archive page title.
+ * Filters the category archive page title.
*
* @since 2.0.10
*
$term_name = apply_filters( 'single_cat_title', $term->name );
} elseif ( is_tag() ) {
/**
- * Filter the tag archive page title.
+ * Filters the tag archive page title.
*
* @since 2.3.0
*
$term_name = apply_filters( 'single_tag_title', $term->name );
} elseif ( is_tax() ) {
/**
- * Filter the custom taxonomy archive page title.
+ * Filters the custom taxonomy archive page title.
*
* @since 3.1.0
*
}
/**
- * Filter the archive title.
+ * Filters the archive title.
*
* @since 4.1.0
*
*/
function get_the_archive_description() {
/**
- * Filter the archive description.
+ * Filters the archive description.
*
* @since 4.1.0
*
*
* @since 1.0.0
*
- * @todo Properly document optional arguments as such
- *
* @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 = '') {
$link_html = "\t$before<a href='$url'>$text</a>$after\n";
/**
- * Filter the archive link content.
+ * Filters 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.
*/
- return apply_filters( 'get_archives_link', $link_html );
+ return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after );
}
/**
// 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.
+ * Filters the SQL WHERE clause for retrieving archives.
*
* @since 2.2.0
*
$where = apply_filters( 'getarchives_where', $sql_where, $r );
/**
- * Filter the SQL JOIN clause for retrieving archives.
+ * Filters the SQL JOIN clause for retrieving archives.
*
* @since 2.2.0
*
$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;
}
$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'] );
- $url = sprintf( '%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&', '=', $result->week );
+ $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 = add_query_arg( array( 'm' => $arc_year, 'w' => $result->week, ), home_url( '/' ) );
if ( 'post' !== $r['post_type'] ) {
$url = add_query_arg( 'post_type', $r['post_type'], $url );
}
if ( $echo ) {
/**
- * Filter the HTML calendar output.
+ * Filters the HTML calendar output.
*
* @since 3.0.0
*
$previousday = $currentday;
/**
- * Filter the date a post was published for display.
+ * Filters the date a post was published for display.
*
* @since 0.71
*
* Retrieve the date on which the post was written.
*
* Unlike the_date() this function will always return the date.
- * Modify output with 'get_the_date' filter.
+ * Modify output with the {@see 'get_the_date'} filter.
*
* @since 3.0.0
*
}
/**
- * Filter the date a post was published.
+ * Filters the date a post was published.
*
* @since 3.0.0
*
$the_modified_date = $before . get_the_modified_date($d) . $after;
/**
- * Filter the date a post was last modified for display.
+ * Filters the date a post was last modified for display.
*
* @since 2.1.0
*
* Retrieve the date on which the post was last modified.
*
* @since 2.1.0
+ * @since 4.6.0 Added the `$post` parameter.
*
- * @param string $d Optional. PHP date format. Defaults to the "date_format" option
- * @return string
+ * @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 false|string Date the current post was modified. False on failure.
*/
-function get_the_modified_date($d = '') {
- if ( '' == $d )
- $the_time = get_post_modified_time(get_option('date_format'), null, null, true);
- else
- $the_time = get_post_modified_time($d, null, null, true);
+function get_the_modified_date( $d = '', $post = null ) {
+ $post = get_post( $post );
+
+ if ( ! $post ) {
+ // For backward compatibility, failures go through the filter below.
+ $the_time = false;
+ } elseif ( empty( $d ) ) {
+ $the_time = get_post_modified_time( get_option( 'date_format' ), false, $post, true );
+ } else {
+ $the_time = get_post_modified_time( $d, false, $post, true );
+ }
/**
- * Filter the date a post was last modified.
+ * Filters the date a post was last modified.
*
* @since 2.1.0
+ * @since 4.6.0 Added the `$post` parameter.
*
- * @param string $the_time The formatted date.
- * @param string $d PHP date format. Defaults to value specified in
- * 'date_format' option.
+ * @param string $the_time The formatted date.
+ * @param string $d PHP date format. Defaults to value specified in
+ * 'date_format' option.
+ * @param WP_Post $post WP_Post object.
*/
- return apply_filters( 'get_the_modified_date', $the_time, $d );
+ return apply_filters( 'get_the_modified_date', $the_time, $d, $post );
}
/**
*/
function the_time( $d = '' ) {
/**
- * Filter the time a post was written for display.
+ * Filters the time a post was written for display.
*
* @since 0.71
*
* 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 false|string Formatted date string or Unix timestamp. False on failure.
+ * @return string|int|false Formatted date string or Unix timestamp if `$id` is 'U' or 'G'. False on failure.
*/
function get_the_time( $d = '', $post = null ) {
$post = get_post($post);
$the_time = get_post_time($d, false, $post, true);
/**
- * Filter the time a post was written.
+ * Filters the time a post was written.
*
* @since 1.5.0
*
* @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 false|string|int Formatted date string or Unix timestamp. False on failure.
+ * @return string|int|false Formatted date string or Unix timestamp if `$id` is 'U' or 'G'. False on failure.
*/
function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
$post = get_post($post);
$time = mysql2date($d, $time, $translate);
/**
- * Filter the localized time a post was written.
+ * Filters the localized time a post was written.
*
* @since 2.6.0
*
*/
function the_modified_time($d = '') {
/**
- * Filter the localized time a post was last modified, for display.
+ * Filters the localized time a post was last modified, for display.
*
* @since 2.0.0
*
* Retrieve the time at which the post was last modified.
*
* @since 2.0.0
+ * @since 4.6.0 Added the `$post` parameter.
*
- * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
- * @return string
+ * @param string $d Optional. Format to use for retrieving the time the post
+ * was modified. Either 'G', 'U', or php date format defaults
+ * to the value specified in the time_format option. Default empty.
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
+ * @return false|string Formatted date string or Unix timestamp. False on failure.
*/
-function get_the_modified_time($d = '') {
- if ( '' == $d )
- $the_time = get_post_modified_time(get_option('time_format'), null, null, true);
- else
- $the_time = get_post_modified_time($d, null, null, true);
+function get_the_modified_time( $d = '', $post = null ) {
+ $post = get_post( $post );
+
+ if ( ! $post ) {
+ // For backward compatibility, failures go through the filter below.
+ $the_time = false;
+ } elseif ( empty( $d ) ) {
+ $the_time = get_post_modified_time( get_option( 'time_format' ), false, $post, true );
+ } else {
+ $the_time = get_post_modified_time( $d, false, $post, true );
+ }
/**
- * Filter the localized time a post was last modified.
+ * Filters the localized time a post was last modified.
*
* @since 2.0.0
+ * @since 4.6.0 Added the `$post` parameter.
*
* @param string $the_time The formatted time.
* @param string $d Format to use for retrieving the time the post was
* written. Accepts 'G', 'U', or php date format. Defaults
* to value specified in 'time_format' option.
+ * @param WP_Post $post WP_Post object.
*/
- return apply_filters( 'get_the_modified_time', $the_time, $d );
+ return apply_filters( 'get_the_modified_time', $the_time, $d, $post );
}
/**
* @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 false|string Formatted date string or Unix timestamp. False on failure.
+ * @return string|int|false Formatted date string or Unix timestamp if `$id` is 'U' or 'G'. False on failure.
*/
function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
$post = get_post($post);
$time = mysql2date($d, $time, $translate);
/**
- * Filter the localized time a post was last modified.
+ * Filters the localized time a post was last modified.
*
* @since 2.8.0
*
$the_weekday = $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
/**
- * Filter the weekday on which the post was written, for display.
+ * Filters the weekday on which the post was written, for display.
*
* @since 0.71
*
}
/**
- * Filter the localized date on which the post was written, for display.
+ * Filters the localized date on which the post was written, for display.
*
* @since 0.71
*
}
/**
- * Fire the wp_head action
+ * Fire the wp_head action.
+ *
+ * See {@see 'wp_head'}.
*
* @since 1.2.0
*/
function wp_head() {
/**
- * Print scripts or data in the head tag on the front end.
+ * Prints scripts or data in the head tag on the front end.
*
* @since 1.5.0
*/
}
/**
- * Fire the wp_footer action
+ * Fire the wp_footer action.
+ *
+ * See {@see 'wp_footer'}.
*
* @since 1.5.1
*/
function wp_footer() {
/**
- * Print scripts or data before the closing body tag on the front end.
+ * Prints scripts or data before the closing body tag on the front end.
*
* @since 1.5.1
*/
$args = wp_parse_args( $args, $defaults );
/**
- * Filter whether to display the posts feed link.
+ * Filters whether to display the posts feed link.
*
* @since 4.4.0
*
}
/**
- * Filter whether to display the comments feed link.
+ * Filters whether to display the comments feed link.
*
* @since 4.4.0
*
'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 */
$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') );
/**
* Display the link to the Windows Live Writer manifest file.
*
- * @link http://msdn.microsoft.com/en-us/library/bb463265.aspx
+ * @link https://msdn.microsoft.com/en-us/library/bb463265.aspx
* @since 2.3.1
*/
function wlwmanifest_link() {
}
/**
- * Display a noindex meta tag if required by the blog configuration.
+ * Displays a noindex meta tag if required by the blog configuration.
*
* If a blog is marked as not being public then the noindex meta tag will be
- * output to tell web robots not to index the page content. Add this to the wp_head action.
- * Typical usage is as a wp_head callback. add_action( 'wp_head', 'noindex' );
+ * output to tell web robots not to index the page content. Add this to the
+ * {@see 'wp_head'} action.
+ *
+ * Typical usage is as a {@see 'wp_head'} callback:
+ *
+ * add_action( 'wp_head', 'noindex' );
*
* @see wp_no_robots
*
*
* @since 4.3.0
*
- * @link http://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#rel-icon HTML5 specification link icon.
+ * @link https://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() ) {
);
/**
- * Filter the site icon meta tags, so Plugins can add their own.
+ * Filters the site icon meta tags, so Plugins can add their own.
*
* @since 4.3.0
*
}
}
+/**
+ * Prints resource hints to browsers for pre-fetching, pre-rendering
+ * and pre-connecting to web sites.
+ *
+ * Gives hints to browsers to prefetch specific pages or render them
+ * in the background, to perform DNS lookups or to begin the connection
+ * handshake (DNS, TCP, TLS) in the background.
+ *
+ * These performance improving indicators work by using `<link rel"…">`.
+ *
+ * @since 4.6.0
+ */
+function wp_resource_hints() {
+ $hints = array(
+ 'dns-prefetch' => wp_dependencies_unique_hosts(),
+ 'preconnect' => array(),
+ 'prefetch' => array(),
+ 'prerender' => array(),
+ );
+
+ /*
+ * Add DNS prefetch for the Emoji CDN.
+ * The path is removed in the foreach loop below.
+ */
+ /** This filter is documented in wp-includes/formatting.php */
+ $hints['dns-prefetch'][] = apply_filters( 'emoji_svg_url', 'https://s.w.org/images/core/emoji/2/svg/' );
+
+ foreach ( $hints as $relation_type => $urls ) {
+ /**
+ * Filters domains and URLs for resource hints of relation type.
+ *
+ * @since 4.6.0
+ *
+ * @param array $urls URLs to print for resource hints.
+ * @param string $relation_type The relation type the URLs are printed for, e.g. 'preconnect' or 'prerender'.
+ */
+ $urls = apply_filters( 'wp_resource_hints', $urls, $relation_type );
+
+ foreach ( $urls as $key => $url ) {
+ $url = esc_url( $url, array( 'http', 'https' ) );
+ if ( ! $url ) {
+ unset( $urls[ $key ] );
+ continue;
+ }
+
+ if ( in_array( $relation_type, array( 'preconnect', 'dns-prefetch' ) ) ) {
+ $parsed = wp_parse_url( $url );
+ if ( empty( $parsed['host'] ) ) {
+ unset( $urls[ $key ] );
+ continue;
+ }
+
+ if ( 'preconnect' === $relation_type && ! empty( $parsed['scheme'] ) ) {
+ $url = $parsed['scheme'] . '://' . $parsed['host'];
+ } else {
+ // Use protocol-relative URLs for dns-prefetch or if scheme is missing.
+ $url = '//' . $parsed['host'];
+ }
+ }
+
+ $urls[ $key ] = $url;
+ }
+
+ $urls = array_unique( $urls );
+
+ foreach ( $urls as $url ) {
+ printf( "<link rel='%s' href='%s'>\n", $relation_type, $url );
+ }
+ }
+}
+
+/**
+ * Retrieves a list of unique hosts of all enqueued scripts and styles.
+ *
+ * @since 4.6.0
+ *
+ * @return array A list of unique hosts of enqueued scripts and styles.
+ */
+function wp_dependencies_unique_hosts() {
+ global $wp_scripts, $wp_styles;
+
+ $unique_hosts = array();
+
+ foreach ( array( $wp_scripts, $wp_styles ) as $dependencies ) {
+ if ( $dependencies instanceof WP_Dependencies && ! empty( $dependencies->queue ) ) {
+ foreach ( $dependencies->queue as $handle ) {
+ if ( ! isset( $dependencies->registered[ $handle ] ) ) {
+ continue;
+ }
+
+ /* @var _WP_Dependency $dependency */
+ $dependency = $dependencies->registered[ $handle ];
+ $parsed = wp_parse_url( $dependency->src );
+
+ if ( ! empty( $parsed['host'] ) && ! in_array( $parsed['host'], $unique_hosts ) && $parsed['host'] !== $_SERVER['SERVER_NAME'] ) {
+ $unique_hosts[] = $parsed['host'];
+ }
+ }
+ }
+ }
+
+ return $unique_hosts;
+}
+
/**
* Whether the user should have a WYSIWIG editor.
*
}
/**
- * Filter whether the user can access the rich (Visual) editor.
+ * Filters whether the user can access the rich (Visual) editor.
*
* @since 2.1.0
*
}
/**
- * Filter which editor should be displayed by default.
+ * Filters which editor should be displayed by default.
*
* @since 2.5.0
*
* _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.
+ * running wp_editor() inside of a meta box 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 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.
}
/**
- * Retrieve the contents of the search WordPress query variable.
+ * Retrieves the contents of the search WordPress query variable.
*
- * The search query string is passed through {@link esc_attr()}
- * to ensure that it is safe for placing in an html attribute.
+ * The search query string is passed through esc_attr() to ensure that it is safe
+ * for placing in an html attribute.
*
* @since 2.3.0
*
*/
function get_search_query( $escaped = true ) {
/**
- * Filter the contents of the search query variable.
+ * Filters the contents of the search query variable.
*
* @since 2.3.0
*
}
/**
- * Display the contents of the search query variable.
+ * Displays the contents of the search query variable.
*
- * The search query string is passed through {@link esc_attr()}
- * to ensure that it is safe for placing in an html attribute.
+ * The search query string is passed through esc_attr() to ensure that it is safe
+ * for placing in an html attribute.
*
* @since 2.1.0
*/
function the_search_query() {
/**
- * Filter the contents of the search query variable for display.
+ * Filters the contents of the search query variable for display.
*
* @since 2.3.0
*
$output = implode(' ', $attributes);
/**
- * Filter the language attributes for display in the html tag.
+ * Filters the language attributes for display in the html tag.
*
* @since 2.5.0
* @since 4.3.0 Added the `$doctype` parameter.
* numbers to either side of current page, but not including current page.
*
* It is possible to add query vars to the link by using the 'add_args' argument
- * and see {@link add_query_arg()} for more information.
+ * and see add_query_arg() for more information.
*
* The 'before_page_number' and 'after_page_number' arguments allow users to
* augment the links themselves. Typically this might be to add context to the
$link .= $args['add_fragment'];
/**
- * Filter the paginated links for the given archive pages.
+ * Filters the paginated links for the given archive pages.
*
* @since 3.0.0
*
*
* @since 2.5.0
*
- * @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.
- * @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
+ * @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;
wp_admin_css_color( 'fresh', _x( 'Default', 'admin color scheme' ),
false,
array( '#222', '#333', '#0073aa', '#00a0d2' ),
- array( 'base' => '#999', 'focus' => '#00a0d2', 'current' => '#fff' )
+ array( 'base' => '#82878c', 'focus' => '#00a0d2', 'current' => '#fff' )
);
// Other color schemes are not available when running out of src
}
/**
- * Display the URL of a WordPress admin CSS file.
+ * Displays the URL of a WordPress admin CSS file.
*
- * @see WP_Styles::_css_href and its style_loader_src filter.
+ * @see WP_Styles::_css_href and its {@see 'style_loader_src'} filter.
*
* @since 2.3.0
*
$_file = add_query_arg( 'version', get_bloginfo( 'version' ), $_file );
/**
- * Filter the URI of a WordPress admin CSS file.
+ * Filters the URI of a WordPress admin CSS file.
*
* @since 2.3.0
*
* Enqueues or directly prints a stylesheet link to the specified CSS file.
*
* "Intelligently" decides to enqueue or to print the CSS file. If the
- * 'wp_print_styles' action has *not* yet been called, the CSS file will be
- * enqueued. If the wp_print_styles action *has* been called, the CSS link will
+ * {@see 'wp_print_styles'} action has *not* yet been called, the CSS file will be
+ * enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will
* be printed. Printing may be forced by passing true as the $force_echo
* (second) parameter.
*
}
/**
- * Filter the stylesheet link to the specified CSS file.
+ * Filters the stylesheet link to the specified CSS file.
*
* If the site is set to display right-to-left, the RTL stylesheet link
* will be used instead.
}
/**
- * Display the XHTML generator that is generated on the wp_head hook.
+ * Displays the XHTML generator that is generated on the wp_head hook.
+ *
+ * See {@see 'wp_head'}.
*
* @since 2.5.0
*/
function wp_generator() {
/**
- * Filter the output of the XHTML generator tag.
+ * Filters the output of the XHTML generator tag.
*
* @since 2.5.0
*
* Display the generator XML or Comment for RSS, ATOM, etc.
*
* Returns the correct generator type for the requested output format. Allows
- * for a plugin to filter generators overall the the_generator filter.
+ * for a plugin to filter generators overall the {@see 'the_generator'} filter.
*
* @since 2.5.0
*
*/
function the_generator( $type ) {
/**
- * Filter the output of the XHTML generator tag for display.
+ * Filters the output of the XHTML generator tag for display.
*
* @since 2.5.0
*
*
* Returns the correct generator type for the requested output format. Allows
* for a plugin to filter generators on an individual basis using the
- * 'get_the_generator_{$type}' filter.
+ * {@see 'get_the_generator_$type'} filter.
*
* @since 2.5.0
*
}
/**
- * Filter the HTML for the retrieved generator type.
+ * Filters the HTML for the retrieved 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 {@see wp_head()}.
+ * @param string $gen The HTML markup output to wp_head().
* @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom',
* 'rss2', 'rdf', 'comment', 'export'.
*/
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff