X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/6c8f14c09105d0afa4c1574215c59b5021040e76..refs/tags/wordpress-3.7:/wp-includes/general-template.php diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php index af3d572e..90e19d4b 100644 --- a/wp-includes/general-template.php +++ b/wp-includes/general-template.php @@ -25,7 +25,8 @@ function get_header( $name = null ) { do_action( 'get_header', $name ); $templates = array(); - if ( isset($name) ) + $name = (string) $name; + if ( '' !== $name ) $templates[] = "header-{$name}.php"; $templates[] = 'header.php'; @@ -54,7 +55,8 @@ function get_footer( $name = null ) { do_action( 'get_footer', $name ); $templates = array(); - if ( isset($name) ) + $name = (string) $name; + if ( '' !== $name ) $templates[] = "footer-{$name}.php"; $templates[] = 'footer.php'; @@ -83,7 +85,8 @@ function get_sidebar( $name = null ) { do_action( 'get_sidebar', $name ); $templates = array(); - if ( isset($name) ) + $name = (string) $name; + if ( '' !== $name ) $templates[] = "sidebar-{$name}.php"; $templates[] = 'sidebar.php'; @@ -120,7 +123,8 @@ function get_template_part( $slug, $name = null ) { do_action( "get_template_part_{$slug}", $slug, $name ); $templates = array(); - if ( isset($name) ) + $name = (string) $name; + if ( '' !== $name ) $templates[] = "{$slug}-{$name}.php"; $templates[] = "{$slug}.php"; @@ -141,34 +145,56 @@ function get_template_part( $slug, $name = null ) { * form into the sidebar and also by the search widget in WordPress. * * There is also an action that is called whenever the function is run called, - * 'get_search_form'. This can be useful for outputting JavaScript that the + * 'pre_get_search_form'. This can be useful for outputting JavaScript that the * search relies on or various formatting that applies to the beginning of the * search. To give a few examples of what it can be used for. * * @since 2.7.0 + * @uses apply_filters() Calls 'search_form_format' filter to determine which type to use for the search field. + * If set to 'html5', it changes to search input type and adds placeholder text. + * * @param boolean $echo Default to echo and not return the form. * @return string|null String when retrieving, null when displaying or if searchform.php exists. */ -function get_search_form($echo = true) { - do_action( 'get_search_form' ); +function get_search_form( $echo = true ) { + do_action( 'pre_get_search_form' ); + + $format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml'; + $format = apply_filters( 'search_form_format', $format ); - $search_form_template = locate_template('searchform.php'); + $search_form_template = locate_template( 'searchform.php' ); if ( '' != $search_form_template ) { - require($search_form_template); - return; + ob_start(); + require( $search_form_template ); + $form = ob_get_clean(); + } else { + if ( 'html5' == $format ) { + $form = ''; + } else { + $form = ''; + } } - $form = ''; + $result = apply_filters( 'get_search_form', $form ); + if ( null === $result ) + $result = $form; if ( $echo ) - echo apply_filters('get_search_form', $form); + echo $result; else - return apply_filters('get_search_form', $form); + return $result; } /** @@ -199,12 +225,12 @@ function wp_loginout($redirect = '', $echo = true) { /** * Returns the Log Out URL. * - * Returns the URL that allows the user to log out of the site + * Returns the URL that allows the user to log out of the site. * * @since 2.7.0 - * @uses wp_nonce_url() To protect against CSRF - * @uses site_url() To generate the log in URL - * @uses apply_filters() calls 'logout_url' hook on final logout url + * @uses wp_nonce_url() To protect against CSRF. + * @uses site_url() To generate the log out URL. + * @uses apply_filters() calls 'logout_url' hook on final logout URL. * * @param string $redirect Path to redirect to on logout. * @return string A log out URL. @@ -224,11 +250,11 @@ function wp_logout_url($redirect = '') { /** * Returns the Log In URL. * - * Returns the URL that allows the user to log in to the site + * Returns the URL that allows the user to log in to the site. * * @since 2.7.0 - * @uses site_url() To generate the log in URL - * @uses apply_filters() calls 'login_url' hook on final login url + * @uses site_url() To generate the log in URL. + * @uses apply_filters() calls 'login_url' hook on final login URL. * * @param string $redirect Path to redirect to on login. * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false. @@ -246,6 +272,21 @@ function wp_login_url($redirect = '', $force_reauth = false) { return apply_filters('login_url', $login_url, $redirect); } +/** + * Returns the user registration URL. + * + * Returns the URL that allows the user to register on the site. + * + * @since 3.6.0 + * @uses site_url() To generate the registration URL. + * @uses apply_filters() calls 'register_url' hook on final URL. + * + * @return string + */ +function wp_registration_url() { + return apply_filters( 'register_url', site_url( 'wp-login.php?action=register', 'login' ) ); +} + /** * Provides a simple login form for use anywhere within WordPress. By default, it echoes * the HTML immediately. Pass array('echo'=>false) to return the string instead. @@ -255,21 +296,22 @@ function wp_login_url($redirect = '', $force_reauth = false) { * @return string|null String when retrieving, null when displaying. */ function wp_login_form( $args = array() ) { - $defaults = array( 'echo' => true, - 'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], // Default redirect is back to the current page - 'form_id' => 'loginform', - 'label_username' => __( 'Username' ), - 'label_password' => __( 'Password' ), - 'label_remember' => __( 'Remember Me' ), - 'label_log_in' => __( 'Log In' ), - 'id_username' => 'user_login', - 'id_password' => 'user_pass', - 'id_remember' => 'rememberme', - 'id_submit' => 'wp-submit', - 'remember' => true, - 'value_username' => '', - 'value_remember' => false, // Set this to true to default the "Remember me" checkbox to checked - ); + $defaults = array( + 'echo' => true, + 'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], // Default redirect is back to the current page + 'form_id' => 'loginform', + 'label_username' => __( 'Username' ), + 'label_password' => __( 'Password' ), + 'label_remember' => __( 'Remember Me' ), + 'label_log_in' => __( 'Log In' ), + 'id_username' => 'user_login', + 'id_password' => 'user_pass', + 'id_remember' => 'rememberme', + 'id_submit' => 'wp-submit', + 'remember' => true, + 'value_username' => '', + 'value_remember' => false, // Set this to true to default the "Remember me" checkbox to checked + ); $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) ); $form = ' @@ -338,7 +380,7 @@ function wp_register( $before = '
  • ', $after = '
    • ', $echo = true ) { if ( ! is_user_logged_in() ) { if ( get_option('users_can_register') ) - $link = $before . '' . __('Register') . '' . $after; + $link = $before . '' . __('Register') . '' . $after; else $link = ''; } else { @@ -436,7 +478,7 @@ function get_bloginfo( $show = '', $filter = 'raw' ) { $output = get_feed_link('comments_rss2'); break; case 'pingback_url': - $output = get_option('siteurl') .'/xmlrpc.php'; + $output = site_url( 'xmlrpc.php' ); break; case 'stylesheet_url': $output = get_stylesheet_uri(); @@ -535,6 +577,16 @@ function wp_title($sep = '»', $display = true, $seplocation = '') { $title = single_post_title( '', false ); } + // If there's a post type archive + if ( is_post_type_archive() ) { + $post_type = get_query_var( 'post_type' ); + if ( is_array( $post_type ) ) + $post_type = reset( $post_type ); + $post_type_object = get_post_type_object( $post_type ); + if ( ! $post_type_object->has_archive ) + $title = post_type_archive_title( '', false ); + } + // If there's a category or tag if ( is_category() || is_tag() ) { $title = single_term_title( '', false ); @@ -543,18 +595,21 @@ function wp_title($sep = '»', $display = true, $seplocation = '') { // If there's a taxonomy if ( is_tax() ) { $term = get_queried_object(); - $tax = get_taxonomy( $term->taxonomy ); - $title = single_term_title( $tax->labels->name . $t_sep, false ); + if ( $term ) { + $tax = get_taxonomy( $term->taxonomy ); + $title = single_term_title( $tax->labels->name . $t_sep, false ); + } } // If there's an author if ( is_author() ) { $author = get_queried_object(); - $title = $author->display_name; + if ( $author ) + $title = $author->display_name; } - // If there's a post type archive - if ( is_post_type_archive() ) + // Post type archives with has_archive should override terms. + if ( is_post_type_archive() && $post_type_object->has_archive ) $title = post_type_archive_title( '', false ); // If there's a month @@ -635,7 +690,7 @@ function single_post_title($prefix = '', $display = true) { if ( $display ) echo $prefix . $title; else - return $title; + return $prefix . $title; } /** @@ -654,13 +709,17 @@ function post_type_archive_title( $prefix = '', $display = true ) { if ( ! is_post_type_archive() ) return; - $post_type_obj = get_queried_object(); + $post_type = get_query_var( 'post_type' ); + if ( is_array( $post_type ) ) + $post_type = reset( $post_type ); + + $post_type_obj = get_post_type_object( $post_type ); $title = apply_filters('post_type_archive_title', $post_type_obj->labels->name ); if ( $display ) echo $prefix . $title; else - return $title; + return $prefix . $title; } /** @@ -743,7 +802,7 @@ function single_term_title( $prefix = '', $display = true ) { if ( $display ) echo $prefix . $term_name; else - return $term_name; + return $prefix . $term_name; } /** @@ -824,17 +883,16 @@ function single_month_title($prefix = '', $display = true ) { */ function get_archives_link($url, $text, $format = 'html', $before = '', $after = '') { $text = wptexturize($text); - $title_text = esc_attr($text); $url = esc_url($url); if ('link' == $format) - $link_html = "\t\n"; + $link_html = "\t\n"; elseif ('option' == $format) $link_html = "\t\n"; elseif ('html' == $format) - $link_html = "\t
  • $before$text$after
    • \n"; + $link_html = "\t
  • $before$text$after
    • \n"; else // custom - $link_html = "\t$before$text$after\n"; + $link_html = "\t$before$text$after\n"; $link_html = apply_filters( 'get_archives_link', $link_html ); @@ -912,103 +970,97 @@ function wp_get_archives($args = '') { $archive_week_end_date_format = get_option('date_format'); } - //filters $where = apply_filters( 'getarchives_where', "WHERE post_type = 'post' AND post_status = 'publish'", $r ); $join = apply_filters( 'getarchives_join', '', $r ); $output = ''; + $last_changed = wp_cache_get( 'last_changed', 'posts' ); + if ( ! $last_changed ) { + $last_changed = microtime(); + wp_cache_set( 'last_changed', $last_changed, 'posts' ); + } + if ( 'monthly' == $type ) { $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date) ORDER BY post_date $order $limit"; - $key = md5($query); - $cache = wp_cache_get( 'wp_get_archives' , 'general'); - if ( !isset( $cache[ $key ] ) ) { - $arcresults = $wpdb->get_results($query); - $cache[ $key ] = $arcresults; - wp_cache_set( 'wp_get_archives', $cache, 'general' ); - } else { - $arcresults = $cache[ $key ]; + $key = md5( $query ); + $key = "wp_get_archives:$key:$last_changed"; + if ( ! $results = wp_cache_get( $key, 'posts' ) ) { + $results = $wpdb->get_results( $query ); + wp_cache_set( $key, $results, 'posts' ); } - if ( $arcresults ) { + if ( $results ) { $afterafter = $after; - foreach ( (array) $arcresults as $arcresult ) { - $url = get_month_link( $arcresult->year, $arcresult->month ); + foreach ( (array) $results as $result ) { + $url = get_month_link( $result->year, $result->month ); /* translators: 1: month name, 2: 4-digit year */ - $text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($arcresult->month), $arcresult->year); + $text = sprintf(__('%1$s %2$d'), $wp_locale->get_month($result->month), $result->year); if ( $show_post_count ) - $after = ' ('.$arcresult->posts.')' . $afterafter; + $after = ' ('.$result->posts.')' . $afterafter; $output .= get_archives_link($url, $text, $format, $before, $after); } } } elseif ('yearly' == $type) { $query = "SELECT YEAR(post_date) AS `year`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date) ORDER BY post_date $order $limit"; - $key = md5($query); - $cache = wp_cache_get( 'wp_get_archives' , 'general'); - if ( !isset( $cache[ $key ] ) ) { - $arcresults = $wpdb->get_results($query); - $cache[ $key ] = $arcresults; - wp_cache_set( 'wp_get_archives', $cache, 'general' ); - } else { - $arcresults = $cache[ $key ]; + $key = md5( $query ); + $key = "wp_get_archives:$key:$last_changed"; + if ( ! $results = wp_cache_get( $key, 'posts' ) ) { + $results = $wpdb->get_results( $query ); + wp_cache_set( $key, $results, 'posts' ); } - if ($arcresults) { + if ( $results ) { $afterafter = $after; - foreach ( (array) $arcresults as $arcresult) { - $url = get_year_link($arcresult->year); - $text = sprintf('%d', $arcresult->year); + foreach ( (array) $results as $result) { + $url = get_year_link($result->year); + $text = sprintf('%d', $result->year); if ($show_post_count) - $after = ' ('.$arcresult->posts.')' . $afterafter; + $after = ' ('.$result->posts.')' . $afterafter; $output .= get_archives_link($url, $text, $format, $before, $after); } } } elseif ( 'daily' == $type ) { $query = "SELECT YEAR(post_date) AS `year`, MONTH(post_date) AS `month`, DAYOFMONTH(post_date) AS `dayofmonth`, count(ID) as posts FROM $wpdb->posts $join $where GROUP BY YEAR(post_date), MONTH(post_date), DAYOFMONTH(post_date) ORDER BY post_date $order $limit"; - $key = md5($query); - $cache = wp_cache_get( 'wp_get_archives' , 'general'); - if ( !isset( $cache[ $key ] ) ) { - $arcresults = $wpdb->get_results($query); - $cache[ $key ] = $arcresults; - wp_cache_set( 'wp_get_archives', $cache, 'general' ); - } else { - $arcresults = $cache[ $key ]; + $key = md5( $query ); + $key = "wp_get_archives:$key:$last_changed"; + if ( ! $results = wp_cache_get( $key, 'posts' ) ) { + $results = $wpdb->get_results( $query ); + $cache[ $key ] = $results; + wp_cache_set( $key, $results, 'posts' ); } - if ( $arcresults ) { + if ( $results ) { $afterafter = $after; - foreach ( (array) $arcresults as $arcresult ) { - $url = get_day_link($arcresult->year, $arcresult->month, $arcresult->dayofmonth); - $date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $arcresult->year, $arcresult->month, $arcresult->dayofmonth); + foreach ( (array) $results as $result ) { + $url = get_day_link($result->year, $result->month, $result->dayofmonth); + $date = sprintf('%1$d-%2$02d-%3$02d 00:00:00', $result->year, $result->month, $result->dayofmonth); $text = mysql2date($archive_day_date_format, $date); if ($show_post_count) - $after = ' ('.$arcresult->posts.')'.$afterafter; + $after = ' ('.$result->posts.')'.$afterafter; $output .= get_archives_link($url, $text, $format, $before, $after); } } } elseif ( 'weekly' == $type ) { $week = _wp_mysql_week( '`post_date`' ); $query = "SELECT DISTINCT $week AS `week`, YEAR( `post_date` ) AS `yr`, DATE_FORMAT( `post_date`, '%Y-%m-%d' ) AS `yyyymmdd`, count( `ID` ) AS `posts` FROM `$wpdb->posts` $join $where GROUP BY $week, YEAR( `post_date` ) ORDER BY `post_date` $order $limit"; - $key = md5($query); - $cache = wp_cache_get( 'wp_get_archives' , 'general'); - if ( !isset( $cache[ $key ] ) ) { - $arcresults = $wpdb->get_results($query); - $cache[ $key ] = $arcresults; - wp_cache_set( 'wp_get_archives', $cache, 'general' ); - } else { - $arcresults = $cache[ $key ]; + $key = md5( $query ); + $key = "wp_get_archives:$key:$last_changed"; + if ( ! $results = wp_cache_get( $key, 'posts' ) ) { + $results = $wpdb->get_results( $query ); + wp_cache_set( $key, $results, 'posts' ); } $arc_w_last = ''; $afterafter = $after; - if ( $arcresults ) { - foreach ( (array) $arcresults as $arcresult ) { - if ( $arcresult->week != $arc_w_last ) { - $arc_year = $arcresult->yr; - $arc_w_last = $arcresult->week; - $arc_week = get_weekstartend($arcresult->yyyymmdd, get_option('start_of_week')); + if ( $results ) { + foreach ( (array) $results as $result ) { + if ( $result->week != $arc_w_last ) { + $arc_year = $result->yr; + $arc_w_last = $result->week; + $arc_week = get_weekstartend($result->yyyymmdd, get_option('start_of_week')); $arc_week_start = date_i18n($archive_week_start_date_format, $arc_week['start']); $arc_week_end = date_i18n($archive_week_end_date_format, $arc_week['end']); - $url = sprintf('%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&', '=', $arcresult->week); + $url = sprintf('%1$s/%2$s%3$sm%4$s%5$s%6$sw%7$s%8$d', home_url(), '', '?', '=', $arc_year, '&', '=', $result->week); $text = $arc_week_start . $archive_week_separator . $arc_week_end; if ($show_post_count) - $after = ' ('.$arcresult->posts.')'.$afterafter; + $after = ' ('.$result->posts.')'.$afterafter; $output .= get_archives_link($url, $text, $format, $before, $after); } } @@ -1016,23 +1068,22 @@ function wp_get_archives($args = '') { } elseif ( ( 'postbypost' == $type ) || ('alpha' == $type) ) { $orderby = ('alpha' == $type) ? 'post_title ASC ' : 'post_date DESC '; $query = "SELECT * FROM $wpdb->posts $join $where ORDER BY $orderby $limit"; - $key = md5($query); - $cache = wp_cache_get( 'wp_get_archives' , 'general'); - if ( !isset( $cache[ $key ] ) ) { - $arcresults = $wpdb->get_results($query); - $cache[ $key ] = $arcresults; - wp_cache_set( 'wp_get_archives', $cache, 'general' ); - } else { - $arcresults = $cache[ $key ]; + $key = md5( $query ); + $key = "wp_get_archives:$key:$last_changed"; + if ( ! $results = wp_cache_get( $key, 'posts' ) ) { + $results = $wpdb->get_results( $query ); + wp_cache_set( $key, $results, 'posts' ); } - if ( $arcresults ) { - foreach ( (array) $arcresults as $arcresult ) { - if ( $arcresult->post_date != '0000-00-00 00:00:00' ) { - $url = get_permalink( $arcresult ); - if ( $arcresult->post_title ) - $text = strip_tags( apply_filters( 'the_title', $arcresult->post_title, $arcresult->ID ) ); - else - $text = $arcresult->ID; + if ( $results ) { + foreach ( (array) $results as $result ) { + if ( $result->post_date != '0000-00-00 00:00:00' ) { + $url = get_permalink( $result ); + if ( $result->post_title ) { + /** This filter is documented in wp-includes/post-template.php */ + $text = strip_tags( apply_filters( 'the_title', $result->post_title, $result->ID ) ); + } else { + $text = $result->ID; + } $output .= get_archives_link($url, $text, $format, $before, $after); } } @@ -1217,6 +1268,7 @@ function get_calendar($initial = true, $echo = true) { if ( $ak_post_titles ) { foreach ( (array) $ak_post_titles as $ak_post_title ) { + /** This filter is documented in wp-includes/post-template.php */ $post_title = esc_attr( apply_filters( 'the_title', $ak_post_title->post_title, $ak_post_title->ID ) ); if ( empty($ak_titles_for_day['day_'.$ak_post_title->dom]) ) @@ -1552,7 +1604,7 @@ function the_weekday() { * @param string $after Optional Output after the date. */ function the_weekday_date($before='',$after='') { - global $wp_locale, $day, $previousweekday; + global $wp_locale, $currentday, $previousweekday; $the_weekday_date = ''; if ( $currentday != $previousweekday ) { $the_weekday_date .= $before; @@ -1600,14 +1652,14 @@ function feed_links( $args = array() ) { 'separator' => _x('»', 'feed link'), /* translators: 1: blog title, 2: separator (raquo) */ 'feedtitle' => __('%1$s %2$s Feed'), - /* translators: %s: blog title, 2: separator (raquo) */ + /* translators: 1: blog title, 2: separator (raquo) */ 'comstitle' => __('%1$s %2$s Comments Feed'), ); $args = wp_parse_args( $args, $defaults ); - echo '\n"; - echo '\n"; + echo '\n"; + echo '\n"; } /** @@ -1637,7 +1689,7 @@ function feed_links_extra( $args = array() ) { $args = wp_parse_args( $args, $defaults ); - if ( is_single() || is_page() ) { + if ( is_singular() ) { $id = 0; $post = get_post( $id ); @@ -1645,16 +1697,28 @@ function feed_links_extra( $args = array() ) { $title = sprintf( $args['singletitle'], get_bloginfo('name'), $args['separator'], esc_html( get_the_title() ) ); $href = get_post_comments_feed_link( $post->ID ); } + } elseif ( is_post_type_archive() ) { + $post_type = get_query_var( 'post_type' ); + if ( is_array( $post_type ) ) + $post_type = reset( $post_type ); + + $post_type_obj = get_post_type_object( $post_type ); + $title = sprintf( $args['posttypetitle'], get_bloginfo( 'name' ), $args['separator'], $post_type_obj->labels->name ); + $href = get_post_type_archive_feed_link( $post_type_obj->name ); } elseif ( is_category() ) { $term = get_queried_object(); - $title = sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], $term->name ); - $href = get_category_feed_link( $term->term_id ); + if ( $term ) { + $title = sprintf( $args['cattitle'], get_bloginfo('name'), $args['separator'], $term->name ); + $href = get_category_feed_link( $term->term_id ); + } } elseif ( is_tag() ) { $term = get_queried_object(); - $title = sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $term->name ); - $href = get_tag_feed_link( $term->term_id ); + if ( $term ) { + $title = sprintf( $args['tagtitle'], get_bloginfo('name'), $args['separator'], $term->name ); + $href = get_tag_feed_link( $term->term_id ); + } } elseif ( is_author() ) { $author_id = intval( get_query_var('author') ); @@ -1665,7 +1729,9 @@ function feed_links_extra( $args = array() ) { $href = get_search_feed_link(); } elseif ( is_post_type_archive() ) { $title = sprintf( $args['posttypetitle'], get_bloginfo('name'), $args['separator'], post_type_archive_title( '', false ) ); - $href = get_post_type_archive_feed_link( get_queried_object()->name ); + $post_type_obj = get_queried_object(); + if ( $post_type_obj ) + $href = get_post_type_archive_feed_link( $post_type_obj->name ); } if ( isset($title) && isset($href) ) @@ -2284,3 +2350,23 @@ function __checked_selected_helper( $helper, $current, $echo, $type ) { return $result; } + +/** + * Default settings for heartbeat + * + * Outputs the nonce used in the heartbeat XHR + * + * @since 3.6.0 + * + * @param array $settings + * @return array $settings + */ +function wp_heartbeat_settings( $settings ) { + if ( ! is_admin() ) + $settings['ajaxurl'] = admin_url( 'admin-ajax.php', 'relative' ); + + if ( is_user_logged_in() ) + $settings['nonce'] = wp_create_nonce( 'heartbeat-nonce' ); + + return $settings; +}