3 * General template tags that can go anywhere in a template.
10 * Load header template.
12 * Includes the header template for a theme or if a name is specified then a
13 * specialised header will be included.
15 * For the parameter, if the file is called "header-special.php" then specify
20 * @param string $name The name of the specialised header.
22 function get_header( $name = null ) {
24 * Fires before the header template file is loaded.
26 * The hook allows a specific header template file to be used in place of the
27 * default header template file. If your file is called header-new.php,
28 * you would specify the filename in the hook as get_header( 'new' ).
31 * @since 2.8.0 $name parameter added.
33 * @param string|null $name Name of the specific header file to use. null for the default header.
35 do_action( 'get_header', $name );
38 $name = (string) $name;
40 $templates[] = "header-{$name}.php";
43 $templates[] = 'header.php';
45 locate_template( $templates, true );
49 * Load footer template.
51 * Includes the footer template for a theme or if a name is specified then a
52 * specialised footer will be included.
54 * For the parameter, if the file is called "footer-special.php" then specify
59 * @param string $name The name of the specialised footer.
61 function get_footer( $name = null ) {
63 * Fires before the footer template file is loaded.
65 * The hook allows a specific footer template file to be used in place of the
66 * default footer template file. If your file is called footer-new.php,
67 * you would specify the filename in the hook as get_footer( 'new' ).
70 * @since 2.8.0 $name parameter added.
72 * @param string|null $name Name of the specific footer file to use. null for the default footer.
74 do_action( 'get_footer', $name );
77 $name = (string) $name;
79 $templates[] = "footer-{$name}.php";
82 $templates[] = 'footer.php';
84 locate_template( $templates, true );
88 * Load sidebar template.
90 * Includes the sidebar template for a theme or if a name is specified then a
91 * specialised sidebar will be included.
93 * For the parameter, if the file is called "sidebar-special.php" then specify
98 * @param string $name The name of the specialised sidebar.
100 function get_sidebar( $name = null ) {
102 * Fires before the sidebar template file is loaded.
104 * The hook allows a specific sidebar template file to be used in place of the
105 * default sidebar template file. If your file is called sidebar-new.php,
106 * you would specify the filename in the hook as get_sidebar( 'new' ).
109 * @since 2.8.0 $name parameter added.
111 * @param string|null $name Name of the specific sidebar file to use. null for the default sidebar.
113 do_action( 'get_sidebar', $name );
115 $templates = array();
116 $name = (string) $name;
118 $templates[] = "sidebar-{$name}.php";
120 $templates[] = 'sidebar.php';
122 locate_template( $templates, true );
126 * Load a template part into a template
128 * Makes it easy for a theme to reuse sections of code in a easy to overload way
131 * Includes the named template part for a theme or if a name is specified then a
132 * specialised part will be included. If the theme contains no {slug}.php file
133 * then no template will be included.
135 * The template is included using require, not require_once, so you may include the
136 * same template part multiple times.
138 * For the $name parameter, if the file is called "{slug}-special.php" then specify
143 * @param string $slug The slug name for the generic template.
144 * @param string $name The name of the specialised template.
146 function get_template_part( $slug, $name = null ) {
148 * Fires before the specified template part file is loaded.
150 * The dynamic portion of the hook name, `$slug`, refers to the slug name
151 * for the generic template part.
155 * @param string $slug The slug name for the generic template.
156 * @param string|null $name The name of the specialized template.
158 do_action( "get_template_part_{$slug}", $slug, $name );
160 $templates = array();
161 $name = (string) $name;
163 $templates[] = "{$slug}-{$name}.php";
165 $templates[] = "{$slug}.php";
167 locate_template($templates, true, false);
171 * Display search form.
173 * Will first attempt to locate the searchform.php file in either the child or
174 * the parent, then load it. If it doesn't exist, then the default search form
175 * will be displayed. The default search form is HTML, which will be displayed.
176 * There is a filter applied to the search form HTML in order to edit or replace
177 * it. The filter is {@see 'get_search_form'}.
179 * This function is primarily used by themes which want to hardcode the search
180 * form into the sidebar and also by the search widget in WordPress.
182 * There is also an action that is called whenever the function is run called,
183 * {@see 'pre_get_search_form'}. This can be useful for outputting JavaScript that the
184 * search relies on or various formatting that applies to the beginning of the
185 * search. To give a few examples of what it can be used for.
189 * @param bool $echo Default to echo and not return the form.
190 * @return string|void String when $echo is false.
192 function get_search_form( $echo = true ) {
194 * Fires before the search form is retrieved, at the start of get_search_form().
196 * @since 2.7.0 as 'get_search_form' action.
199 * @link https://core.trac.wordpress.org/ticket/19321
201 do_action( 'pre_get_search_form' );
203 $format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml';
206 * Filters the HTML format of the search form.
210 * @param string $format The type of markup to use in the search form.
211 * Accepts 'html5', 'xhtml'.
213 $format = apply_filters( 'search_form_format', $format );
215 $search_form_template = locate_template( 'searchform.php' );
216 if ( '' != $search_form_template ) {
218 require( $search_form_template );
219 $form = ob_get_clean();
221 if ( 'html5' == $format ) {
222 $form = '<form role="search" method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">
224 <span class="screen-reader-text">' . _x( 'Search for:', 'label' ) . '</span>
225 <input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search …', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" />
227 <input type="submit" class="search-submit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />
230 $form = '<form role="search" method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">
232 <label class="screen-reader-text" for="s">' . _x( 'Search for:', 'label' ) . '</label>
233 <input type="text" value="' . get_search_query() . '" name="s" id="s" />
234 <input type="submit" id="searchsubmit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />
241 * Filters the HTML output of the search form.
245 * @param string $form The search form HTML output.
247 $result = apply_filters( 'get_search_form', $form );
249 if ( null === $result )
259 * Display the Log In/Out link.
261 * Displays a link, which allows users to navigate to the Log In page to log in
262 * or log out depending on whether they are currently logged in.
266 * @param string $redirect Optional path to redirect to on login/logout.
267 * @param bool $echo Default to echo and not return the link.
268 * @return string|void String when retrieving.
270 function wp_loginout($redirect = '', $echo = true) {
271 if ( ! is_user_logged_in() )
272 $link = '<a href="' . esc_url( wp_login_url($redirect) ) . '">' . __('Log in') . '</a>';
274 $link = '<a href="' . esc_url( wp_logout_url($redirect) ) . '">' . __('Log out') . '</a>';
278 * Filters the HTML output for the Log In/Log Out link.
282 * @param string $link The HTML link content.
284 echo apply_filters( 'loginout', $link );
286 /** This filter is documented in wp-includes/general-template.php */
287 return apply_filters( 'loginout', $link );
292 * Retrieves the logout URL.
294 * Returns the URL that allows the user to log out of the site.
298 * @param string $redirect Path to redirect to on logout.
299 * @return string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url().
301 function wp_logout_url($redirect = '') {
302 $args = array( 'action' => 'logout' );
303 if ( !empty($redirect) ) {
304 $args['redirect_to'] = urlencode( $redirect );
307 $logout_url = add_query_arg($args, site_url('wp-login.php', 'login'));
308 $logout_url = wp_nonce_url( $logout_url, 'log-out' );
311 * Filters the logout URL.
315 * @param string $logout_url The HTML-encoded logout URL.
316 * @param string $redirect Path to redirect to on logout.
318 return apply_filters( 'logout_url', $logout_url, $redirect );
322 * Retrieves the login URL.
326 * @param string $redirect Path to redirect to on log in.
327 * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present.
329 * @return string The login URL. Not HTML-encoded.
331 function wp_login_url($redirect = '', $force_reauth = false) {
332 $login_url = site_url('wp-login.php', 'login');
334 if ( !empty($redirect) )
335 $login_url = add_query_arg('redirect_to', urlencode($redirect), $login_url);
338 $login_url = add_query_arg('reauth', '1', $login_url);
341 * Filters the login URL.
344 * @since 4.2.0 The `$force_reauth` parameter was added.
346 * @param string $login_url The login URL. Not HTML-encoded.
347 * @param string $redirect The path to redirect to on login, if supplied.
348 * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present.
350 return apply_filters( 'login_url', $login_url, $redirect, $force_reauth );
354 * Returns the URL that allows the user to register on the site.
358 * @return string User registration URL.
360 function wp_registration_url() {
362 * Filters the user registration URL.
366 * @param string $register The user registration URL.
368 return apply_filters( 'register_url', site_url( 'wp-login.php?action=register', 'login' ) );
372 * Provides a simple login form for use anywhere within WordPress.
374 * The login format HTML is echoed by default. Pass a false value for `$echo` to return it instead.
378 * @param array $args {
379 * Optional. Array of options to control the form output. Default empty array.
381 * @type bool $echo Whether to display the login form or return the form HTML code.
382 * Default true (echo).
383 * @type string $redirect URL to redirect to. Must be absolute, as in "https://example.com/mypage/".
384 * Default is to redirect back to the request URI.
385 * @type string $form_id ID attribute value for the form. Default 'loginform'.
386 * @type string $label_username Label for the username or email address field. Default 'Username or Email Address'.
387 * @type string $label_password Label for the password field. Default 'Password'.
388 * @type string $label_remember Label for the remember field. Default 'Remember Me'.
389 * @type string $label_log_in Label for the submit button. Default 'Log In'.
390 * @type string $id_username ID attribute value for the username field. Default 'user_login'.
391 * @type string $id_password ID attribute value for the password field. Default 'user_pass'.
392 * @type string $id_remember ID attribute value for the remember field. Default 'rememberme'.
393 * @type string $id_submit ID attribute value for the submit button. Default 'wp-submit'.
394 * @type bool $remember Whether to display the "rememberme" checkbox in the form.
395 * @type string $value_username Default value for the username field. Default empty.
396 * @type bool $value_remember Whether the "Remember Me" checkbox should be checked by default.
397 * Default false (unchecked).
400 * @return string|void String when retrieving.
402 function wp_login_form( $args = array() ) {
405 // Default 'redirect' value takes the user back to the request URI.
406 'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'],
407 'form_id' => 'loginform',
408 'label_username' => __( 'Username or Email Address' ),
409 'label_password' => __( 'Password' ),
410 'label_remember' => __( 'Remember Me' ),
411 'label_log_in' => __( 'Log In' ),
412 'id_username' => 'user_login',
413 'id_password' => 'user_pass',
414 'id_remember' => 'rememberme',
415 'id_submit' => 'wp-submit',
417 'value_username' => '',
418 // Set 'value_remember' to true to default the "Remember me" checkbox to checked.
419 'value_remember' => false,
423 * Filters the default login form output arguments.
427 * @see wp_login_form()
429 * @param array $defaults An array of default login form arguments.
431 $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
434 * Filters content to display at the top of the login form.
436 * The filter evaluates just following the opening form tag element.
440 * @param string $content Content to display. Default empty.
441 * @param array $args Array of login form arguments.
443 $login_form_top = apply_filters( 'login_form_top', '', $args );
446 * Filters content to display in the middle of the login form.
448 * The filter evaluates just following the location where the 'login-password'
449 * field is displayed.
453 * @param string $content Content to display. Default empty.
454 * @param array $args Array of login form arguments.
456 $login_form_middle = apply_filters( 'login_form_middle', '', $args );
459 * Filters content to display at the bottom of the login form.
461 * The filter evaluates just preceding the closing form tag element.
465 * @param string $content Content to display. Default empty.
466 * @param array $args Array of login form arguments.
468 $login_form_bottom = apply_filters( 'login_form_bottom', '', $args );
471 <form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . esc_url( site_url( 'wp-login.php', 'login_post' ) ) . '" method="post">
472 ' . $login_form_top . '
473 <p class="login-username">
474 <label for="' . esc_attr( $args['id_username'] ) . '">' . esc_html( $args['label_username'] ) . '</label>
475 <input type="text" name="log" id="' . esc_attr( $args['id_username'] ) . '" class="input" value="' . esc_attr( $args['value_username'] ) . '" size="20" />
477 <p class="login-password">
478 <label for="' . esc_attr( $args['id_password'] ) . '">' . esc_html( $args['label_password'] ) . '</label>
479 <input type="password" name="pwd" id="' . esc_attr( $args['id_password'] ) . '" class="input" value="" size="20" />
481 ' . $login_form_middle . '
482 ' . ( $args['remember'] ? '<p class="login-remember"><label><input name="rememberme" type="checkbox" id="' . esc_attr( $args['id_remember'] ) . '" value="forever"' . ( $args['value_remember'] ? ' checked="checked"' : '' ) . ' /> ' . esc_html( $args['label_remember'] ) . '</label></p>' : '' ) . '
483 <p class="login-submit">
484 <input type="submit" name="wp-submit" id="' . esc_attr( $args['id_submit'] ) . '" class="button button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" />
485 <input type="hidden" name="redirect_to" value="' . esc_url( $args['redirect'] ) . '" />
487 ' . $login_form_bottom . '
497 * Returns the URL that allows the user to retrieve the lost password
501 * @param string $redirect Path to redirect to on login.
502 * @return string Lost password URL.
504 function wp_lostpassword_url( $redirect = '' ) {
505 $args = array( 'action' => 'lostpassword' );
506 if ( !empty($redirect) ) {
507 $args['redirect_to'] = $redirect;
510 $lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') );
513 * Filters the Lost Password URL.
517 * @param string $lostpassword_url The lost password page URL.
518 * @param string $redirect The path to redirect to on login.
520 return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );
524 * Display the Registration or Admin link.
526 * Display a link which allows the user to navigate to the registration page if
527 * not logged in and registration is enabled or to the dashboard if logged in.
531 * @param string $before Text to output before the link. Default `<li>`.
532 * @param string $after Text to output after the link. Default `</li>`.
533 * @param bool $echo Default to echo and not return the link.
534 * @return string|void String when retrieving.
536 function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {
537 if ( ! is_user_logged_in() ) {
538 if ( get_option('users_can_register') )
539 $link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __('Register') . '</a>' . $after;
542 } elseif ( current_user_can( 'read' ) ) {
543 $link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;
549 * Filters the HTML link to the Registration or Admin page.
551 * Users are sent to the admin page if logged-in, or the registration page
552 * if enabled and logged-out.
556 * @param string $link The HTML code for the link to the Registration or Admin page.
558 $link = apply_filters( 'register', $link );
568 * Theme container function for the 'wp_meta' action.
570 * The {@see 'wp_meta'} action can have several purposes, depending on how you use it,
571 * but one purpose might have been to allow for theme switching.
575 * @link https://core.trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action.
579 * Fires before displaying echoed content in the sidebar.
583 do_action( 'wp_meta' );
587 * Displays information about the current site.
591 * @see get_bloginfo() For possible `$show` values
593 * @param string $show Optional. Site information to display. Default empty.
595 function bloginfo( $show = '' ) {
596 echo get_bloginfo( $show, 'display' );
600 * Retrieves information about the current site.
602 * Possible values for `$show` include:
604 * - 'name' - Site title (set in Settings > General)
605 * - 'description' - Site tagline (set in Settings > General)
606 * - 'wpurl' - The WordPress address (URL) (set in Settings > General)
607 * - 'url' - The Site address (URL) (set in Settings > General)
608 * - 'admin_email' - Admin email (set in Settings > General)
609 * - 'charset' - The "Encoding for pages and feeds" (set in Settings > Reading)
610 * - 'version' - The current WordPress version
611 * - 'html_type' - The content-type (default: "text/html"). Themes and plugins
612 * can override the default value using the {@see 'pre_option_html_type'} filter
613 * - 'text_direction' - The text direction determined by the site's language. is_rtl()
614 * should be used instead
615 * - 'language' - Language code for the current site
616 * - 'stylesheet_url' - URL to the stylesheet for the active theme. An active child theme
617 * will take precedence over this value
618 * - 'stylesheet_directory' - Directory path for the active theme. An active child theme
619 * will take precedence over this value
620 * - 'template_url' / 'template_directory' - URL of the active theme's directory. An active
621 * child theme will NOT take precedence over this value
622 * - 'pingback_url' - The pingback XML-RPC file URL (xmlrpc.php)
623 * - 'atom_url' - The Atom feed URL (/feed/atom)
624 * - 'rdf_url' - The RDF/RSS 1.0 feed URL (/feed/rfd)
625 * - 'rss_url' - The RSS 0.92 feed URL (/feed/rss)
626 * - 'rss2_url' - The RSS 2.0 feed URL (/feed)
627 * - 'comments_atom_url' - The comments Atom feed URL (/comments/feed)
628 * - 'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed)
630 * Some `$show` values are deprecated and will be removed in future versions.
631 * These options will trigger the _deprecated_argument() function.
633 * Deprecated arguments include:
635 * - 'siteurl' - Use 'url' instead
636 * - 'home' - Use 'url' instead
640 * @global string $wp_version
642 * @param string $show Optional. Site info to retrieve. Default empty (site name).
643 * @param string $filter Optional. How to filter what is retrieved. Default 'raw'.
644 * @return string Mostly string values, might be empty.
646 function get_bloginfo( $show = '', $filter = 'raw' ) {
648 case 'home' : // DEPRECATED
649 case 'siteurl' : // DEPRECATED
650 _deprecated_argument( __FUNCTION__, '2.2.0', sprintf(
651 /* translators: 1: 'siteurl'/'home' argument, 2: bloginfo() function name, 3: 'url' argument */
652 __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s option instead.' ),
653 '<code>' . $show . '</code>',
654 '<code>bloginfo()</code>',
658 $output = home_url();
661 $output = site_url();
664 $output = get_option('blogdescription');
667 $output = get_feed_link('rdf');
670 $output = get_feed_link('rss');
673 $output = get_feed_link('rss2');
676 $output = get_feed_link('atom');
678 case 'comments_atom_url':
679 $output = get_feed_link('comments_atom');
681 case 'comments_rss2_url':
682 $output = get_feed_link('comments_rss2');
685 $output = site_url( 'xmlrpc.php' );
687 case 'stylesheet_url':
688 $output = get_stylesheet_uri();
690 case 'stylesheet_directory':
691 $output = get_stylesheet_directory_uri();
693 case 'template_directory':
695 $output = get_template_directory_uri();
698 $output = get_option('admin_email');
701 $output = get_option('blog_charset');
702 if ('' == $output) $output = 'UTF-8';
705 $output = get_option('html_type');
709 $output = $wp_version;
712 /* translators: Translate this to the correct language tag for your locale,
713 * see https://www.w3.org/International/articles/language-tags/ for reference.
714 * Do not translate into your own language.
716 $output = __( 'html_lang_attribute' );
717 if ( 'html_lang_attribute' === $output || preg_match( '/[^a-zA-Z0-9-]/', $output ) ) {
718 $output = get_locale();
719 $output = str_replace( '_', '-', $output );
722 case 'text_direction':
723 _deprecated_argument( __FUNCTION__, '2.2.0', sprintf(
724 /* translators: 1: 'text_direction' argument, 2: bloginfo() function name, 3: is_rtl() function name */
725 __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s function instead.' ),
726 '<code>' . $show . '</code>',
727 '<code>bloginfo()</code>',
728 '<code>is_rtl()</code>'
730 if ( function_exists( 'is_rtl' ) ) {
731 $output = is_rtl() ? 'rtl' : 'ltr';
738 $output = get_option('blogname');
743 if (strpos($show, 'url') === false &&
744 strpos($show, 'directory') === false &&
745 strpos($show, 'home') === false)
748 if ( 'display' == $filter ) {
751 * Filters the URL returned by get_bloginfo().
755 * @param mixed $output The URL returned by bloginfo().
756 * @param mixed $show Type of information requested.
758 $output = apply_filters( 'bloginfo_url', $output, $show );
761 * Filters the site information returned by get_bloginfo().
765 * @param mixed $output The requested non-URL site information.
766 * @param mixed $show Type of information requested.
768 $output = apply_filters( 'bloginfo', $output, $show );
776 * Returns the Site Icon URL.
780 * @param int $size Optional. Size of the site icon. Default 512 (pixels).
781 * @param string $url Optional. Fallback url if no site icon is found. Default empty.
782 * @param int $blog_id Optional. ID of the blog to get the site icon for. Default current blog.
783 * @return string Site Icon URL.
785 function get_site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
786 $switched_blog = false;
788 if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) {
789 switch_to_blog( $blog_id );
790 $switched_blog = true;
793 $site_icon_id = get_option( 'site_icon' );
795 if ( $site_icon_id ) {
796 if ( $size >= 512 ) {
799 $size_data = array( $size, $size );
801 $url = wp_get_attachment_image_url( $site_icon_id, $size_data );
804 if ( $switched_blog ) {
805 restore_current_blog();
809 * Filters the site icon URL.
813 * @param string $url Site icon URL.
814 * @param int $size Size of the site icon.
815 * @param int $blog_id ID of the blog to get the site icon for.
817 return apply_filters( 'get_site_icon_url', $url, $size, $blog_id );
821 * Displays the Site Icon URL.
825 * @param int $size Optional. Size of the site icon. Default 512 (pixels).
826 * @param string $url Optional. Fallback url if no site icon is found. Default empty.
827 * @param int $blog_id Optional. ID of the blog to get the site icon for. Default current blog.
829 function site_icon_url( $size = 512, $url = '', $blog_id = 0 ) {
830 echo esc_url( get_site_icon_url( $size, $url, $blog_id ) );
834 * Whether the site has a Site Icon.
838 * @param int $blog_id Optional. ID of the blog in question. Default current blog.
839 * @return bool Whether the site has a site icon or not.
841 function has_site_icon( $blog_id = 0 ) {
842 return (bool) get_site_icon_url( 512, '', $blog_id );
846 * Determines whether the site has a custom logo.
850 * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog.
851 * @return bool Whether the site has a custom logo or not.
853 function has_custom_logo( $blog_id = 0 ) {
854 $switched_blog = false;
856 if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) {
857 switch_to_blog( $blog_id );
858 $switched_blog = true;
861 $custom_logo_id = get_theme_mod( 'custom_logo' );
863 if ( $switched_blog ) {
864 restore_current_blog();
867 return (bool) $custom_logo_id;
871 * Returns a custom logo, linked to home.
875 * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog.
876 * @return string Custom logo markup.
878 function get_custom_logo( $blog_id = 0 ) {
880 $switched_blog = false;
882 if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) {
883 switch_to_blog( $blog_id );
884 $switched_blog = true;
887 $custom_logo_id = get_theme_mod( 'custom_logo' );
889 // We have a logo. Logo is go.
890 if ( $custom_logo_id ) {
891 $html = sprintf( '<a href="%1$s" class="custom-logo-link" rel="home" itemprop="url">%2$s</a>',
892 esc_url( home_url( '/' ) ),
893 wp_get_attachment_image( $custom_logo_id, 'full', false, array(
894 'class' => 'custom-logo',
895 'itemprop' => 'logo',
900 // If no logo is set but we're in the Customizer, leave a placeholder (needed for the live preview).
901 elseif ( is_customize_preview() ) {
902 $html = sprintf( '<a href="%1$s" class="custom-logo-link" style="display:none;"><img class="custom-logo"/></a>',
903 esc_url( home_url( '/' ) )
907 if ( $switched_blog ) {
908 restore_current_blog();
912 * Filters the custom logo output.
915 * @since 4.6.0 Added the `$blog_id` parameter.
917 * @param string $html Custom logo HTML output.
918 * @param int $blog_id ID of the blog to get the custom logo for.
920 return apply_filters( 'get_custom_logo', $html, $blog_id );
924 * Displays a custom logo, linked to home.
928 * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog.
930 function the_custom_logo( $blog_id = 0 ) {
931 echo get_custom_logo( $blog_id );
935 * Returns document title for the current page.
939 * @global int $page Page number of a single post.
940 * @global int $paged Page number of a list of posts.
942 * @return string Tag with the document title.
944 function wp_get_document_title() {
947 * Filters the document title before it is generated.
949 * Passing a non-empty value will short-circuit wp_get_document_title(),
950 * returning that value instead.
954 * @param string $title The document title. Default empty string.
956 $title = apply_filters( 'pre_get_document_title', '' );
957 if ( ! empty( $title ) ) {
961 global $page, $paged;
967 // If it's a 404 page, use a "Page not found" title.
969 $title['title'] = __( 'Page not found' );
971 // If it's a search, use a dynamic search results title.
972 } elseif ( is_search() ) {
973 /* translators: %s: search phrase */
974 $title['title'] = sprintf( __( 'Search Results for “%s”' ), get_search_query() );
976 // If on the front page, use the site title.
977 } elseif ( is_front_page() ) {
978 $title['title'] = get_bloginfo( 'name', 'display' );
980 // If on a post type archive, use the post type archive title.
981 } elseif ( is_post_type_archive() ) {
982 $title['title'] = post_type_archive_title( '', false );
984 // If on a taxonomy archive, use the term title.
985 } elseif ( is_tax() ) {
986 $title['title'] = single_term_title( '', false );
989 * If we're on the blog page that is not the homepage or
990 * a single post of any post type, use the post title.
992 } elseif ( is_home() || is_singular() ) {
993 $title['title'] = single_post_title( '', false );
995 // If on a category or tag archive, use the term title.
996 } elseif ( is_category() || is_tag() ) {
997 $title['title'] = single_term_title( '', false );
999 // If on an author archive, use the author's display name.
1000 } elseif ( is_author() && $author = get_queried_object() ) {
1001 $title['title'] = $author->display_name;
1003 // If it's a date archive, use the date as the title.
1004 } elseif ( is_year() ) {
1005 $title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) );
1007 } elseif ( is_month() ) {
1008 $title['title'] = get_the_date( _x( 'F Y', 'monthly archives date format' ) );
1010 } elseif ( is_day() ) {
1011 $title['title'] = get_the_date();
1014 // Add a page number if necessary.
1015 if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) {
1016 $title['page'] = sprintf( __( 'Page %s' ), max( $paged, $page ) );
1019 // Append the description or site title to give context.
1020 if ( is_front_page() ) {
1021 $title['tagline'] = get_bloginfo( 'description', 'display' );
1023 $title['site'] = get_bloginfo( 'name', 'display' );
1027 * Filters the separator for the document title.
1031 * @param string $sep Document title separator. Default '-'.
1033 $sep = apply_filters( 'document_title_separator', '-' );
1036 * Filters the parts of the document title.
1040 * @param array $title {
1041 * The document title parts.
1043 * @type string $title Title of the viewed page.
1044 * @type string $page Optional. Page number if paginated.
1045 * @type string $tagline Optional. Site description when on home page.
1046 * @type string $site Optional. Site title when not on home page.
1049 $title = apply_filters( 'document_title_parts', $title );
1051 $title = implode( " $sep ", array_filter( $title ) );
1052 $title = wptexturize( $title );
1053 $title = convert_chars( $title );
1054 $title = esc_html( $title );
1055 $title = capital_P_dangit( $title );
1061 * Displays title tag with content.
1065 * @since 4.4.0 Improved title output replaced `wp_title()`.
1068 function _wp_render_title_tag() {
1069 if ( ! current_theme_supports( 'title-tag' ) ) {
1073 echo '<title>' . wp_get_document_title() . '</title>' . "\n";
1077 * Display or retrieve page title for all areas of blog.
1079 * By default, the page title will display the separator before the page title,
1080 * so that the blog title will be before the page title. This is not good for
1081 * title display, since the blog title shows up on most tabs and not what is
1082 * important, which is the page that the user is looking at.
1084 * There are also SEO benefits to having the blog title after or to the 'right'
1085 * of the page title. However, it is mostly common sense to have the blog title
1086 * to the right with most browsers supporting tabs. You can achieve this by
1087 * using the seplocation parameter and setting the value to 'right'. This change
1088 * was introduced around 2.5.0, in case backward compatibility of themes is
1093 * @global WP_Locale $wp_locale
1095 * @param string $sep Optional, default is '»'. How to separate the various items
1096 * within the page title.
1097 * @param bool $display Optional, default is true. Whether to display or retrieve title.
1098 * @param string $seplocation Optional. Direction to display title, 'right'.
1099 * @return string|null String on retrieve, null when displaying.
1101 function wp_title( $sep = '»', $display = true, $seplocation = '' ) {
1104 $m = get_query_var( 'm' );
1105 $year = get_query_var( 'year' );
1106 $monthnum = get_query_var( 'monthnum' );
1107 $day = get_query_var( 'day' );
1108 $search = get_query_var( 's' );
1111 $t_sep = '%WP_TITLE_SEP%'; // Temporary separator, for accurate flipping, if necessary
1113 // If there is a post
1114 if ( is_single() || ( is_home() && ! is_front_page() ) || ( is_page() && ! is_front_page() ) ) {
1115 $title = single_post_title( '', false );
1118 // If there's a post type archive
1119 if ( is_post_type_archive() ) {
1120 $post_type = get_query_var( 'post_type' );
1121 if ( is_array( $post_type ) ) {
1122 $post_type = reset( $post_type );
1124 $post_type_object = get_post_type_object( $post_type );
1125 if ( ! $post_type_object->has_archive ) {
1126 $title = post_type_archive_title( '', false );
1130 // If there's a category or tag
1131 if ( is_category() || is_tag() ) {
1132 $title = single_term_title( '', false );
1135 // If there's a taxonomy
1137 $term = get_queried_object();
1139 $tax = get_taxonomy( $term->taxonomy );
1140 $title = single_term_title( $tax->labels->name . $t_sep, false );
1144 // If there's an author
1145 if ( is_author() && ! is_post_type_archive() ) {
1146 $author = get_queried_object();
1148 $title = $author->display_name;
1152 // Post type archives with has_archive should override terms.
1153 if ( is_post_type_archive() && $post_type_object->has_archive ) {
1154 $title = post_type_archive_title( '', false );
1157 // If there's a month
1158 if ( is_archive() && ! empty( $m ) ) {
1159 $my_year = substr( $m, 0, 4 );
1160 $my_month = $wp_locale->get_month( substr( $m, 4, 2 ) );
1161 $my_day = intval( substr( $m, 6, 2 ) );
1162 $title = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' );
1165 // If there's a year
1166 if ( is_archive() && ! empty( $year ) ) {
1168 if ( ! empty( $monthnum ) ) {
1169 $title .= $t_sep . $wp_locale->get_month( $monthnum );
1171 if ( ! empty( $day ) ) {
1172 $title .= $t_sep . zeroise( $day, 2 );
1177 if ( is_search() ) {
1178 /* translators: 1: separator, 2: search phrase */
1179 $title = sprintf( __( 'Search Results %1$s %2$s' ), $t_sep, strip_tags( $search ) );
1182 // If it's a 404 page
1184 $title = __( 'Page not found' );
1188 if ( ! empty( $title ) ) {
1193 * Filters the parts of the page title.
1197 * @param array $title_array Parts of the page title.
1199 $title_array = apply_filters( 'wp_title_parts', explode( $t_sep, $title ) );
1201 // Determines position of the separator and direction of the breadcrumb
1202 if ( 'right' == $seplocation ) { // sep on right, so reverse the order
1203 $title_array = array_reverse( $title_array );
1204 $title = implode( " $sep ", $title_array ) . $prefix;
1206 $title = $prefix . implode( " $sep ", $title_array );
1210 * Filters the text of the page title.
1214 * @param string $title Page title.
1215 * @param string $sep Title separator.
1216 * @param string $seplocation Location of the separator (left or right).
1218 $title = apply_filters( 'wp_title', $title, $sep, $seplocation );
1229 * Display or retrieve page title for post.
1231 * This is optimized for single.php template file for displaying the post title.
1233 * It does not support placing the separator after the title, but by leaving the
1234 * prefix parameter empty, you can set the title separator manually. The prefix
1235 * does not automatically place a space between the prefix, so if there should
1236 * be a space, the parameter value will need to have it at the end.
1240 * @param string $prefix Optional. What to display before the title.
1241 * @param bool $display Optional, default is true. Whether to display or retrieve title.
1242 * @return string|void Title when retrieving.
1244 function single_post_title( $prefix = '', $display = true ) {
1245 $_post = get_queried_object();
1247 if ( !isset($_post->post_title) )
1251 * Filters the page title for a single post.
1255 * @param string $_post_title The single post page title.
1256 * @param object $_post The current queried object as returned by get_queried_object().
1258 $title = apply_filters( 'single_post_title', $_post->post_title, $_post );
1260 echo $prefix . $title;
1262 return $prefix . $title;
1266 * Display or retrieve title for a post type archive.
1268 * This is optimized for archive.php and archive-{$post_type}.php template files
1269 * for displaying the title of the post type.
1273 * @param string $prefix Optional. What to display before the title.
1274 * @param bool $display Optional, default is true. Whether to display or retrieve title.
1275 * @return string|void Title when retrieving, null when displaying or failure.
1277 function post_type_archive_title( $prefix = '', $display = true ) {
1278 if ( ! is_post_type_archive() )
1281 $post_type = get_query_var( 'post_type' );
1282 if ( is_array( $post_type ) )
1283 $post_type = reset( $post_type );
1285 $post_type_obj = get_post_type_object( $post_type );
1288 * Filters the post type archive title.
1292 * @param string $post_type_name Post type 'name' label.
1293 * @param string $post_type Post type.
1295 $title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );
1298 echo $prefix . $title;
1300 return $prefix . $title;
1304 * Display or retrieve page title for category archive.
1306 * Useful for category template files for displaying the category page title.
1307 * The prefix does not automatically place a space between the prefix, so if
1308 * there should be a space, the parameter value will need to have it at the end.
1312 * @param string $prefix Optional. What to display before the title.
1313 * @param bool $display Optional, default is true. Whether to display or retrieve title.
1314 * @return string|void Title when retrieving.
1316 function single_cat_title( $prefix = '', $display = true ) {
1317 return single_term_title( $prefix, $display );
1321 * Display or retrieve page title for tag post archive.
1323 * Useful for tag template files for displaying the tag page title. The prefix
1324 * does not automatically place a space between the prefix, so if there should
1325 * be a space, the parameter value will need to have it at the end.
1329 * @param string $prefix Optional. What to display before the title.
1330 * @param bool $display Optional, default is true. Whether to display or retrieve title.
1331 * @return string|void Title when retrieving.
1333 function single_tag_title( $prefix = '', $display = true ) {
1334 return single_term_title( $prefix, $display );
1338 * Display or retrieve page title for taxonomy term archive.
1340 * Useful for taxonomy term template files for displaying the taxonomy term page title.
1341 * The prefix does not automatically place a space between the prefix, so if there should
1342 * be a space, the parameter value will need to have it at the end.
1346 * @param string $prefix Optional. What to display before the title.
1347 * @param bool $display Optional, default is true. Whether to display or retrieve title.
1348 * @return string|void Title when retrieving.
1350 function single_term_title( $prefix = '', $display = true ) {
1351 $term = get_queried_object();
1356 if ( is_category() ) {
1358 * Filters the category archive page title.
1362 * @param string $term_name Category name for archive being displayed.
1364 $term_name = apply_filters( 'single_cat_title', $term->name );
1365 } elseif ( is_tag() ) {
1367 * Filters the tag archive page title.
1371 * @param string $term_name Tag name for archive being displayed.
1373 $term_name = apply_filters( 'single_tag_title', $term->name );
1374 } elseif ( is_tax() ) {
1376 * Filters the custom taxonomy archive page title.
1380 * @param string $term_name Term name for archive being displayed.
1382 $term_name = apply_filters( 'single_term_title', $term->name );
1387 if ( empty( $term_name ) )
1391 echo $prefix . $term_name;
1393 return $prefix . $term_name;
1397 * Display or retrieve page title for post archive based on date.
1399 * Useful for when the template only needs to display the month and year,
1400 * if either are available. The prefix does not automatically place a space
1401 * between the prefix, so if there should be a space, the parameter value
1402 * will need to have it at the end.
1406 * @global WP_Locale $wp_locale
1408 * @param string $prefix Optional. What to display before the title.
1409 * @param bool $display Optional, default is true. Whether to display or retrieve title.
1410 * @return string|void Title when retrieving.
1412 function single_month_title($prefix = '', $display = true ) {
1415 $m = get_query_var('m');
1416 $year = get_query_var('year');
1417 $monthnum = get_query_var('monthnum');
1419 if ( !empty($monthnum) && !empty($year) ) {
1421 $my_month = $wp_locale->get_month($monthnum);
1422 } elseif ( !empty($m) ) {
1423 $my_year = substr($m, 0, 4);
1424 $my_month = $wp_locale->get_month(substr($m, 4, 2));
1427 if ( empty($my_month) )
1430 $result = $prefix . $my_month . $prefix . $my_year;
1438 * Display the archive title based on the queried object.
1442 * @see get_the_archive_title()
1444 * @param string $before Optional. Content to prepend to the title. Default empty.
1445 * @param string $after Optional. Content to append to the title. Default empty.
1447 function the_archive_title( $before = '', $after = '' ) {
1448 $title = get_the_archive_title();
1450 if ( ! empty( $title ) ) {
1451 echo $before . $title . $after;
1456 * Retrieve the archive title based on the queried object.
1460 * @return string Archive title.
1462 function get_the_archive_title() {
1463 if ( is_category() ) {
1464 /* translators: Category archive title. 1: Category name */
1465 $title = sprintf( __( 'Category: %s' ), single_cat_title( '', false ) );
1466 } elseif ( is_tag() ) {
1467 /* translators: Tag archive title. 1: Tag name */
1468 $title = sprintf( __( 'Tag: %s' ), single_tag_title( '', false ) );
1469 } elseif ( is_author() ) {
1470 /* translators: Author archive title. 1: Author name */
1471 $title = sprintf( __( 'Author: %s' ), '<span class="vcard">' . get_the_author() . '</span>' );
1472 } elseif ( is_year() ) {
1473 /* translators: Yearly archive title. 1: Year */
1474 $title = sprintf( __( 'Year: %s' ), get_the_date( _x( 'Y', 'yearly archives date format' ) ) );
1475 } elseif ( is_month() ) {
1476 /* translators: Monthly archive title. 1: Month name and year */
1477 $title = sprintf( __( 'Month: %s' ), get_the_date( _x( 'F Y', 'monthly archives date format' ) ) );
1478 } elseif ( is_day() ) {
1479 /* translators: Daily archive title. 1: Date */
1480 $title = sprintf( __( 'Day: %s' ), get_the_date( _x( 'F j, Y', 'daily archives date format' ) ) );
1481 } elseif ( is_tax( 'post_format' ) ) {
1482 if ( is_tax( 'post_format', 'post-format-aside' ) ) {
1483 $title = _x( 'Asides', 'post format archive title' );
1484 } elseif ( is_tax( 'post_format', 'post-format-gallery' ) ) {
1485 $title = _x( 'Galleries', 'post format archive title' );
1486 } elseif ( is_tax( 'post_format', 'post-format-image' ) ) {
1487 $title = _x( 'Images', 'post format archive title' );
1488 } elseif ( is_tax( 'post_format', 'post-format-video' ) ) {
1489 $title = _x( 'Videos', 'post format archive title' );
1490 } elseif ( is_tax( 'post_format', 'post-format-quote' ) ) {
1491 $title = _x( 'Quotes', 'post format archive title' );
1492 } elseif ( is_tax( 'post_format', 'post-format-link' ) ) {
1493 $title = _x( 'Links', 'post format archive title' );
1494 } elseif ( is_tax( 'post_format', 'post-format-status' ) ) {
1495 $title = _x( 'Statuses', 'post format archive title' );
1496 } elseif ( is_tax( 'post_format', 'post-format-audio' ) ) {
1497 $title = _x( 'Audio', 'post format archive title' );
1498 } elseif ( is_tax( 'post_format', 'post-format-chat' ) ) {
1499 $title = _x( 'Chats', 'post format archive title' );
1501 } elseif ( is_post_type_archive() ) {
1502 /* translators: Post type archive title. 1: Post type name */
1503 $title = sprintf( __( 'Archives: %s' ), post_type_archive_title( '', false ) );
1504 } elseif ( is_tax() ) {
1505 $tax = get_taxonomy( get_queried_object()->taxonomy );
1506 /* translators: Taxonomy term archive title. 1: Taxonomy singular name, 2: Current taxonomy term */
1507 $title = sprintf( __( '%1$s: %2$s' ), $tax->labels->singular_name, single_term_title( '', false ) );
1509 $title = __( 'Archives' );
1513 * Filters the archive title.
1517 * @param string $title Archive title to be displayed.
1519 return apply_filters( 'get_the_archive_title', $title );
1523 * Display category, tag, term, or author description.
1527 * @see get_the_archive_description()
1529 * @param string $before Optional. Content to prepend to the description. Default empty.
1530 * @param string $after Optional. Content to append to the description. Default empty.
1532 function the_archive_description( $before = '', $after = '' ) {
1533 $description = get_the_archive_description();
1534 if ( $description ) {
1535 echo $before . $description . $after;
1540 * Retrieve category, tag, term, or author description.
1543 * @since 4.7.0 Added support for author archives.
1545 * @see term_description()
1547 * @return string Archive description.
1549 function get_the_archive_description() {
1550 if ( is_author() ) {
1551 $description = get_the_author_meta( 'description' );
1553 $description = term_description();
1557 * Filters the archive description.
1561 * @param string $description Archive description to be displayed.
1563 return apply_filters( 'get_the_archive_description', $description );
1567 * Retrieve archive link content based on predefined or custom code.
1569 * The format can be one of four styles. The 'link' for head element, 'option'
1570 * for use in the select element, 'html' for use in list (either ol or ul HTML
1571 * elements). Custom content is also supported using the before and after
1574 * The 'link' format uses the `<link>` HTML element with the **archives**
1575 * relationship. The before and after parameters are not used. The text
1576 * parameter is used to describe the link.
1578 * The 'option' format uses the option HTML element for use in select element.
1579 * The value is the url parameter and the before and after parameters are used
1580 * between the text description.
1582 * The 'html' format, which is the default, uses the li HTML element for use in
1583 * the list HTML elements. The before parameter is before the link and the after
1584 * parameter is after the closing link.
1586 * The custom format uses the before parameter before the link ('a' HTML
1587 * element) and the after parameter after the closing link tag. If the above
1588 * three values for the format are not used, then custom format is assumed.
1592 * @param string $url URL to archive.
1593 * @param string $text Archive text description.
1594 * @param string $format Optional, default is 'html'. Can be 'link', 'option', 'html', or custom.
1595 * @param string $before Optional. Content to prepend to the description. Default empty.
1596 * @param string $after Optional. Content to append to the description. Default empty.
1597 * @return string HTML link content for archive.
1599 function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') {
1600 $text = wptexturize($text);
1601 $url = esc_url($url);
1603 if ('link' == $format)
1604 $link_html = "\t<link rel='archives' title='" . esc_attr( $text ) . "' href='$url' />\n";
1605 elseif ('option' == $format)
1606 $link_html = "\t<option value='$url'>$before $text $after</option>\n";
1607 elseif ('html' == $format)
1608 $link_html = "\t<li>$before<a href='$url'>$text</a>$after</li>\n";
1610 $link_html = "\t$before<a href='$url'>$text</a>$after\n";
1613 * Filters the archive link content.
1616 * @since 4.5.0 Added the `$url`, `$text`, `$format`, `$before`, and `$after` parameters.
1618 * @param string $link_html The archive HTML link content.
1619 * @param string $url URL to archive.
1620 * @param string $text Archive text description.
1621 * @param string $format Link format. Can be 'link', 'option', 'html', or custom.
1622 * @param string $before Content to prepend to the description.
1623 * @param string $after Content to append to the description.
1625 return apply_filters( 'get_archives_link', $link_html, $url, $text, $format, $before, $after );
1629 * Display archive links based on type and format.
1632 * @since 4.4.0 $post_type arg was added.
1634 * @see get_archives_link()
1636 * @global wpdb $wpdb
1637 * @global WP_Locale $wp_locale
1639 * @param string|array $args {
1640 * Default archive links arguments. Optional.
1642 * @type string $type Type of archive to retrieve. Accepts 'daily', 'weekly', 'monthly',
1643 * 'yearly', 'postbypost', or 'alpha'. Both 'postbypost' and 'alpha'
1644 * display the same archive link list as well as post titles instead
1645 * of displaying dates. The difference between the two is that 'alpha'
1646 * will order by post title and 'postbypost' will order by post date.
1647 * Default 'monthly'.
1648 * @type string|int $limit Number of links to limit the query to. Default empty (no limit).
1649 * @type string $format Format each link should take using the $before and $after args.
1650 * Accepts 'link' (`<link>` tag), 'option' (`<option>` tag), 'html'
1651 * (`<li>` tag), or a custom format, which generates a link anchor
1652 * with $before preceding and $after succeeding. Default 'html'.
1653 * @type string $before Markup to prepend to the beginning of each link. Default empty.
1654 * @type string $after Markup to append to the end of each link. Default empty.
1655 * @type bool $show_post_count Whether to display the post count alongside the link. Default false.
1656 * @type bool|int $echo Whether to echo or return the links list. Default 1|true to echo.
1657 * @type string $order Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
1659 * @type string $post_type Post type. Default 'post'.
1661 * @return string|void String when retrieving.
1663 function wp_get_archives( $args = '' ) {
1664 global $wpdb, $wp_locale;
1667 'type' => 'monthly', 'limit' => '',
1668 'format' => 'html', 'before' => '',
1669 'after' => '', 'show_post_count' => false,
1670 'echo' => 1, 'order' => 'DESC',
1671 'post_type' => 'post'
1674 $r = wp_parse_args( $args, $defaults );
1676 $post_type_object = get_post_type_object( $r['post_type'] );
1677 if ( ! is_post_type_viewable( $post_type_object ) ) {
1680 $r['post_type'] = $post_type_object->name;
1682 if ( '' == $r['type'] ) {
1683 $r['type'] = 'monthly';
1686 if ( ! empty( $r['limit'] ) ) {
1687 $r['limit'] = absint( $r['limit'] );
1688 $r['limit'] = ' LIMIT ' . $r['limit'];
1691 $order = strtoupper( $r['order'] );
1692 if ( $order !== 'ASC' ) {
1696 // this is what will separate dates on weekly archive links
1697 $archive_week_separator = '–';
1699 $sql_where = $wpdb->prepare( "WHERE post_type = %s AND post_status = 'publish'", $r['post_type'] );
1702 * Filters the SQL WHERE clause for retrieving archives.
1706 * @param string $sql_where Portion of SQL query containing the WHERE clause.
1707 * @param array $r An array of default arguments.
1709 $where = apply_filters( 'getarchives_where', $sql_where, $r );
1712 * Filters the SQL JOIN clause for retrieving archives.
1716 * @param string $sql_join Portion of SQL query containing JOIN clause.
1717 * @param array $r An array of default arguments.
1719 $join = apply_filters( 'getarchives_join', '', $r );
1723 $last_changed = wp_cache_get_last_changed( 'posts' );
1725 $limit = $r['limit'];
1727 if ( 'monthly' == $r['type'] ) {
1728 $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";
1729 $key = md5( $query );
1730 $key = "wp_get_archives:$key:$last_changed";
1731 if ( ! $results = wp_cache_get( $key, 'posts' ) ) {
1732 $results = $wpdb->get_results( $query );
1733 wp_cache_set( $key, $results, 'posts' );
1736 $after = $r['after'];
1737 foreach ( (array) $results as $result ) {
1738 $url = get_month_link( $result->year, $result->month );
1739 if ( 'post' !== $r['post_type'] ) {
1740 $url = add_query_arg( 'post_type', $r['post_type'], $url );
1742 /* translators: 1: month name, 2: 4-digit year */
1743 $text = sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $result->month ), $result->year );
1744 if ( $r['show_post_count'] ) {
1745 $r['after'] = ' (' . $result->posts . ')' . $after;
1747 $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
1750 } elseif ( 'yearly' == $r['type'] ) {
1751 $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";
1752 $key = md5( $query );
1753 $key = "wp_get_archives:$key:$last_changed";
1754 if ( ! $results = wp_cache_get( $key, 'posts' ) ) {
1755 $results = $wpdb->get_results( $query );
1756 wp_cache_set( $key, $results, 'posts' );
1759 $after = $r['after'];
1760 foreach ( (array) $results as $result) {
1761 $url = get_year_link( $result->year );
1762 if ( 'post' !== $r['post_type'] ) {
1763 $url = add_query_arg( 'post_type', $r['post_type'], $url );
1765 $text = sprintf( '%d', $result->year );
1766 if ( $r['show_post_count'] ) {
1767 $r['after'] = ' (' . $result->posts . ')' . $after;
1769 $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
1772 } elseif ( 'daily' == $r['type'] ) {
1773 $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";
1774 $key = md5( $query );
1775 $key = "wp_get_archives:$key:$last_changed";
1776 if ( ! $results = wp_cache_get( $key, 'posts' ) ) {
1777 $results = $wpdb->get_results( $query );
1778 wp_cache_set( $key, $results, 'posts' );
1781 $after = $r['after'];
1782 foreach ( (array) $results as $result ) {
1783 $url = get_day_link( $result->year, $result->month, $result->dayofmonth );
1784 if ( 'post' !== $r['post_type'] ) {
1785 $url = add_query_arg( 'post_type', $r['post_type'], $url );
1787 $date = sprintf( '%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth );
1788 $text = mysql2date( get_option( 'date_format' ), $date );
1789 if ( $r['show_post_count'] ) {
1790 $r['after'] = ' (' . $result->posts . ')' . $after;
1792 $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
1795 } elseif ( 'weekly' == $r['type'] ) {
1796 $week = _wp_mysql_week( '`post_date`' );
1797 $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";
1798 $key = md5( $query );
1799 $key = "wp_get_archives:$key:$last_changed";
1800 if ( ! $results = wp_cache_get( $key, 'posts' ) ) {
1801 $results = $wpdb->get_results( $query );
1802 wp_cache_set( $key, $results, 'posts' );
1806 $after = $r['after'];
1807 foreach ( (array) $results as $result ) {
1808 if ( $result->week != $arc_w_last ) {
1809 $arc_year = $result->yr;
1810 $arc_w_last = $result->week;
1811 $arc_week = get_weekstartend( $result->yyyymmdd, get_option( 'start_of_week' ) );
1812 $arc_week_start = date_i18n( get_option( 'date_format' ), $arc_week['start'] );
1813 $arc_week_end = date_i18n( get_option( 'date_format' ), $arc_week['end'] );
1814 $url = add_query_arg( array( 'm' => $arc_year, 'w' => $result->week, ), home_url( '/' ) );
1815 if ( 'post' !== $r['post_type'] ) {
1816 $url = add_query_arg( 'post_type', $r['post_type'], $url );
1818 $text = $arc_week_start . $archive_week_separator . $arc_week_end;
1819 if ( $r['show_post_count'] ) {
1820 $r['after'] = ' (' . $result->posts . ')' . $after;
1822 $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
1826 } elseif ( ( 'postbypost' == $r['type'] ) || ('alpha' == $r['type'] ) ) {
1827 $orderby = ( 'alpha' == $r['type'] ) ? 'post_title ASC ' : 'post_date DESC, ID DESC ';
1828 $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit";
1829 $key = md5( $query );
1830 $key = "wp_get_archives:$key:$last_changed";
1831 if ( ! $results = wp_cache_get( $key, 'posts' ) ) {
1832 $results = $wpdb->get_results( $query );
1833 wp_cache_set( $key, $results, 'posts' );
1836 foreach ( (array) $results as $result ) {
1837 if ( $result->post_date != '0000-00-00 00:00:00' ) {
1838 $url = get_permalink( $result );
1839 if ( $result->post_title ) {
1840 /** This filter is documented in wp-includes/post-template.php */
1841 $text = strip_tags( apply_filters( 'the_title', $result->post_title, $result->ID ) );
1843 $text = $result->ID;
1845 $output .= get_archives_link( $url, $text, $r['format'], $r['before'], $r['after'] );
1858 * Get number of days since the start of the week.
1862 * @param int $num Number of day.
1863 * @return int Days since the start of the week.
1865 function calendar_week_mod($num) {
1867 return ($num - $base*floor($num/$base));
1871 * Display calendar with days that have posts as links.
1873 * The calendar is cached, which will be retrieved, if it exists. If there are
1874 * no posts for the month, then it will not be displayed.
1878 * @global wpdb $wpdb
1880 * @global int $monthnum
1882 * @global WP_Locale $wp_locale
1883 * @global array $posts
1885 * @param bool $initial Optional, default is true. Use initial calendar names.
1886 * @param bool $echo Optional, default is true. Set to false for return.
1887 * @return string|void String when retrieving.
1889 function get_calendar( $initial = true, $echo = true ) {
1890 global $wpdb, $m, $monthnum, $year, $wp_locale, $posts;
1892 $key = md5( $m . $monthnum . $year );
1893 $cache = wp_cache_get( 'get_calendar', 'calendar' );
1895 if ( $cache && is_array( $cache ) && isset( $cache[ $key ] ) ) {
1896 /** This filter is documented in wp-includes/general-template.php */
1897 $output = apply_filters( 'get_calendar', $cache[ $key ] );
1907 if ( ! is_array( $cache ) ) {
1911 // Quick check. If we have no posts at all, abort!
1913 $gotsome = $wpdb->get_var("SELECT 1 as test FROM $wpdb->posts WHERE post_type = 'post' AND post_status = 'publish' LIMIT 1");
1915 $cache[ $key ] = '';
1916 wp_cache_set( 'get_calendar', $cache, 'calendar' );
1921 if ( isset( $_GET['w'] ) ) {
1922 $w = (int) $_GET['w'];
1924 // week_begins = 0 stands for Sunday
1925 $week_begins = (int) get_option( 'start_of_week' );
1926 $ts = current_time( 'timestamp' );
1928 // Let's figure out when we are
1929 if ( ! empty( $monthnum ) && ! empty( $year ) ) {
1930 $thismonth = zeroise( intval( $monthnum ), 2 );
1931 $thisyear = (int) $year;
1932 } elseif ( ! empty( $w ) ) {
1933 // We need to get the month from MySQL
1934 $thisyear = (int) substr( $m, 0, 4 );
1935 //it seems MySQL's weeks disagree with PHP's
1936 $d = ( ( $w - 1 ) * 7 ) + 6;
1937 $thismonth = $wpdb->get_var("SELECT DATE_FORMAT((DATE_ADD('{$thisyear}0101', INTERVAL $d DAY) ), '%m')");
1938 } elseif ( ! empty( $m ) ) {
1939 $thisyear = (int) substr( $m, 0, 4 );
1940 if ( strlen( $m ) < 6 ) {
1943 $thismonth = zeroise( (int) substr( $m, 4, 2 ), 2 );
1946 $thisyear = gmdate( 'Y', $ts );
1947 $thismonth = gmdate( 'm', $ts );
1950 $unixmonth = mktime( 0, 0 , 0, $thismonth, 1, $thisyear );
1951 $last_day = date( 't', $unixmonth );
1953 // Get the next and previous month and year with at least one post
1954 $previous = $wpdb->get_row("SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
1956 WHERE post_date < '$thisyear-$thismonth-01'
1957 AND post_type = 'post' AND post_status = 'publish'
1958 ORDER BY post_date DESC
1960 $next = $wpdb->get_row("SELECT MONTH(post_date) AS month, YEAR(post_date) AS year
1962 WHERE post_date > '$thisyear-$thismonth-{$last_day} 23:59:59'
1963 AND post_type = 'post' AND post_status = 'publish'
1964 ORDER BY post_date ASC
1967 /* translators: Calendar caption: 1: month name, 2: 4-digit year */
1968 $calendar_caption = _x('%1$s %2$s', 'calendar caption');
1969 $calendar_output = '<table id="wp-calendar">
1970 <caption>' . sprintf(
1972 $wp_locale->get_month( $thismonth ),
1973 date( 'Y', $unixmonth )
1980 for ( $wdcount = 0; $wdcount <= 6; $wdcount++ ) {
1981 $myweek[] = $wp_locale->get_weekday( ( $wdcount + $week_begins ) % 7 );
1984 foreach ( $myweek as $wd ) {
1985 $day_name = $initial ? $wp_locale->get_weekday_initial( $wd ) : $wp_locale->get_weekday_abbrev( $wd );
1986 $wd = esc_attr( $wd );
1987 $calendar_output .= "\n\t\t<th scope=\"col\" title=\"$wd\">$day_name</th>";
1990 $calendar_output .= '
1998 $calendar_output .= "\n\t\t".'<td colspan="3" id="prev"><a href="' . get_month_link( $previous->year, $previous->month ) . '">« ' .
1999 $wp_locale->get_month_abbrev( $wp_locale->get_month( $previous->month ) ) .
2002 $calendar_output .= "\n\t\t".'<td colspan="3" id="prev" class="pad"> </td>';
2005 $calendar_output .= "\n\t\t".'<td class="pad"> </td>';
2008 $calendar_output .= "\n\t\t".'<td colspan="3" id="next"><a href="' . get_month_link( $next->year, $next->month ) . '">' .
2009 $wp_locale->get_month_abbrev( $wp_locale->get_month( $next->month ) ) .
2010 ' »</a></td>';
2012 $calendar_output .= "\n\t\t".'<td colspan="3" id="next" class="pad"> </td>';
2015 $calendar_output .= '
2022 $daywithpost = array();
2024 // Get days with posts
2025 $dayswithposts = $wpdb->get_results("SELECT DISTINCT DAYOFMONTH(post_date)
2026 FROM $wpdb->posts WHERE post_date >= '{$thisyear}-{$thismonth}-01 00:00:00'
2027 AND post_type = 'post' AND post_status = 'publish'
2028 AND post_date <= '{$thisyear}-{$thismonth}-{$last_day} 23:59:59'", ARRAY_N);
2029 if ( $dayswithposts ) {
2030 foreach ( (array) $dayswithposts as $daywith ) {
2031 $daywithpost[] = $daywith[0];
2035 // See how much we should pad in the beginning
2036 $pad = calendar_week_mod( date( 'w', $unixmonth ) - $week_begins );
2038 $calendar_output .= "\n\t\t".'<td colspan="'. esc_attr( $pad ) .'" class="pad"> </td>';
2042 $daysinmonth = (int) date( 't', $unixmonth );
2044 for ( $day = 1; $day <= $daysinmonth; ++$day ) {
2045 if ( isset($newrow) && $newrow ) {
2046 $calendar_output .= "\n\t</tr>\n\t<tr>\n\t\t";
2050 if ( $day == gmdate( 'j', $ts ) &&
2051 $thismonth == gmdate( 'm', $ts ) &&
2052 $thisyear == gmdate( 'Y', $ts ) ) {
2053 $calendar_output .= '<td id="today">';
2055 $calendar_output .= '<td>';
2058 if ( in_array( $day, $daywithpost ) ) {
2060 $date_format = date( _x( 'F j, Y', 'daily archives date format' ), strtotime( "{$thisyear}-{$thismonth}-{$day}" ) );
2061 /* translators: Post calendar label. 1: Date */
2062 $label = sprintf( __( 'Posts published on %s' ), $date_format );
2063 $calendar_output .= sprintf(
2064 '<a href="%s" aria-label="%s">%s</a>',
2065 get_day_link( $thisyear, $thismonth, $day ),
2070 $calendar_output .= $day;
2072 $calendar_output .= '</td>';
2074 if ( 6 == calendar_week_mod( date( 'w', mktime(0, 0 , 0, $thismonth, $day, $thisyear ) ) - $week_begins ) ) {
2079 $pad = 7 - calendar_week_mod( date( 'w', mktime( 0, 0 , 0, $thismonth, $day, $thisyear ) ) - $week_begins );
2080 if ( $pad != 0 && $pad != 7 ) {
2081 $calendar_output .= "\n\t\t".'<td class="pad" colspan="'. esc_attr( $pad ) .'"> </td>';
2083 $calendar_output .= "\n\t</tr>\n\t</tbody>\n\t</table>";
2085 $cache[ $key ] = $calendar_output;
2086 wp_cache_set( 'get_calendar', $cache, 'calendar' );
2090 * Filters the HTML calendar output.
2094 * @param string $calendar_output HTML output of the calendar.
2096 echo apply_filters( 'get_calendar', $calendar_output );
2099 /** This filter is documented in wp-includes/general-template.php */
2100 return apply_filters( 'get_calendar', $calendar_output );
2104 * Purge the cached results of get_calendar.
2109 function delete_get_calendar_cache() {
2110 wp_cache_delete( 'get_calendar', 'calendar' );
2114 * Display all of the allowed tags in HTML format with attributes.
2116 * This is useful for displaying in the comment area, which elements and
2117 * attributes are supported. As well as any plugins which want to display it.
2121 * @global array $allowedtags
2123 * @return string HTML allowed tags entity encoded.
2125 function allowed_tags() {
2126 global $allowedtags;
2128 foreach ( (array) $allowedtags as $tag => $attributes ) {
2129 $allowed .= '<'.$tag;
2130 if ( 0 < count($attributes) ) {
2131 foreach ( $attributes as $attribute => $limits ) {
2132 $allowed .= ' '.$attribute.'=""';
2137 return htmlentities( $allowed );
2140 /***** Date/Time tags *****/
2143 * Outputs the date in iso8601 format for xml files.
2147 function the_date_xml() {
2148 echo mysql2date( 'Y-m-d', get_post()->post_date, false );
2152 * Display or Retrieve the date the current post was written (once per date)
2154 * Will only output the date if the current post's date is different from the
2155 * previous one output.
2157 * i.e. Only one date listing will show per day worth of posts shown in the loop, even if the
2158 * function is called several times for each post.
2160 * HTML output can be filtered with 'the_date'.
2161 * Date string output can be filtered with 'get_the_date'.
2165 * @global string|int|bool $currentday
2166 * @global string|int|bool $previousday
2168 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
2169 * @param string $before Optional. Output before the date.
2170 * @param string $after Optional. Output after the date.
2171 * @param bool $echo Optional, default is display. Whether to echo the date or return it.
2172 * @return string|void String if retrieving.
2174 function the_date( $d = '', $before = '', $after = '', $echo = true ) {
2175 global $currentday, $previousday;
2177 if ( is_new_day() ) {
2178 $the_date = $before . get_the_date( $d ) . $after;
2179 $previousday = $currentday;
2182 * Filters the date a post was published for display.
2186 * @param string $the_date The formatted date string.
2187 * @param string $d PHP date format. Defaults to 'date_format' option
2189 * @param string $before HTML output before the date.
2190 * @param string $after HTML output after the date.
2192 $the_date = apply_filters( 'the_date', $the_date, $d, $before, $after );
2202 * Retrieve the date on which the post was written.
2204 * Unlike the_date() this function will always return the date.
2205 * Modify output with the {@see 'get_the_date'} filter.
2209 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
2210 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
2211 * @return false|string Date the current post was written. False on failure.
2213 function get_the_date( $d = '', $post = null ) {
2214 $post = get_post( $post );
2221 $the_date = mysql2date( get_option( 'date_format' ), $post->post_date );
2223 $the_date = mysql2date( $d, $post->post_date );
2227 * Filters the date a post was published.
2231 * @param string $the_date The formatted date.
2232 * @param string $d PHP date format. Defaults to 'date_format' option
2234 * @param int|WP_Post $post The post object or ID.
2236 return apply_filters( 'get_the_date', $the_date, $d, $post );
2240 * Display the date on which the post was last modified.
2244 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
2245 * @param string $before Optional. Output before the date.
2246 * @param string $after Optional. Output after the date.
2247 * @param bool $echo Optional, default is display. Whether to echo the date or return it.
2248 * @return string|void String if retrieving.
2250 function the_modified_date( $d = '', $before = '', $after = '', $echo = true ) {
2251 $the_modified_date = $before . get_the_modified_date($d) . $after;
2254 * Filters the date a post was last modified for display.
2258 * @param string $the_modified_date The last modified date.
2259 * @param string $d PHP date format. Defaults to 'date_format' option
2261 * @param string $before HTML output before the date.
2262 * @param string $after HTML output after the date.
2264 $the_modified_date = apply_filters( 'the_modified_date', $the_modified_date, $d, $before, $after );
2267 echo $the_modified_date;
2269 return $the_modified_date;
2274 * Retrieve the date on which the post was last modified.
2277 * @since 4.6.0 Added the `$post` parameter.
2279 * @param string $d Optional. PHP date format defaults to the date_format option if not specified.
2280 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
2281 * @return false|string Date the current post was modified. False on failure.
2283 function get_the_modified_date( $d = '', $post = null ) {
2284 $post = get_post( $post );
2287 // For backward compatibility, failures go through the filter below.
2289 } elseif ( empty( $d ) ) {
2290 $the_time = get_post_modified_time( get_option( 'date_format' ), false, $post, true );
2292 $the_time = get_post_modified_time( $d, false, $post, true );
2296 * Filters the date a post was last modified.
2299 * @since 4.6.0 Added the `$post` parameter.
2301 * @param string $the_time The formatted date.
2302 * @param string $d PHP date format. Defaults to value specified in
2303 * 'date_format' option.
2304 * @param WP_Post $post WP_Post object.
2306 return apply_filters( 'get_the_modified_date', $the_time, $d, $post );
2310 * Display the time at which the post was written.
2314 * @param string $d Either 'G', 'U', or php date format.
2316 function the_time( $d = '' ) {
2318 * Filters the time a post was written for display.
2322 * @param string $get_the_time The formatted time.
2323 * @param string $d The time format. Accepts 'G', 'U',
2324 * or php date format.
2326 echo apply_filters( 'the_time', get_the_time( $d ), $d );
2330 * Retrieve the time at which the post was written.
2334 * @param string $d Optional. Format to use for retrieving the time the post
2335 * was written. Either 'G', 'U', or php date format defaults
2336 * to the value specified in the time_format option. Default empty.
2337 * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
2338 * @return string|int|false Formatted date string or Unix timestamp if `$id` is 'U' or 'G'. False on failure.
2340 function get_the_time( $d = '', $post = null ) {
2341 $post = get_post($post);
2348 $the_time = get_post_time(get_option('time_format'), false, $post, true);
2350 $the_time = get_post_time($d, false, $post, true);
2353 * Filters the time a post was written.
2357 * @param string $the_time The formatted time.
2358 * @param string $d Format to use for retrieving the time the post was written.
2359 * Accepts 'G', 'U', or php date format value specified
2360 * in 'time_format' option. Default empty.
2361 * @param int|WP_Post $post WP_Post object or ID.
2363 return apply_filters( 'get_the_time', $the_time, $d, $post );
2367 * Retrieve the time at which the post was written.
2371 * @param string $d Optional. Format to use for retrieving the time the post
2372 * was written. Either 'G', 'U', or php date format. Default 'U'.
2373 * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false.
2374 * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
2375 * @param bool $translate Whether to translate the time string. Default false.
2376 * @return string|int|false Formatted date string or Unix timestamp if `$id` is 'U' or 'G'. False on failure.
2378 function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
2379 $post = get_post($post);
2386 $time = $post->post_date_gmt;
2388 $time = $post->post_date;
2390 $time = mysql2date($d, $time, $translate);
2393 * Filters the localized time a post was written.
2397 * @param string $time The formatted time.
2398 * @param string $d Format to use for retrieving the time the post was written.
2399 * Accepts 'G', 'U', or php date format. Default 'U'.
2400 * @param bool $gmt Whether to retrieve the GMT time. Default false.
2402 return apply_filters( 'get_post_time', $time, $d, $gmt );
2406 * Display the time at which the post was last modified.
2410 * @param string $d Optional Either 'G', 'U', or php date format defaults to the value specified in the time_format option.
2412 function the_modified_time($d = '') {
2414 * Filters the localized time a post was last modified, for display.
2418 * @param string $get_the_modified_time The formatted time.
2419 * @param string $d The time format. Accepts 'G', 'U',
2420 * or php date format. Defaults to value
2421 * specified in 'time_format' option.
2423 echo apply_filters( 'the_modified_time', get_the_modified_time($d), $d );
2427 * Retrieve the time at which the post was last modified.
2430 * @since 4.6.0 Added the `$post` parameter.
2432 * @param string $d Optional. Format to use for retrieving the time the post
2433 * was modified. Either 'G', 'U', or php date format defaults
2434 * to the value specified in the time_format option. Default empty.
2435 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default current post.
2436 * @return false|string Formatted date string or Unix timestamp. False on failure.
2438 function get_the_modified_time( $d = '', $post = null ) {
2439 $post = get_post( $post );
2442 // For backward compatibility, failures go through the filter below.
2444 } elseif ( empty( $d ) ) {
2445 $the_time = get_post_modified_time( get_option( 'time_format' ), false, $post, true );
2447 $the_time = get_post_modified_time( $d, false, $post, true );
2451 * Filters the localized time a post was last modified.
2454 * @since 4.6.0 Added the `$post` parameter.
2456 * @param string $the_time The formatted time.
2457 * @param string $d Format to use for retrieving the time the post was
2458 * written. Accepts 'G', 'U', or php date format. Defaults
2459 * to value specified in 'time_format' option.
2460 * @param WP_Post $post WP_Post object.
2462 return apply_filters( 'get_the_modified_time', $the_time, $d, $post );
2466 * Retrieve the time at which the post was last modified.
2470 * @param string $d Optional. Format to use for retrieving the time the post
2471 * was modified. Either 'G', 'U', or php date format. Default 'U'.
2472 * @param bool $gmt Optional. Whether to retrieve the GMT time. Default false.
2473 * @param int|WP_Post $post WP_Post object or ID. Default is global $post object.
2474 * @param bool $translate Whether to translate the time string. Default false.
2475 * @return string|int|false Formatted date string or Unix timestamp if `$id` is 'U' or 'G'. False on failure.
2477 function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {
2478 $post = get_post($post);
2485 $time = $post->post_modified_gmt;
2487 $time = $post->post_modified;
2488 $time = mysql2date($d, $time, $translate);
2491 * Filters the localized time a post was last modified.
2495 * @param string $time The formatted time.
2496 * @param string $d The date format. Accepts 'G', 'U', or php date format. Default 'U'.
2497 * @param bool $gmt Whether to return the GMT time. Default false.
2499 return apply_filters( 'get_post_modified_time', $time, $d, $gmt );
2503 * Display the weekday on which the post was written.
2507 * @global WP_Locale $wp_locale
2509 function the_weekday() {
2511 $the_weekday = $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
2514 * Filters the weekday on which the post was written, for display.
2518 * @param string $the_weekday
2520 echo apply_filters( 'the_weekday', $the_weekday );
2524 * Display the weekday on which the post was written.
2526 * Will only output the weekday if the current post's weekday is different from
2527 * the previous one output.
2531 * @global WP_Locale $wp_locale
2532 * @global string|int|bool $currentday
2533 * @global string|int|bool $previousweekday
2535 * @param string $before Optional Output before the date.
2536 * @param string $after Optional Output after the date.
2538 function the_weekday_date($before='',$after='') {
2539 global $wp_locale, $currentday, $previousweekday;
2540 $the_weekday_date = '';
2541 if ( $currentday != $previousweekday ) {
2542 $the_weekday_date .= $before;
2543 $the_weekday_date .= $wp_locale->get_weekday( mysql2date( 'w', get_post()->post_date, false ) );
2544 $the_weekday_date .= $after;
2545 $previousweekday = $currentday;
2549 * Filters the localized date on which the post was written, for display.
2553 * @param string $the_weekday_date
2554 * @param string $before The HTML to output before the date.
2555 * @param string $after The HTML to output after the date.
2557 $the_weekday_date = apply_filters( 'the_weekday_date', $the_weekday_date, $before, $after );
2558 echo $the_weekday_date;
2562 * Fire the wp_head action.
2564 * See {@see 'wp_head'}.
2568 function wp_head() {
2570 * Prints scripts or data in the head tag on the front end.
2574 do_action( 'wp_head' );
2578 * Fire the wp_footer action.
2580 * See {@see 'wp_footer'}.
2584 function wp_footer() {
2586 * Prints scripts or data before the closing body tag on the front end.
2590 do_action( 'wp_footer' );
2594 * Display the links to the general feeds.
2598 * @param array $args Optional arguments.
2600 function feed_links( $args = array() ) {
2601 if ( !current_theme_supports('automatic-feed-links') )
2605 /* translators: Separator between blog name and feed type in feed links */
2606 'separator' => _x('»', 'feed link'),
2607 /* translators: 1: blog title, 2: separator (raquo) */
2608 'feedtitle' => __('%1$s %2$s Feed'),
2609 /* translators: 1: blog title, 2: separator (raquo) */
2610 'comstitle' => __('%1$s %2$s Comments Feed'),
2613 $args = wp_parse_args( $args, $defaults );
2616 * Filters whether to display the posts feed link.
2620 * @param bool $show Whether to display the posts feed link. Default true.
2622 if ( apply_filters( 'feed_links_show_posts_feed', true ) ) {
2623 echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( sprintf( $args['feedtitle'], get_bloginfo( 'name' ), $args['separator'] ) ) . '" href="' . esc_url( get_feed_link() ) . "\" />\n";
2627 * Filters whether to display the comments feed link.
2631 * @param bool $show Whether to display the comments feed link. Default true.
2633 if ( apply_filters( 'feed_links_show_comments_feed', true ) ) {
2634 echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( sprintf( $args['comstitle'], get_bloginfo( 'name' ), $args['separator'] ) ) . '" href="' . esc_url( get_feed_link( 'comments_' . get_default_feed() ) ) . "\" />\n";
2639 * Display the links to the extra feeds such as category feeds.
2643 * @param array $args Optional arguments.
2645 function feed_links_extra( $args = array() ) {
2647 /* translators: Separator between blog name and feed type in feed links */
2648 'separator' => _x('»', 'feed link'),
2649 /* translators: 1: blog name, 2: separator(raquo), 3: post title */
2650 'singletitle' => __('%1$s %2$s %3$s Comments Feed'),
2651 /* translators: 1: blog name, 2: separator(raquo), 3: category name */
2652 'cattitle' => __('%1$s %2$s %3$s Category Feed'),
2653 /* translators: 1: blog name, 2: separator(raquo), 3: tag name */
2654 'tagtitle' => __('%1$s %2$s %3$s Tag Feed'),
2655 /* translators: 1: blog name, 2: separator(raquo), 3: term name, 4: taxonomy singular name */
2656 'taxtitle' => __('%1$s %2$s %3$s %4$s Feed'),
2657 /* translators: 1: blog name, 2: separator(raquo), 3: author name */
2658 'authortitle' => __('%1$s %2$s Posts by %3$s Feed'),
2659 /* translators: 1: blog name, 2: separator(raquo), 3: search phrase */
2660 'searchtitle' => __('%1$s %2$s Search Results for “%3$s” Feed'),
2661 /* translators: 1: blog name, 2: separator(raquo), 3: post type name */
2662 'posttypetitle' => __('%1$s %2$s %3$s Feed'),
2665 $args = wp_parse_args( $args, $defaults );
2667 if ( is_singular() ) {
2669 $post = get_post( $id );
2671 if ( comments_open() || pings_open() || $post->comment_count > 0 ) {
2672 $title = sprintf( $args['singletitle'], get_bloginfo('name'), $args['separator'], the_title_attribute( array( 'echo' => false ) ) );
2673 $href = get_post_comments_feed_link( $post->ID );
2675 } elseif ( is_post_type_archive() ) {
2676 $post_type = get_query_var( 'post_type' );
2677 if ( is_array( $post_type ) )
2678 $post_type = reset( $post_type );
2680 $post_type_obj = get_post_type_object( $post_type );
2681 $title = sprintf( $args['posttypetitle'], get_bloginfo( 'name' ), $args['separator'], $post_type_obj->labels->name );
2682 $href = get_post_type_archive_feed_link( $post_type_obj->name );
2683 } elseif ( is_category() ) {
2684 $term = get_queried_object();
2687 $title = sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], $term->name );
2688 $href = get_category_feed_link( $term->term_id );
2690 } elseif ( is_tag() ) {
2691 $term = get_queried_object();
2694 $title = sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $term->name );
2695 $href = get_tag_feed_link( $term->term_id );
2697 } elseif ( is_tax() ) {
2698 $term = get_queried_object();
2699 $tax = get_taxonomy( $term->taxonomy );
2700 $title = sprintf( $args['taxtitle'], get_bloginfo('name'), $args['separator'], $term->name, $tax->labels->singular_name );
2701 $href = get_term_feed_link( $term->term_id, $term->taxonomy );
2702 } elseif ( is_author() ) {
2703 $author_id = intval( get_query_var('author') );
2705 $title = sprintf( $args['authortitle'], get_bloginfo('name'), $args['separator'], get_the_author_meta( 'display_name', $author_id ) );
2706 $href = get_author_feed_link( $author_id );
2707 } elseif ( is_search() ) {
2708 $title = sprintf( $args['searchtitle'], get_bloginfo('name'), $args['separator'], get_search_query( false ) );
2709 $href = get_search_feed_link();
2710 } elseif ( is_post_type_archive() ) {
2711 $title = sprintf( $args['posttypetitle'], get_bloginfo('name'), $args['separator'], post_type_archive_title( '', false ) );
2712 $post_type_obj = get_queried_object();
2713 if ( $post_type_obj )
2714 $href = get_post_type_archive_feed_link( $post_type_obj->name );
2717 if ( isset($title) && isset($href) )
2718 echo '<link rel="alternate" type="' . feed_content_type() . '" title="' . esc_attr( $title ) . '" href="' . esc_url( $href ) . '" />' . "\n";
2722 * Display the link to the Really Simple Discovery service endpoint.
2724 * @link http://archipelago.phrasewise.com/rsd
2727 function rsd_link() {
2728 echo '<link rel="EditURI" type="application/rsd+xml" title="RSD" href="' . esc_url( site_url( 'xmlrpc.php?rsd', 'rpc' ) ) . '" />' . "\n";
2732 * Display the link to the Windows Live Writer manifest file.
2734 * @link https://msdn.microsoft.com/en-us/library/bb463265.aspx
2737 function wlwmanifest_link() {
2738 echo '<link rel="wlwmanifest" type="application/wlwmanifest+xml" href="',
2739 includes_url( 'wlwmanifest.xml' ), '" /> ', "\n";
2743 * Displays a noindex meta tag if required by the blog configuration.
2745 * If a blog is marked as not being public then the noindex meta tag will be
2746 * output to tell web robots not to index the page content. Add this to the
2747 * {@see 'wp_head'} action.
2749 * Typical usage is as a {@see 'wp_head'} callback:
2751 * add_action( 'wp_head', 'noindex' );
2757 function noindex() {
2758 // If the blog is not public, tell robots to go away.
2759 if ( '0' == get_option('blog_public') )
2764 * Display a noindex meta tag.
2766 * Outputs a noindex meta tag that tells web robots not to index the page content.
2767 * Typical usage is as a wp_head callback. add_action( 'wp_head', 'wp_no_robots' );
2771 function wp_no_robots() {
2772 echo "<meta name='robots' content='noindex,follow' />\n";
2776 * Display site icon meta tags.
2780 * @link https://www.whatwg.org/specs/web-apps/current-work/multipage/links.html#rel-icon HTML5 specification link icon.
2782 function wp_site_icon() {
2783 if ( ! has_site_icon() && ! is_customize_preview() ) {
2787 $meta_tags = array();
2788 $icon_32 = get_site_icon_url( 32 );
2789 if ( empty( $icon_32 ) && is_customize_preview() ) {
2790 $icon_32 = '/favicon.ico'; // Serve default favicon URL in customizer so element can be updated for preview.
2793 $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="32x32" />', esc_url( $icon_32 ) );
2795 $icon_192 = get_site_icon_url( 192 );
2797 $meta_tags[] = sprintf( '<link rel="icon" href="%s" sizes="192x192" />', esc_url( $icon_192 ) );
2799 $icon_180 = get_site_icon_url( 180 );
2801 $meta_tags[] = sprintf( '<link rel="apple-touch-icon-precomposed" href="%s" />', esc_url( $icon_180 ) );
2803 $icon_270 = get_site_icon_url( 270 );
2805 $meta_tags[] = sprintf( '<meta name="msapplication-TileImage" content="%s" />', esc_url( $icon_270 ) );
2809 * Filters the site icon meta tags, so Plugins can add their own.
2813 * @param array $meta_tags Site Icon meta elements.
2815 $meta_tags = apply_filters( 'site_icon_meta_tags', $meta_tags );
2816 $meta_tags = array_filter( $meta_tags );
2818 foreach ( $meta_tags as $meta_tag ) {
2824 * Prints resource hints to browsers for pre-fetching, pre-rendering
2825 * and pre-connecting to web sites.
2827 * Gives hints to browsers to prefetch specific pages or render them
2828 * in the background, to perform DNS lookups or to begin the connection
2829 * handshake (DNS, TCP, TLS) in the background.
2831 * These performance improving indicators work by using `<link rel"…">`.
2835 function wp_resource_hints() {
2837 'dns-prefetch' => wp_dependencies_unique_hosts(),
2838 'preconnect' => array(),
2839 'prefetch' => array(),
2840 'prerender' => array(),
2844 * Add DNS prefetch for the Emoji CDN.
2845 * The path is removed in the foreach loop below.
2847 /** This filter is documented in wp-includes/formatting.php */
2848 $hints['dns-prefetch'][] = apply_filters( 'emoji_svg_url', 'https://s.w.org/images/core/emoji/2.2.1/svg/' );
2850 foreach ( $hints as $relation_type => $urls ) {
2851 $unique_urls = array();
2854 * Filters domains and URLs for resource hints of relation type.
2858 * @param array $urls URLs to print for resource hints.
2859 * @param string $relation_type The relation type the URLs are printed for, e.g. 'preconnect' or 'prerender'.
2861 $urls = apply_filters( 'wp_resource_hints', $urls, $relation_type );
2863 foreach ( $urls as $key => $url ) {
2866 if ( is_array( $url ) ) {
2867 if ( isset( $url['href'] ) ) {
2869 $url = $url['href'];
2875 $url = esc_url( $url, array( 'http', 'https' ) );
2881 if ( isset( $unique_urls[ $url ] ) ) {
2885 if ( in_array( $relation_type, array( 'preconnect', 'dns-prefetch' ) ) ) {
2886 $parsed = wp_parse_url( $url );
2888 if ( empty( $parsed['host'] ) ) {
2892 if ( 'preconnect' === $relation_type && ! empty( $parsed['scheme'] ) ) {
2893 $url = $parsed['scheme'] . '://' . $parsed['host'];
2895 // Use protocol-relative URLs for dns-prefetch or if scheme is missing.
2896 $url = '//' . $parsed['host'];
2900 $atts['rel'] = $relation_type;
2901 $atts['href'] = $url;
2903 $unique_urls[ $url ] = $atts;
2906 foreach ( $unique_urls as $atts ) {
2909 foreach ( $atts as $attr => $value ) {
2910 if ( ! is_scalar( $value ) ||
2911 ( ! in_array( $attr, array( 'as', 'crossorigin', 'href', 'pr', 'rel', 'type' ), true ) && ! is_numeric( $attr ))
2916 $value = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
2918 if ( ! is_string( $attr ) ) {
2921 $html .= " $attr='$value'";
2925 $html = trim( $html );
2927 echo "<link $html />\n";
2933 * Retrieves a list of unique hosts of all enqueued scripts and styles.
2937 * @return array A list of unique hosts of enqueued scripts and styles.
2939 function wp_dependencies_unique_hosts() {
2940 global $wp_scripts, $wp_styles;
2942 $unique_hosts = array();
2944 foreach ( array( $wp_scripts, $wp_styles ) as $dependencies ) {
2945 if ( $dependencies instanceof WP_Dependencies && ! empty( $dependencies->queue ) ) {
2946 foreach ( $dependencies->queue as $handle ) {
2947 if ( ! isset( $dependencies->registered[ $handle ] ) ) {
2951 /* @var _WP_Dependency $dependency */
2952 $dependency = $dependencies->registered[ $handle ];
2953 $parsed = wp_parse_url( $dependency->src );
2955 if ( ! empty( $parsed['host'] ) && ! in_array( $parsed['host'], $unique_hosts ) && $parsed['host'] !== $_SERVER['SERVER_NAME'] ) {
2956 $unique_hosts[] = $parsed['host'];
2962 return $unique_hosts;
2966 * Whether the user can access the visual editor.
2968 * Checks if the user can access the visual editor and that it's supported by the user's browser.
2972 * @global bool $wp_rich_edit Whether the user can access the visual editor.
2973 * @global bool $is_gecko Whether the browser is Gecko-based.
2974 * @global bool $is_opera Whether the browser is Opera.
2975 * @global bool $is_safari Whether the browser is Safari.
2976 * @global bool $is_chrome Whether the browser is Chrome.
2977 * @global bool $is_IE Whether the browser is Internet Explorer.
2978 * @global bool $is_edge Whether the browser is Microsoft Edge.
2980 * @return bool True if the user can access the visual editor, false otherwise.
2982 function user_can_richedit() {
2983 global $wp_rich_edit, $is_gecko, $is_opera, $is_safari, $is_chrome, $is_IE, $is_edge;
2985 if ( !isset($wp_rich_edit) ) {
2986 $wp_rich_edit = false;
2988 if ( get_user_option( 'rich_editing' ) == 'true' || ! is_user_logged_in() ) { // default to 'true' for logged out users
2990 $wp_rich_edit = ! wp_is_mobile() || ( preg_match( '!AppleWebKit/(\d+)!', $_SERVER['HTTP_USER_AGENT'], $match ) && intval( $match[1] ) >= 534 );
2991 } elseif ( $is_gecko || $is_chrome || $is_IE || $is_edge || ( $is_opera && !wp_is_mobile() ) ) {
2992 $wp_rich_edit = true;
2998 * Filters whether the user can access the visual editor.
3002 * @param bool $wp_rich_edit Whether the user can access the visual editor.
3004 return apply_filters( 'user_can_richedit', $wp_rich_edit );
3008 * Find out which editor should be displayed by default.
3010 * Works out which of the two editors to display as the current editor for a
3011 * user. The 'html' setting is for the "Text" editor tab.
3015 * @return string Either 'tinymce', or 'html', or 'test'
3017 function wp_default_editor() {
3018 $r = user_can_richedit() ? 'tinymce' : 'html'; // defaults
3019 if ( wp_get_current_user() ) { // look for cookie
3020 $ed = get_user_setting('editor', 'tinymce');
3021 $r = ( in_array($ed, array('tinymce', 'html', 'test') ) ) ? $ed : $r;
3025 * Filters which editor should be displayed by default.
3029 * @param string $r Which editor should be displayed by default. Either 'tinymce', 'html', or 'test'.
3031 return apply_filters( 'wp_default_editor', $r );
3035 * Renders an editor.
3037 * Using this function is the proper way to output all needed components for both TinyMCE and Quicktags.
3038 * _WP_Editors should not be used directly. See https://core.trac.wordpress.org/ticket/17144.
3040 * NOTE: Once initialized the TinyMCE editor cannot be safely moved in the DOM. For that reason
3041 * running wp_editor() inside of a meta box is not a good idea unless only Quicktags is used.
3042 * On the post edit screen several actions can be used to include additional editors
3043 * containing TinyMCE: 'edit_page_form', 'edit_form_advanced' and 'dbx_post_sidebar'.
3044 * See https://core.trac.wordpress.org/ticket/19173 for more information.
3046 * @see _WP_Editors::editor()
3049 * @param string $content Initial content for the editor.
3050 * @param string $editor_id HTML ID attribute value for the textarea and TinyMCE. Can only be /[a-z]+/.
3051 * @param array $settings See _WP_Editors::editor().
3053 function wp_editor( $content, $editor_id, $settings = array() ) {
3054 if ( ! class_exists( '_WP_Editors', false ) )
3055 require( ABSPATH . WPINC . '/class-wp-editor.php' );
3056 _WP_Editors::editor($content, $editor_id, $settings);
3060 * Retrieves the contents of the search WordPress query variable.
3062 * The search query string is passed through esc_attr() to ensure that it is safe
3063 * for placing in an html attribute.
3067 * @param bool $escaped Whether the result is escaped. Default true.
3068 * Only use when you are later escaping it. Do not use unescaped.
3071 function get_search_query( $escaped = true ) {
3073 * Filters the contents of the search query variable.
3077 * @param mixed $search Contents of the search query variable.
3079 $query = apply_filters( 'get_search_query', get_query_var( 's' ) );
3082 $query = esc_attr( $query );
3087 * Displays the contents of the search query variable.
3089 * The search query string is passed through esc_attr() to ensure that it is safe
3090 * for placing in an html attribute.
3094 function the_search_query() {
3096 * Filters the contents of the search query variable for display.
3100 * @param mixed $search Contents of the search query variable.
3102 echo esc_attr( apply_filters( 'the_search_query', get_search_query( false ) ) );
3106 * Gets the language attributes for the html tag.
3108 * Builds up a set of html attributes containing the text direction and language
3109 * information for the page.
3113 * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
3115 function get_language_attributes( $doctype = 'html' ) {
3116 $attributes = array();
3118 if ( function_exists( 'is_rtl' ) && is_rtl() )
3119 $attributes[] = 'dir="rtl"';
3121 if ( $lang = get_bloginfo('language') ) {
3122 if ( get_option('html_type') == 'text/html' || $doctype == 'html' )
3123 $attributes[] = "lang=\"$lang\"";
3125 if ( get_option('html_type') != 'text/html' || $doctype == 'xhtml' )
3126 $attributes[] = "xml:lang=\"$lang\"";
3129 $output = implode(' ', $attributes);
3132 * Filters the language attributes for display in the html tag.
3135 * @since 4.3.0 Added the `$doctype` parameter.
3137 * @param string $output A space-separated list of language attributes.
3138 * @param string $doctype The type of html document (xhtml|html).
3140 return apply_filters( 'language_attributes', $output, $doctype );
3144 * Displays the language attributes for the html tag.
3146 * Builds up a set of html attributes containing the text direction and language
3147 * information for the page.
3150 * @since 4.3.0 Converted into a wrapper for get_language_attributes().
3152 * @param string $doctype Optional. The type of html document. Accepts 'xhtml' or 'html'. Default 'html'.
3154 function language_attributes( $doctype = 'html' ) {
3155 echo get_language_attributes( $doctype );
3159 * Retrieve paginated link for archive post pages.
3161 * Technically, the function can be used to create paginated link list for any
3162 * area. The 'base' argument is used to reference the url, which will be used to
3163 * create the paginated links. The 'format' argument is then used for replacing
3164 * the page number. It is however, most likely and by default, to be used on the
3165 * archive post pages.
3167 * The 'type' argument controls format of the returned value. The default is
3168 * 'plain', which is just a string with the links separated by a newline
3169 * character. The other possible values are either 'array' or 'list'. The
3170 * 'array' value will return an array of the paginated link list to offer full
3171 * control of display. The 'list' value will place all of the paginated links in
3172 * an unordered HTML list.
3174 * The 'total' argument is the total amount of pages and is an integer. The
3175 * 'current' argument is the current page number and is also an integer.
3177 * An example of the 'base' argument is "http://example.com/all_posts.php%_%"
3178 * and the '%_%' is required. The '%_%' will be replaced by the contents of in
3179 * the 'format' argument. An example for the 'format' argument is "?page=%#%"
3180 * and the '%#%' is also required. The '%#%' will be replaced with the page
3183 * You can include the previous and next links in the list by setting the
3184 * 'prev_next' argument to true, which it is by default. You can set the
3185 * previous text, by using the 'prev_text' argument. You can set the next text
3186 * by setting the 'next_text' argument.
3188 * If the 'show_all' argument is set to true, then it will show all of the pages
3189 * instead of a short list of the pages near the current page. By default, the
3190 * 'show_all' is set to false and controlled by the 'end_size' and 'mid_size'
3191 * arguments. The 'end_size' argument is how many numbers on either the start
3192 * and the end list edges, by default is 1. The 'mid_size' argument is how many
3193 * numbers to either side of current page, but not including current page.
3195 * It is possible to add query vars to the link by using the 'add_args' argument
3196 * and see add_query_arg() for more information.
3198 * The 'before_page_number' and 'after_page_number' arguments allow users to
3199 * augment the links themselves. Typically this might be to add context to the
3200 * numbered links so that screen reader users understand what the links are for.
3201 * The text strings are added before and after the page number - within the
3206 * @global WP_Query $wp_query
3207 * @global WP_Rewrite $wp_rewrite
3209 * @param string|array $args {
3210 * Optional. Array or string of arguments for generating paginated links for archives.
3212 * @type string $base Base of the paginated url. Default empty.
3213 * @type string $format Format for the pagination structure. Default empty.
3214 * @type int $total The total amount of pages. Default is the value WP_Query's
3215 * `max_num_pages` or 1.
3216 * @type int $current The current page number. Default is 'paged' query var or 1.
3217 * @type bool $show_all Whether to show all pages. Default false.
3218 * @type int $end_size How many numbers on either the start and the end list edges.
3220 * @type int $mid_size How many numbers to either side of the current pages. Default 2.
3221 * @type bool $prev_next Whether to include the previous and next links in the list. Default true.
3222 * @type bool $prev_text The previous page text. Default '« Previous'.
3223 * @type bool $next_text The next page text. Default 'Next »'.
3224 * @type string $type Controls format of the returned value. Possible values are 'plain',
3225 * 'array' and 'list'. Default is 'plain'.
3226 * @type array $add_args An array of query args to add. Default false.
3227 * @type string $add_fragment A string to append to each link. Default empty.
3228 * @type string $before_page_number A string to appear before the page number. Default empty.
3229 * @type string $after_page_number A string to append after the page number. Default empty.
3231 * @return array|string|void String of page links or array of page links.
3233 function paginate_links( $args = '' ) {
3234 global $wp_query, $wp_rewrite;
3236 // Setting up default values based on the current URL.
3237 $pagenum_link = html_entity_decode( get_pagenum_link() );
3238 $url_parts = explode( '?', $pagenum_link );
3240 // Get max pages and current page out of the current query, if available.
3241 $total = isset( $wp_query->max_num_pages ) ? $wp_query->max_num_pages : 1;
3242 $current = get_query_var( 'paged' ) ? intval( get_query_var( 'paged' ) ) : 1;
3244 // Append the format placeholder to the base URL.
3245 $pagenum_link = trailingslashit( $url_parts[0] ) . '%_%';
3247 // URL base depends on permalink settings.
3248 $format = $wp_rewrite->using_index_permalinks() && ! strpos( $pagenum_link, 'index.php' ) ? 'index.php/' : '';
3249 $format .= $wp_rewrite->using_permalinks() ? user_trailingslashit( $wp_rewrite->pagination_base . '/%#%', 'paged' ) : '?paged=%#%';
3252 'base' => $pagenum_link, // http://example.com/all_posts.php%_% : %_% is replaced by format (below)
3253 'format' => $format, // ?page=%#% : %#% is replaced by the page number
3255 'current' => $current,
3256 'show_all' => false,
3257 'prev_next' => true,
3258 'prev_text' => __('« Previous'),
3259 'next_text' => __('Next »'),
3263 'add_args' => array(), // array of query args to add
3264 'add_fragment' => '',
3265 'before_page_number' => '',
3266 'after_page_number' => ''
3269 $args = wp_parse_args( $args, $defaults );
3271 if ( ! is_array( $args['add_args'] ) ) {
3272 $args['add_args'] = array();
3275 // Merge additional query vars found in the original URL into 'add_args' array.
3276 if ( isset( $url_parts[1] ) ) {
3277 // Find the format argument.
3278 $format = explode( '?', str_replace( '%_%', $args['format'], $args['base'] ) );
3279 $format_query = isset( $format[1] ) ? $format[1] : '';
3280 wp_parse_str( $format_query, $format_args );
3282 // Find the query args of the requested URL.
3283 wp_parse_str( $url_parts[1], $url_query_args );
3285 // Remove the format argument from the array of query arguments, to avoid overwriting custom format.
3286 foreach ( $format_args as $format_arg => $format_arg_value ) {
3287 unset( $url_query_args[ $format_arg ] );
3290 $args['add_args'] = array_merge( $args['add_args'], urlencode_deep( $url_query_args ) );
3293 // Who knows what else people pass in $args
3294 $total = (int) $args['total'];
3298 $current = (int) $args['current'];
3299 $end_size = (int) $args['end_size']; // Out of bounds? Make it the default.
3300 if ( $end_size < 1 ) {
3303 $mid_size = (int) $args['mid_size'];
3304 if ( $mid_size < 0 ) {
3307 $add_args = $args['add_args'];
3309 $page_links = array();
3312 if ( $args['prev_next'] && $current && 1 < $current ) :
3313 $link = str_replace( '%_%', 2 == $current ? '' : $args['format'], $args['base'] );
3314 $link = str_replace( '%#%', $current - 1, $link );
3316 $link = add_query_arg( $add_args, $link );
3317 $link .= $args['add_fragment'];
3320 * Filters the paginated links for the given archive pages.
3324 * @param string $link The paginated link URL.
3326 $page_links[] = '<a class="prev page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['prev_text'] . '</a>';
3328 for ( $n = 1; $n <= $total; $n++ ) :
3329 if ( $n == $current ) :
3330 $page_links[] = "<span class='page-numbers current'>" . $args['before_page_number'] . number_format_i18n( $n ) . $args['after_page_number'] . "</span>";
3333 if ( $args['show_all'] || ( $n <= $end_size || ( $current && $n >= $current - $mid_size && $n <= $current + $mid_size ) || $n > $total - $end_size ) ) :
3334 $link = str_replace( '%_%', 1 == $n ? '' : $args['format'], $args['base'] );
3335 $link = str_replace( '%#%', $n, $link );
3337 $link = add_query_arg( $add_args, $link );
3338 $link .= $args['add_fragment'];
3340 /** This filter is documented in wp-includes/general-template.php */
3341 $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>";
3343 elseif ( $dots && ! $args['show_all'] ) :
3344 $page_links[] = '<span class="page-numbers dots">' . __( '…' ) . '</span>';
3349 if ( $args['prev_next'] && $current && $current < $total ) :
3350 $link = str_replace( '%_%', $args['format'], $args['base'] );
3351 $link = str_replace( '%#%', $current + 1, $link );
3353 $link = add_query_arg( $add_args, $link );
3354 $link .= $args['add_fragment'];
3356 /** This filter is documented in wp-includes/general-template.php */
3357 $page_links[] = '<a class="next page-numbers" href="' . esc_url( apply_filters( 'paginate_links', $link ) ) . '">' . $args['next_text'] . '</a>';
3359 switch ( $args['type'] ) {
3364 $r .= "<ul class='page-numbers'>\n\t<li>";
3365 $r .= join("</li>\n\t<li>", $page_links);
3366 $r .= "</li>\n</ul>\n";
3370 $r = join("\n", $page_links);
3377 * Registers an admin colour scheme css file.
3379 * Allows a plugin to register a new admin colour scheme. For example:
3381 * wp_admin_css_color( 'classic', __( 'Classic' ), admin_url( "css/colors-classic.css" ), array(
3382 * '#07273E', '#14568A', '#D54E21', '#2683AE'
3387 * @global array $_wp_admin_css_colors
3389 * @param string $key The unique key for this theme.
3390 * @param string $name The name of the theme.
3391 * @param string $url The URL of the CSS file containing the color scheme.
3392 * @param array $colors Optional. An array of CSS color definition strings which are used
3393 * to give the user a feel for the theme.
3394 * @param array $icons {
3395 * Optional. CSS color definitions used to color any SVG icons.
3397 * @type string $base SVG icon base color.
3398 * @type string $focus SVG icon color on focus.
3399 * @type string $current SVG icon color of current admin menu link.
3402 function wp_admin_css_color( $key, $name, $url, $colors = array(), $icons = array() ) {
3403 global $_wp_admin_css_colors;
3405 if ( !isset($_wp_admin_css_colors) )
3406 $_wp_admin_css_colors = array();
3408 $_wp_admin_css_colors[$key] = (object) array(
3411 'colors' => $colors,
3412 'icon_colors' => $icons,
3417 * Registers the default Admin color schemes
3421 function register_admin_color_schemes() {
3422 $suffix = is_rtl() ? '-rtl' : '';
3423 $suffix .= SCRIPT_DEBUG ? '' : '.min';
3425 wp_admin_css_color( 'fresh', _x( 'Default', 'admin color scheme' ),
3427 array( '#222', '#333', '#0073aa', '#00a0d2' ),
3428 array( 'base' => '#82878c', 'focus' => '#00a0d2', 'current' => '#fff' )
3431 // Other color schemes are not available when running out of src
3432 if ( false !== strpos( get_bloginfo( 'version' ), '-src' ) ) {
3436 wp_admin_css_color( 'light', _x( 'Light', 'admin color scheme' ),
3437 admin_url( "css/colors/light/colors$suffix.css" ),
3438 array( '#e5e5e5', '#999', '#d64e07', '#04a4cc' ),
3439 array( 'base' => '#999', 'focus' => '#ccc', 'current' => '#ccc' )
3442 wp_admin_css_color( 'blue', _x( 'Blue', 'admin color scheme' ),
3443 admin_url( "css/colors/blue/colors$suffix.css" ),
3444 array( '#096484', '#4796b3', '#52accc', '#74B6CE' ),
3445 array( 'base' => '#e5f8ff', 'focus' => '#fff', 'current' => '#fff' )
3448 wp_admin_css_color( 'midnight', _x( 'Midnight', 'admin color scheme' ),
3449 admin_url( "css/colors/midnight/colors$suffix.css" ),
3450 array( '#25282b', '#363b3f', '#69a8bb', '#e14d43' ),
3451 array( 'base' => '#f1f2f3', 'focus' => '#fff', 'current' => '#fff' )
3454 wp_admin_css_color( 'sunrise', _x( 'Sunrise', 'admin color scheme' ),
3455 admin_url( "css/colors/sunrise/colors$suffix.css" ),
3456 array( '#b43c38', '#cf4944', '#dd823b', '#ccaf0b' ),
3457 array( 'base' => '#f3f1f1', 'focus' => '#fff', 'current' => '#fff' )
3460 wp_admin_css_color( 'ectoplasm', _x( 'Ectoplasm', 'admin color scheme' ),
3461 admin_url( "css/colors/ectoplasm/colors$suffix.css" ),
3462 array( '#413256', '#523f6d', '#a3b745', '#d46f15' ),
3463 array( 'base' => '#ece6f6', 'focus' => '#fff', 'current' => '#fff' )
3466 wp_admin_css_color( 'ocean', _x( 'Ocean', 'admin color scheme' ),
3467 admin_url( "css/colors/ocean/colors$suffix.css" ),
3468 array( '#627c83', '#738e96', '#9ebaa0', '#aa9d88' ),
3469 array( 'base' => '#f2fcff', 'focus' => '#fff', 'current' => '#fff' )
3472 wp_admin_css_color( 'coffee', _x( 'Coffee', 'admin color scheme' ),
3473 admin_url( "css/colors/coffee/colors$suffix.css" ),
3474 array( '#46403c', '#59524c', '#c7a589', '#9ea476' ),
3475 array( 'base' => '#f3f2f1', 'focus' => '#fff', 'current' => '#fff' )
3481 * Displays the URL of a WordPress admin CSS file.
3483 * @see WP_Styles::_css_href and its {@see 'style_loader_src'} filter.
3487 * @param string $file file relative to wp-admin/ without its ".css" extension.
3490 function wp_admin_css_uri( $file = 'wp-admin' ) {
3491 if ( defined('WP_INSTALLING') ) {
3492 $_file = "./$file.css";
3494 $_file = admin_url("$file.css");
3496 $_file = add_query_arg( 'version', get_bloginfo( 'version' ), $_file );
3499 * Filters the URI of a WordPress admin CSS file.
3503 * @param string $_file Relative path to the file with query arguments attached.
3504 * @param string $file Relative path to the file, minus its ".css" extension.
3506 return apply_filters( 'wp_admin_css_uri', $_file, $file );
3510 * Enqueues or directly prints a stylesheet link to the specified CSS file.
3512 * "Intelligently" decides to enqueue or to print the CSS file. If the
3513 * {@see 'wp_print_styles'} action has *not* yet been called, the CSS file will be
3514 * enqueued. If the {@see 'wp_print_styles'} action has been called, the CSS link will
3515 * be printed. Printing may be forced by passing true as the $force_echo
3516 * (second) parameter.
3518 * For backward compatibility with WordPress 2.3 calling method: If the $file
3519 * (first) parameter does not correspond to a registered CSS file, we assume
3520 * $file is a file relative to wp-admin/ without its ".css" extension. A
3521 * stylesheet link to that generated URL is printed.
3525 * @param string $file Optional. Style handle name or file name (without ".css" extension) relative
3526 * to wp-admin/. Defaults to 'wp-admin'.
3527 * @param bool $force_echo Optional. Force the stylesheet link to be printed rather than enqueued.
3529 function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
3530 // For backward compatibility
3531 $handle = 0 === strpos( $file, 'css/' ) ? substr( $file, 4 ) : $file;
3533 if ( wp_styles()->query( $handle ) ) {
3534 if ( $force_echo || did_action( 'wp_print_styles' ) ) // we already printed the style queue. Print this one immediately
3535 wp_print_styles( $handle );
3536 else // Add to style queue
3537 wp_enqueue_style( $handle );
3542 * Filters the stylesheet link to the specified CSS file.
3544 * If the site is set to display right-to-left, the RTL stylesheet link
3545 * will be used instead.
3549 * @param string $file Style handle name or filename (without ".css" extension)
3550 * relative to wp-admin/. Defaults to 'wp-admin'.
3552 echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( $file ) ) . "' type='text/css' />\n", $file );
3554 if ( function_exists( 'is_rtl' ) && is_rtl() ) {
3555 /** This filter is documented in wp-includes/general-template.php */
3556 echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( "$file-rtl" ) ) . "' type='text/css' />\n", "$file-rtl" );
3561 * Enqueues the default ThickBox js and css.
3563 * If any of the settings need to be changed, this can be done with another js
3564 * file similar to media-upload.js. That file should
3565 * require array('thickbox') to ensure it is loaded after.
3569 function add_thickbox() {
3570 wp_enqueue_script( 'thickbox' );
3571 wp_enqueue_style( 'thickbox' );
3573 if ( is_network_admin() )
3574 add_action( 'admin_head', '_thickbox_path_admin_subfolder' );
3578 * Displays the XHTML generator that is generated on the wp_head hook.
3580 * See {@see 'wp_head'}.
3584 function wp_generator() {
3586 * Filters the output of the XHTML generator tag.
3590 * @param string $generator_type The XHTML generator.
3592 the_generator( apply_filters( 'wp_generator_type', 'xhtml' ) );
3596 * Display the generator XML or Comment for RSS, ATOM, etc.
3598 * Returns the correct generator type for the requested output format. Allows
3599 * for a plugin to filter generators overall the {@see 'the_generator'} filter.
3603 * @param string $type The type of generator to output - (html|xhtml|atom|rss2|rdf|comment|export).
3605 function the_generator( $type ) {
3607 * Filters the output of the XHTML generator tag for display.
3611 * @param string $generator_type The generator output.
3612 * @param string $type The type of generator to output. Accepts 'html',
3613 * 'xhtml', 'atom', 'rss2', 'rdf', 'comment', 'export'.
3615 echo apply_filters( 'the_generator', get_the_generator($type), $type ) . "\n";
3619 * Creates the generator XML or Comment for RSS, ATOM, etc.
3621 * Returns the correct generator type for the requested output format. Allows
3622 * for a plugin to filter generators on an individual basis using the
3623 * {@see 'get_the_generator_$type'} filter.
3627 * @param string $type The type of generator to return - (html|xhtml|atom|rss2|rdf|comment|export).
3628 * @return string|void The HTML content for the generator.
3630 function get_the_generator( $type = '' ) {
3631 if ( empty( $type ) ) {
3633 $current_filter = current_filter();
3634 if ( empty( $current_filter ) )
3637 switch ( $current_filter ) {
3639 case 'commentsrss2_head' :
3650 case 'comments_atom_head' :
3659 $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '">';
3662 $gen = '<meta name="generator" content="WordPress ' . get_bloginfo( 'version' ) . '" />';
3665 $gen = '<generator uri="https://wordpress.org/" version="' . get_bloginfo_rss( 'version' ) . '">WordPress</generator>';
3668 $gen = '<generator>https://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . '</generator>';
3671 $gen = '<admin:generatorAgent rdf:resource="https://wordpress.org/?v=' . get_bloginfo_rss( 'version' ) . '" />';
3674 $gen = '<!-- generator="WordPress/' . get_bloginfo( 'version' ) . '" -->';
3677 $gen = '<!-- generator="WordPress/' . get_bloginfo_rss('version') . '" created="'. date('Y-m-d H:i') . '" -->';
3682 * Filters the HTML for the retrieved generator type.
3684 * The dynamic portion of the hook name, `$type`, refers to the generator type.
3688 * @param string $gen The HTML markup output to wp_head().
3689 * @param string $type The type of generator. Accepts 'html', 'xhtml', 'atom',
3690 * 'rss2', 'rdf', 'comment', 'export'.
3692 return apply_filters( "get_the_generator_{$type}", $gen, $type );
3696 * Outputs the html checked attribute.
3698 * Compares the first two arguments and if identical marks as checked
3702 * @param mixed $checked One of the values to compare
3703 * @param mixed $current (true) The other value to compare if not just true
3704 * @param bool $echo Whether to echo or just return the string
3705 * @return string html attribute or empty string
3707 function checked( $checked, $current = true, $echo = true ) {
3708 return __checked_selected_helper( $checked, $current, $echo, 'checked' );
3712 * Outputs the html selected attribute.
3714 * Compares the first two arguments and if identical marks as selected
3718 * @param mixed $selected One of the values to compare
3719 * @param mixed $current (true) The other value to compare if not just true
3720 * @param bool $echo Whether to echo or just return the string
3721 * @return string html attribute or empty string
3723 function selected( $selected, $current = true, $echo = true ) {
3724 return __checked_selected_helper( $selected, $current, $echo, 'selected' );
3728 * Outputs the html disabled attribute.
3730 * Compares the first two arguments and if identical marks as disabled
3734 * @param mixed $disabled One of the values to compare
3735 * @param mixed $current (true) The other value to compare if not just true
3736 * @param bool $echo Whether to echo or just return the string
3737 * @return string html attribute or empty string
3739 function disabled( $disabled, $current = true, $echo = true ) {
3740 return __checked_selected_helper( $disabled, $current, $echo, 'disabled' );
3744 * Private helper function for checked, selected, and disabled.
3746 * Compares the first two arguments and if identical marks as $type
3751 * @param mixed $helper One of the values to compare
3752 * @param mixed $current (true) The other value to compare if not just true
3753 * @param bool $echo Whether to echo or just return the string
3754 * @param string $type The type of checked|selected|disabled we are doing
3755 * @return string html attribute or empty string
3757 function __checked_selected_helper( $helper, $current, $echo, $type ) {
3758 if ( (string) $helper === (string) $current )
3759 $result = " $type='$type'";
3770 * Default settings for heartbeat
3772 * Outputs the nonce used in the heartbeat XHR
3776 * @param array $settings
3777 * @return array $settings
3779 function wp_heartbeat_settings( $settings ) {
3781 $settings['ajaxurl'] = admin_url( 'admin-ajax.php', 'relative' );
3783 if ( is_user_logged_in() )
3784 $settings['nonce'] = wp_create_nonce( 'heartbeat-nonce' );