*
* @since 1.5.0
*
- * @uses locate_template()
- *
* @param string $name The name of the specialised header.
*/
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 ) {
*
* @since 1.5.0
*
- * @uses locate_template()
- *
* @param string $name The name of the specialised sidebar.
*/
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.
*/
/**
* 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
*
* @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 ) {
/**
* @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() )
*
* @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.
*/
}
/**
- * 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) {
* 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() {
* @since 3.0.0
*
* @param array $args Configuration options to modify the form output.
- * @return string|null String when retrieving, null when displaying.
+ * @return string|void String when retrieving.
*/
function wp_login_form( $args = array() ) {
$defaults = array(
}
/**
- * 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.
*/
*
* @since 1.5.0
*
- * @param string $before Text to output before the link (defaults to <li>).
- * @param string $after Text to output after the link (defaults to </li>).
- * @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 `<li>`.
+ * @param string $after Text to output after the link. Default `</li>`.
+ * @param bool $echo Default to echo and not return the link.
+ * @return string|void String when retrieving.
*/
function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
-
if ( ! is_user_logged_in() ) {
if ( get_option('users_can_register') )
$link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __('Register') . '</a>' . $after;
$link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;
}
+ /**
+ * Filter 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.
+ *
+ * @since 1.5.0
+ *
+ * @param string $link The HTML code for the link to the Registration or Admin page.
+ */
+ $link = apply_filters( 'register', $link );
+
if ( $echo ) {
- /**
- * Filter 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.
- *
- * @since 1.5.0
- *
- * @param string $link The HTML code for the link to the Registration or Admin page.
- */
- echo apply_filters( 'register', $link );
+ echo $link;
} else {
- /** This filter is documented in wp-includes/general-template.php */
- return apply_filters( 'register', $link );
+ return $link;
}
}
*
* @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() {
/**
* 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.
+ * 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.
- * <ol>
- * <li><strong>url</strong> - Blog URI to homepage.</li>
- * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>
- * <li><strong>description</strong> - Secondary title</li>
- * </ol>
+ *
+ * 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
*
* @since 0.71
*
- * @param string $show Blog info to retrieve.
+ * @global string $wp_version
+ *
+ * @param string $show Blog info to retrieve.
* @param string $filter How to filter what is retrieved.
* @return string Mostly string values, might be empty.
*/
function get_bloginfo( $show = '', $filter = 'raw' ) {
-
switch( $show ) {
case 'home' : // DEPRECATED
case 'siteurl' : // DEPRECATED
- _deprecated_argument( __FUNCTION__, '2.2', sprintf( __('The <code>%s</code> option is deprecated for the family of <code>bloginfo()</code> functions.' ), $show ) . ' ' . sprintf( __( 'Use the <code>%s</code> 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.' ),
+ '<code>' . $show . '</code>',
+ '<code>bloginfo()</code>',
+ '<code>url</code>'
+ ) );
case 'url' :
$output = home_url();
break;
$output = str_replace('_', '-', $output);
break;
case 'text_direction':
- //_deprecated_argument( __FUNCTION__, '2.2', sprintf( __('The <code>%s</code> option is deprecated for the family of <code>bloginfo()</code> functions.' ), $show ) . ' ' . sprintf( __( 'Use the <code>%s</code> 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.' ),
+ '<code>' . $show . '</code>',
+ '<code>bloginfo()</code>',
+ '<code>is_rtl()</code>'
+ ) );
if ( function_exists( 'is_rtl' ) ) {
$output = is_rtl() ? 'rtl' : 'ltr';
} else {
return $output;
}
+/**
+ * Returns the Site Icon URL.
+ *
+ * @param int $size Size of the site icon.
+ * @param string $url Fallback url if no site icon is found.
+ * @param int $blog_id Id of the blog to get the site icon for.
+ * @return string Site Icon URL.
+ */
+function get_site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
+ if ( $blog_id && is_multisite() ) {
+ $site_icon_id = get_blog_option( $blog_id, 'site_icon' );
+ } else {
+ $site_icon_id = get_option( 'site_icon' );
+ }
+
+ if ( $site_icon_id ) {
+ if ( $size >= 512 ) {
+ $size_data = 'full';
+ } else {
+ $size_data = array( $size, $size );
+ }
+ $url_data = wp_get_attachment_image_src( $site_icon_id, $size_data );
+ if ( $url_data ) {
+ $url = $url_data[0];
+ }
+ }
+
+ return $url;
+}
+
+/**
+ * Displays the Site Icon URL.
+ *
+ * @param int $size Size of the site icon.
+ * @param string $url Fallback url if no site icon is found.
+ * @param int $blog_id Id of the blog to get the site icon for.
+ */
+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.
+ *
+ * @param int $blog_id Optional. Blog ID. Default: Current blog.
+ * @return bool
+ */
+function has_site_icon( $blog_id = 0 ) {
+ return (bool) get_site_icon_url( 512, '', $blog_id );
+}
+
+/**
+ * Display title tag with contents.
+ *
+ * @ignore
+ * @since 4.1.0
+ * @access private
+ *
+ * @see wp_title()
+ */
+function _wp_render_title_tag() {
+ if ( ! current_theme_supports( 'title-tag' ) ) {
+ return;
+ }
+
+ // This can only work internally on wp_head.
+ if ( ! did_action( 'wp_head' ) && ! doing_action( 'wp_head' ) ) {
+ return;
+ }
+
+ echo '<title>' . wp_title( '|', false, 'right' ) . "</title>\n";
+}
+
/**
* Display or retrieve page title for all areas of blog.
*
*
* @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
+ * @global int $page
+ * @global int $paged
+ *
+ * @param string $sep Optional, default is '»'. How to separate the various items within the page title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
* @param string $seplocation Optional. Direction to display title, 'right'.
- * @return string|null String on retrieve, null when displaying.
+ * @return string|void String on retrieve.
*/
-function wp_title($sep = '»', $display = true, $seplocation = '') {
- global $wpdb, $wp_locale;
+function wp_title( $sep = '»', $display = true, $seplocation = '' ) {
+ global $wp_locale, $page, $paged;
$m = get_query_var('m');
$year = get_query_var('year');
}
// If there's an author
- if ( is_author() ) {
+ if ( is_author() && ! is_post_type_archive() ) {
$author = get_queried_object();
if ( $author )
$title = $author->display_name;
if ( !empty($title) )
$prefix = " $sep ";
+ /**
+ * Filter the parts of the page title.
+ *
+ * @since 4.0.0
+ *
+ * @param array $title_array Parts of the page title.
+ */
+ $title_array = apply_filters( 'wp_title_parts', explode( $t_sep, $title ) );
+
// Determines position of the separator and direction of the breadcrumb
if ( 'right' == $seplocation ) { // sep on right, so reverse the order
- $title_array = explode( $t_sep, $title );
$title_array = array_reverse( $title_array );
$title = implode( " $sep ", $title_array ) . $prefix;
} else {
- $title_array = explode( $t_sep, $title );
$title = $prefix . implode( " $sep ", $title_array );
}
+ if ( current_theme_supports( 'title-tag' ) && ! is_feed() ) {
+ $title .= get_bloginfo( 'name', 'display' );
+
+ $site_description = get_bloginfo( 'description', 'display' );
+ if ( $site_description && ( is_home() || is_front_page() ) ) {
+ $title .= " $sep $site_description";
+ }
+
+ if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) {
+ $title .= " $sep " . sprintf( __( 'Page %s' ), max( $paged, $page ) );
+ }
+ }
+
/**
* Filter the text of the page title.
*
*
* @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) )
*
* @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() )
*
* @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 );
*
* @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 );
*
* @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();
*
* @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;
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' ), '<span class="vcard">' . get_the_author() . '</span>' );
+ } 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.
*
* elements). Custom content is also supported using the before and after
* parameters.
*
- * The 'link' format uses the link HTML element with the <em>archives</em>
+ * The 'link' format uses the `<link>` HTML element with the **archives**
* relationship. The before and after parameters are not used. The text
* parameter is used to describe the link.
*
*
* @since 1.0.0
*
- * @param string $url URL to archive.
- * @param string $text Archive text description.
+ * @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 $after Optional.
* @return string HTML link content for archive.
*/
function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') {
*
* @param string $link_html The archive HTML link content.
*/
- $link_html = apply_filters( 'get_archives_link', $link_html );
-
- return $link_html;
+ return apply_filters( 'get_archives_link', $link_html );
}
/**
* Display archive links based on type and format.
*
- * The 'type' argument offers a few choices and by default will display monthly
- * archive links. The other options for values are 'daily', 'weekly', 'monthly',
- * 'yearly', 'postbypost' or 'alpha'. Both 'postbypost' and 'alpha' display the
- * same archive link list, the difference between the two is that 'alpha'
- * will order by post title and 'postbypost' will order by post date.
- *
- * The date archives will logically display dates with links to the archive post
- * page. The 'postbypost' and 'alpha' values for 'type' argument will display
- * the post titles.
- *
- * The 'limit' argument will only display a limited amount of links, specified
- * by the 'limit' integer value. By default, there is no limit. The
- * 'show_post_count' argument will show how many posts are within the archive.
- * By default, the 'show_post_count' argument is set to false.
- *
- * For the 'format', 'before', and 'after' arguments, see {@link
- * get_archives_link()}. The values of these arguments have to do with that
- * function.
- *
* @since 1.2.0
*
- * @param string|array $args Optional. Override defaults.
- * @return string|null String when retrieving, null when displaying.
- */
-function wp_get_archives($args = '') {
+ * @see get_archives_link()
+ *
+ * @global wpdb $wpdb
+ * @global WP_Locale $wp_locale
+ *
+ * @param string|array $args {
+ * Default archive links arguments. Optional.
+ *
+ * @type string $type Type of archive to retrieve. Accepts 'daily', 'weekly', 'monthly',
+ * 'yearly', 'postbypost', or 'alpha'. Both 'postbypost' and 'alpha'
+ * display the same archive link list as well as post titles instead
+ * of displaying dates. The difference between the two is that 'alpha'
+ * will order by post title and 'postbypost' will order by post date.
+ * Default 'monthly'.
+ * @type string|int $limit Number of links to limit the query to. Default empty (no limit).
+ * @type string $format Format each link should take using the $before and $after args.
+ * Accepts 'link' (`<link>` tag), 'option' (`<option>` tag), 'html'
+ * (`<li>` tag), or a custom format, which generates a link anchor
+ * with $before preceding and $after succeeding. Default 'html'.
+ * @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|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'.
+ * }
+ * @return string|void String when retrieving.
+ */
+function wp_get_archives( $args = '' ) {
global $wpdb, $wp_locale;
$defaults = array(
);
$r = wp_parse_args( $args, $defaults );
- extract( $r, EXTR_SKIP );
- if ( '' == $type )
- $type = 'monthly';
+ if ( '' == $r['type'] ) {
+ $r['type'] = 'monthly';
+ }
- if ( '' != $limit ) {
- $limit = absint($limit);
- $limit = ' LIMIT '.$limit;
+ if ( ! empty( $r['limit'] ) ) {
+ $r['limit'] = absint( $r['limit'] );
+ $r['limit'] = ' LIMIT ' . $r['limit'];
}
- $order = strtoupper( $order );
- if ( $order !== 'ASC' )
+ $order = strtoupper( $r['order'] );
+ if ( $order !== 'ASC' ) {
$order = 'DESC';
+ }
// this is what will separate dates on weekly archive links
$archive_week_separator = '–';
$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');
+ 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' );
}
/**
wp_cache_set( 'last_changed', $last_changed, 'posts' );
}
- if ( 'monthly' == $type ) {
+ $limit = $r['limit'];
+
+ if ( 'monthly' == $r['type'] ) {
$query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date $order $limit";
$key = md5( $query );
$key = "wp_get_archives:$key:$last_changed";
wp_cache_set( $key, $results, 'posts' );
}
if ( $results ) {
- $afterafter = $after;
+ $after = $r['after'];
foreach ( (array) $results as $result ) {
$url = get_month_link( $result->year, $result->month );
/* translators: 1: month name, 2: 4-digit year */
- $text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($result->month), $result->year);
- if ( $show_post_count )
- $after = ' ('.$result->posts.')' . $afterafter;
- $output .= get_archives_link($url, $text, $format, $before, $after);
+ $text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $result->month ), $result->year );
+ if ( $r['show_post_count'] ) {
+ $r['after'] = ' (' . $result->posts . ')' . $after;
+ }
+ $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
}
}
- } elseif ('yearly' == $type) {
+ } elseif ( 'yearly' == $r['type'] ) {
$query = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date $order $limit";
$key = md5( $query );
$key = "wp_get_archives:$key:$last_changed";
wp_cache_set( $key, $results, 'posts' );
}
if ( $results ) {
- $afterafter = $after;
+ $after = $r['after'];
foreach ( (array) $results as $result) {
- $url = get_year_link($result->year);
- $text = sprintf('%d', $result->year);
- if ($show_post_count)
- $after = ' ('.$result->posts.')' . $afterafter;
- $output .= get_archives_link($url, $text, $format, $before, $after);
+ $url = get_year_link( $result->year );
+ $text = sprintf( '%d', $result->year );
+ if ( $r['show_post_count'] ) {
+ $r['after'] = ' (' . $result->posts . ')' . $after;
+ }
+ $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
}
}
- } elseif ( 'daily' == $type ) {
+ } elseif ( 'daily' == $r['type'] ) {
$query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date $order $limit";
$key = md5( $query );
$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 ) {
- $afterafter = $after;
+ $after = $r['after'];
foreach ( (array) $results as $result ) {
- $url = get_day_link($result->year, $result->month, $result->dayofmonth);
- $date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth);
- $text = mysql2date($archive_day_date_format, $date);
- if ($show_post_count)
- $after = ' ('.$result->posts.')'.$afterafter;
- $output .= get_archives_link($url, $text, $format, $before, $after);
+ $url = get_day_link( $result->year, $result->month, $result->dayofmonth );
+ $date = sprintf( '%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth );
+ $text = mysql2date( $archive_day_date_format, $date );
+ if ( $r['show_post_count'] ) {
+ $r['after'] = ' (' . $result->posts . ')' . $after;
+ }
+ $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
}
}
- } elseif ( 'weekly' == $type ) {
+ } elseif ( 'weekly' == $r['type'] ) {
$week = _wp_mysql_week( '`post_date`' );
$query = "SELECT DISTINCT $week AS `week`, YEAR( `post_date` ) AS `yr`, DATE_FORMAT( `post_date`, '%Y-%m-%d' ) AS `yyyymmdd`, count( `ID` ) AS `posts` FROM `$wpdb->posts` $join $where GROUP BY $week, YEAR( `post_date` ) ORDER BY `post_date` $order $limit";
$key = md5( $query );
wp_cache_set( $key, $results, 'posts' );
}
$arc_w_last = '';
- $afterafter = $after;
if ( $results ) {
- foreach ( (array) $results as $result ) {
- if ( $result->week != $arc_w_last ) {
- $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);
- $text = $arc_week_start . $archive_week_separator . $arc_week_end;
- if ($show_post_count)
- $after = ' ('.$result->posts.')'.$afterafter;
- $output .= get_archives_link($url, $text, $format, $before, $after);
+ $after = $r['after'];
+ foreach ( (array) $results as $result ) {
+ if ( $result->week != $arc_w_last ) {
+ $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 );
+ $text = $arc_week_start . $archive_week_separator . $arc_week_end;
+ if ( $r['show_post_count'] ) {
+ $r['after'] = ' (' . $result->posts . ')' . $after;
}
+ $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
}
+ }
}
- } elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) {
- $orderby = ('alpha' == $type) ? 'post_title ASC ' : 'post_date DESC ';
+ } elseif ( ( 'postbypost' == $r['type'] ) || ('alpha' == $r['type'] ) ) {
+ $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";
if ( $results ) {
foreach ( (array) $results as $result ) {
if ( $result->post_date != '0000-00-00 00:00:00' ) {
- $url = get_permalink( $result );
+ $url = get_permalink( $result );
if ( $result->post_title ) {
/** This filter is documented in wp-includes/post-template.php */
$text = strip_tags( apply_filters( 'the_title', $result->post_title, $result->ID ) );
} else {
$text = $result->ID;
}
- $output .= get_archives_link($url, $text, $format, $before, $after);
+ $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
}
}
}
}
- if ( $echo )
+ if ( $r['echo'] ) {
echo $output;
- else
+ } else {
return $output;
+ }
}
/**
* 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) {
global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
- $cache = array();
$key = md5( $m . $monthnum . $year );
if ( $cache = wp_cache_get( 'get_calendar', 'calendar' ) ) {
if ( is_array($cache) && isset( $cache[ $key ] ) ) {
}
foreach ( $myweek as $wd ) {
- $day_name = (true == $initial) ? $wp_locale->get_weekday_initial($wd) : $wp_locale->get_weekday_abbrev($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<th scope=\"col\" title=\"$wd\">$day_name</th>";
}
<tr>';
if ( $previous ) {
- $calendar_output .= "\n\t\t".'<td colspan="3" id="prev"><a href="' . get_month_link($previous->year, $previous->month) . '" title="' . esc_attr( sprintf(__('View posts for %1$s %2$s'), $wp_locale->get_month($previous->month), date('Y', mktime(0, 0 , 0, $previous->month, 1, $previous->year)))) . '">« ' . $wp_locale->get_month_abbrev($wp_locale->get_month($previous->month)) . '</a></td>';
+ $calendar_output .= "\n\t\t".'<td colspan="3" id="prev"><a href="' . get_month_link($previous->year, $previous->month) . '">« ' . $wp_locale->get_month_abbrev($wp_locale->get_month($previous->month)) . '</a></td>';
} else {
$calendar_output .= "\n\t\t".'<td colspan="3" id="prev" class="pad"> </td>';
}
$calendar_output .= "\n\t\t".'<td class="pad"> </td>';
if ( $next ) {
- $calendar_output .= "\n\t\t".'<td colspan="3" id="next"><a href="' . get_month_link($next->year, $next->month) . '" title="' . esc_attr( sprintf(__('View posts for %1$s %2$s'), $wp_locale->get_month($next->month), date('Y', mktime(0, 0 , 0, $next->month, 1, $next->year))) ) . '">' . $wp_locale->get_month_abbrev($wp_locale->get_month($next->month)) . ' »</a></td>';
+ $calendar_output .= "\n\t\t".'<td colspan="3" id="next"><a href="' . get_month_link($next->year, $next->month) . '">' . $wp_locale->get_month_abbrev($wp_locale->get_month($next->month)) . ' »</a></td>';
} else {
$calendar_output .= "\n\t\t".'<td colspan="3" id="next" class="pad"> </td>';
}
<tbody>
<tr>';
+ $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'
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)
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.
* 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.
*/
}
$allowed .= '> ';
}
- return htmlentities($allowed);
+ return htmlentities( $allowed );
}
/***** Date/Time tags *****/
*
* @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;
else
return $the_date;
}
-
- return null;
}
/**
*
* @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 Date the current post was written.
+ * @return false|string Date the current post was written. False on failure.
*/
function get_the_date( $d = '', $post = null ) {
$post = get_post( $post );
+ if ( ! $post ) {
+ return false;
+ }
+
if ( '' == $d ) {
$the_date = mysql2date( get_option( 'date_format' ), $post->post_date );
} else {
*
* @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;
/**
* 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 Formatted date string, or Unix timestamp.
+ * @return false|string Formatted date string or Unix timestamp. False on failure.
*/
function get_the_time( $d = '', $post = null ) {
$post = get_post($post);
+ if ( ! $post ) {
+ return false;
+ }
+
if ( '' == $d )
$the_time = get_post_time(get_option('time_format'), false, $post, true);
else
* @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 Formatted date string, or Unix timestamp.
+ * @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);
+ if ( ! $post ) {
+ return false;
+ }
+
if ( $gmt )
$time = $post->post_date_gmt;
else
*
* @since 2.0.0
*
- * @param string $d Optional, default is 'U'. Either 'G', 'U', or php date format.
- * @param bool $gmt Optional, default is false. Whether to return the gmt time.
- * @param int|object $post Optional, default is global post object. A post_id or post object
- * @param bool $translate Optional, default is false. Whether to translate the result
- * @return string Returns timestamp
+ * @param string $d Optional. Format to use for retrieving the time the post
+ * was modified. Either 'G', 'U', or php date format. Default 'U'.
+ * @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.
*/
function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
$post = get_post($post);
+ if ( ! $post ) {
+ return false;
+ }
+
if ( $gmt )
$time = $post->post_modified_gmt;
else
* 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;
*
* @since 0.71
*
- * @param string $the_weekday
+ * @param string $the_weekday
*/
- $the_weekday = apply_filters( 'the_weekday', $the_weekday );
- echo $the_weekday;
+ echo apply_filters( 'the_weekday', $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.
*/
*
* @since 0.71
*
- * @param string $the_weekday_date
+ * @param string $the_weekday_date
* @param string $before The HTML to output before the date.
* @param string $after The HTML to output after the date.
*/
* @since 2.3.1
*/
function wlwmanifest_link() {
- echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="'
- . get_bloginfo('wpurl') . '/wp-includes/wlwmanifest.xml" /> ' . "\n";
+ echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="',
+ includes_url( 'wlwmanifest.xml' ), '" /> ', "\n";
}
/**
echo "<meta name='robots' content='noindex,follow' />\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( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( get_site_icon_url( 32 ) ) ),
+ sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( get_site_icon_url( 192 ) ) ),
+ sprintf( '<link rel="apple-touch-icon-precomposed" href="%s">', esc_url( get_site_icon_url( 180 ) ) ),
+ sprintf( '<meta name="msapplication-TileImage" content="%s">', 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.
*
*
* @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() {
*/
function wp_default_editor() {
$r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
- if ( $user = wp_get_current_user() ) { // look for cookie
+ if ( wp_get_current_user() ) { // look for cookie
$ed = get_user_setting('editor', 'tinymce');
$r = ( in_array($ed, array('tinymce', 'html', 'test') ) ) ? $ed : $r;
}
* 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
* @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' ) )
* 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 ) {
* 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() {
}
/**
- * 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();
- $output = '';
if ( function_exists( 'is_rtl' ) && is_rtl() )
$attributes[] = 'dir="rtl"';
* 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 );
}
/**
* 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.
*
- * The 'before_page_number' and 'after_page_number' arguments allow users to
+ * 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
* numbered links so that screen reader users understand what the links are for.
- * The text strings are added before and after the page number - within the
+ * The text strings are added before and after the page number - within the
* anchor tag.
*
* @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;
+
+ // Setting up default values based on the current URL.
+ $pagenum_link = html_entity_decode( get_pagenum_link() );
+ $url_parts = explode( '?', $pagenum_link );
+
+ // 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;
+
+ // 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=%#%';
+
$defaults = array(
- 'base' => '%_%', // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
- 'format' => '?page=%#%', // ?page=%#% : %#% is replaced by the page number
- 'total' => 1,
- 'current' => 0,
+ 'base' => $pagenum_link, // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
+ 'format' => $format, // ?page=%#% : %#% is replaced by the page number
+ 'total' => $total,
+ 'current' => $current,
'show_all' => false,
'prev_next' => true,
'prev_text' => __('« Previous'),
'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' => ''
);
$args = wp_parse_args( $args, $defaults );
- extract($args, EXTR_SKIP);
+
+ 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) $total;
- if ( $total < 2 )
+ $total = (int) $args['total'];
+ if ( $total < 2 ) {
return;
- $current = (int) $current;
- $end_size = 0 < (int) $end_size ? (int) $end_size : 1; // Out of bounds? Make it the default.
- $mid_size = 0 <= (int) $mid_size ? (int) $mid_size : 2;
- $add_args = is_array($add_args) ? $add_args : false;
+ }
+ $current = (int) $args['current'];
+ $end_size = (int) $args['end_size']; // Out of bounds? Make it the default.
+ if ( $end_size < 1 ) {
+ $end_size = 1;
+ }
+ $mid_size = (int) $args['mid_size'];
+ if ( $mid_size < 0 ) {
+ $mid_size = 2;
+ }
+ $add_args = $args['add_args'];
$r = '';
$page_links = array();
- $n = 0;
$dots = false;
- if ( $prev_next && $current && 1 < $current ) :
- $link = str_replace('%_%', 2 == $current ? '' : $format, $base);
- $link = str_replace('%#%', $current - 1, $link);
+ if ( $args['prev_next'] && $current && 1 < $current ) :
+ $link = str_replace( '%_%', 2 == $current ? '' : $args['format'], $args['base'] );
+ $link = str_replace( '%#%', $current - 1, $link );
if ( $add_args )
$link = add_query_arg( $add_args, $link );
- $link .= $add_fragment;
+ $link .= $args['add_fragment'];
/**
* Filter the paginated links for the given archive pages.
*
* @param string $link The paginated link URL.
*/
- $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $prev_text . '</a>';
+ $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['prev_text'] . '</a>';
endif;
for ( $n = 1; $n <= $total; $n++ ) :
if ( $n == $current ) :
- $page_links[] = "<span class='page-numbers current'>" . $before_page_number . number_format_i18n( $n ) . $after_page_number . "</span>";
+ $page_links[] = "<span class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
$dots = true;
else :
- if ( $show_all || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
- $link = str_replace('%_%', 1 == $n ? '' : $format, $base);
- $link = str_replace('%#%', $n, $link);
+ if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
+ $link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
+ $link = str_replace( '%#%', $n, $link );
if ( $add_args )
$link = add_query_arg( $add_args, $link );
- $link .= $add_fragment;
+ $link .= $args['add_fragment'];
/** This filter is documented in wp-includes/general-template.php */
- $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>" . $before_page_number . number_format_i18n( $n ) . $after_page_number . "</a>";
+ $page_links[] = "<a class='page-numbers' href='" . esc_url( apply_filters( 'paginate_links', $link ) ) . "'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</a>";
$dots = true;
- elseif ( $dots && !$show_all ) :
+ elseif ( $dots && ! $args['show_all'] ) :
$page_links[] = '<span class="page-numbers dots">' . __( '…' ) . '</span>';
$dots = false;
endif;
endif;
endfor;
- if ( $prev_next && $current && ( $current < $total || -1 == $total ) ) :
- $link = str_replace('%_%', $format, $base);
- $link = str_replace('%#%', $current + 1, $link);
+ if ( $args['prev_next'] && $current && ( $current < $total || -1 == $total ) ) :
+ $link = str_replace( '%_%', $args['format'], $args['base'] );
+ $link = str_replace( '%#%', $current + 1, $link );
if ( $add_args )
$link = add_query_arg( $add_args, $link );
- $link .= $add_fragment;
+ $link .= $args['add_fragment'];
/** This filter is documented in wp-includes/general-template.php */
- $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $next_text . '</a>';
+ $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['next_text'] . '</a>';
endif;
- switch ( $type ) :
+ switch ( $args['type'] ) {
case 'array' :
return $page_links;
- break;
+
case 'list' :
$r .= "<ul class='page-numbers'>\n\t<li>";
$r .= join("</li>\n\t<li>", $page_links);
$r .= "</li>\n</ul>\n";
break;
+
default :
$r = join("\n", $page_links);
break;
- endswitch;
+ }
return $r;
}
* Registers an admin colour scheme css file.
*
* Allows a plugin to register a new admin colour scheme. For example:
- * <code>
- * wp_admin_css_color('classic', __('Classic'), admin_url("css/colors-classic.css"),
- * array('#07273E', '#14568A', '#D54E21', '#2683AE'));
- * </code>
+ *
+ * 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
+ * @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
*/
function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) {
global $_wp_admin_css_colors;
* 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' => '#999', 'focus' => '#00a0d2', 'current' => '#fff' )
);
// Other color schemes are not available when running out of src
* @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') ) {
* 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
* @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 ) ) {
/**
* 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'.
*/
*
* @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 ) {
* @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 ) {
* @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 ) {
* @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 ) {
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff