X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/699231ae09f7057a4d0000cdf32e50a3df6a04ca..256a3b381f63716209b3527d0a14442ae570c283:/wp-includes/general-template.php
diff --git a/wp-includes/general-template.php b/wp-includes/general-template.php
index b3712425..7a83579c 100644
--- a/wp-includes/general-template.php
+++ b/wp-includes/general-template.php
@@ -25,14 +25,15 @@ 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";
+ $templates[] = 'header.php';
// Backward compat code will be removed in a future release
if ('' == locate_template($templates, true))
- load_template( WPINC . '/theme-compat/header.php');
+ load_template( ABSPATH . WPINC . '/theme-compat/header.php');
}
/**
@@ -54,14 +55,15 @@ 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";
+ $templates[] = 'footer.php';
// Backward compat code will be removed in a future release
if ('' == locate_template($templates, true))
- load_template( WPINC . '/theme-compat/footer.php');
+ load_template( ABSPATH . WPINC . '/theme-compat/footer.php');
}
/**
@@ -83,14 +85,15 @@ 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";
+ $templates[] = 'sidebar.php';
// Backward compat code will be removed in a future release
if ('' == locate_template($templates, true))
- load_template( WPINC . '/theme-compat/sidebar.php');
+ load_template( ABSPATH . WPINC . '/theme-compat/sidebar.php');
}
/**
@@ -106,12 +109,12 @@ function get_sidebar( $name = null ) {
* The template is included using require, not require_once, so you may include the
* same template part multiple times.
*
- * For the parameter, if the file is called "{slug}-special.php" then specify
+ * For the $name parameter, if the file is called "{slug}-special.php" then specify
* "special".
*
* @uses locate_template()
* @since 3.0.0
- * @uses do_action() Calls 'get_template_part{$slug}' action.
+ * @uses do_action() Calls 'get_template_part_{$slug}' action.
*
* @param string $slug The slug name for the generic template.
* @param string $name The name of the specialised template.
@@ -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,33 +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(array('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;
}
/**
@@ -181,6 +208,7 @@ function get_search_form($echo = true) {
*
* @param string $redirect Optional path to redirect to on login/logout.
* @param boolean $echo Default to echo and not return the link.
+ * @return string|null String when retrieving, null when displaying.
*/
function wp_loginout($redirect = '', $echo = true) {
if ( ! is_user_logged_in() )
@@ -197,14 +225,15 @@ 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
- * @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
+ * @since 2.7.0
+ * @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.
*/
function wp_logout_url($redirect = '') {
$args = array( 'action' => 'logout' );
@@ -221,15 +250,15 @@ 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
- * @uses site_url() To generate the log in URL
- * @uses apply_filters() calls 'login_url' hook on final login url
+ * @since 2.7.0
+ * @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.
- * @return string A log in url
+ * @return string A log in URL.
*/
function wp_login_url($redirect = '', $force_reauth = false) {
$login_url = site_url('wp-login.php', 'login');
@@ -243,50 +272,66 @@ 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.
*
* @since 3.0.0
- * @param array $args Configuration options to modify the form output
- * @return Void, or string containing the form
+ * @param array $args Configuration options to modify the form output.
+ * @return string|null String when retrieving, null when displaying.
*/
function wp_login_form( $args = array() ) {
- $defaults = array( 'echo' => true,
- 'redirect' => site_url( $_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 = '
- ';
if ( $args['echo'] )
@@ -305,15 +350,16 @@ function wp_login_form( $args = array() ) {
* @uses apply_filters() calls 'lostpassword_url' hook on the lostpassword url
*
* @param string $redirect Path to redirect to on login.
+ * @return string Lost password URL.
*/
-function wp_lostpassword_url($redirect = '') {
+function wp_lostpassword_url( $redirect = '' ) {
$args = array( 'action' => 'lostpassword' );
if ( !empty($redirect) ) {
$args['redirect_to'] = $redirect;
}
- $lostpassword_url = add_query_arg($args, site_url('wp-login.php', 'login'));
- return apply_filters('lostpassword_url', $lostpassword_url, $redirect);
+ $lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') );
+ return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );
}
/**
@@ -328,12 +374,13 @@ function wp_lostpassword_url($redirect = '') {
* @param string $before Text to output before the link (defaults to
).
* @param string $after Text to output after the link (defaults to
).
* @param boolean $echo Default to echo and not return the link.
+ * @return string|null String when retrieving, null when displaying.
*/
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 {
@@ -381,7 +428,7 @@ function bloginfo( $show='' ) {
*
* The possible values for the 'show' parameter are listed below.
*
- *
url - Blog URI to homepage.
+ *
url - Blog URI to homepage.
*
wpurl - Blog URI path to WordPress.
*
description - Secondary title
*
@@ -431,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();
@@ -514,13 +561,8 @@ function get_bloginfo( $show = '', $filter = 'raw' ) {
* @return string|null String on retrieve, null when displaying.
*/
function wp_title($sep = '»', $display = true, $seplocation = '') {
- global $wpdb, $wp_locale, $wp_query;
+ global $wpdb, $wp_locale;
- $cat = get_query_var('cat');
- $tag = get_query_var('tag_id');
- $category_name = get_query_var('category_name');
- $author = get_query_var('author');
- $author_name = get_query_var('author_name');
$m = get_query_var('m');
$year = get_query_var('year');
$monthnum = get_query_var('monthnum');
@@ -530,51 +572,56 @@ function wp_title($sep = '»', $display = true, $seplocation = '') {
$t_sep = '%WP_TITILE_SEP%'; // Temporary separator, for accurate flipping, if necessary
- // If there's a category
- if ( !empty($cat) ) {
- // category exclusion
- if ( !stristr($cat,'-') )
- $title = apply_filters('single_cat_title', get_the_category_by_ID($cat));
- } elseif ( !empty($category_name) ) {
- if ( stristr($category_name,'/') ) {
- $category_name = explode('/',$category_name);
- if ( $category_name[count($category_name)-1] )
- $category_name = $category_name[count($category_name)-1]; // no trailing slash
- else
- $category_name = $category_name[count($category_name)-2]; // there was a trailling slash
- }
- $cat = get_term_by('slug', $category_name, 'category', OBJECT, 'display');
- if ( $cat )
- $title = apply_filters('single_cat_title', $cat->name);
+ // If there is a post
+ if ( is_single() || ( is_home() && !is_front_page() ) || ( is_page() && !is_front_page() ) ) {
+ $title = single_post_title( '', false );
}
- if ( !empty($tag) ) {
- $tag = get_term($tag, 'post_tag', OBJECT, 'display');
- if ( is_wp_error( $tag ) )
- return $tag;
- if ( ! empty($tag->name) )
- $title = apply_filters('single_tag_title', $tag->name);
+ // 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 an author
- if ( !empty($author) ) {
- $title = get_userdata($author);
- $title = $title->display_name;
+ // If there's a category or tag
+ if ( is_category() || is_tag() ) {
+ $title = single_term_title( '', false );
}
- if ( !empty($author_name) ) {
- // We do a direct query here because we don't cache by nicename.
- $title = $wpdb->get_var($wpdb->prepare("SELECT display_name FROM $wpdb->users WHERE user_nicename = %s", $author_name));
+
+ // If there's a taxonomy
+ if ( is_tax() ) {
+ $term = get_queried_object();
+ 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();
+ if ( $author )
+ $title = $author->display_name;
+ }
+
+ // Post type archives with has_archive should override terms.
+ if ( is_post_type_archive() && $post_type_object->has_archive )
+ $title = post_type_archive_title( '', false );
+
// If there's a month
- if ( !empty($m) ) {
+ if ( is_archive() && !empty($m) ) {
$my_year = substr($m, 0, 4);
$my_month = $wp_locale->get_month(substr($m, 4, 2));
$my_day = intval(substr($m, 6, 2));
- $title = $my_year . ($my_month ? $t_sep . $my_month : "") . ($my_day ? $t_sep . $my_day : "");
+ $title = $my_year . ( $my_month ? $t_sep . $my_month : '' ) . ( $my_day ? $t_sep . $my_day : '' );
}
- if ( !empty($year) ) {
+ // If there's a year
+ if ( is_archive() && !empty($year) ) {
$title = $year;
if ( !empty($monthnum) )
$title .= $t_sep . $wp_locale->get_month($monthnum);
@@ -582,27 +629,13 @@ function wp_title($sep = '»', $display = true, $seplocation = '') {
$title .= $t_sep . zeroise($day, 2);
}
- // If there is a post
- if ( is_single() || ( is_home() && !is_front_page() ) || ( is_page() && !is_front_page() ) ) {
- $post = $wp_query->get_queried_object();
- $title = apply_filters( 'single_post_title', $post->post_title );
- }
-
- // If there's a taxonomy
- if ( is_tax() ) {
- $taxonomy = get_query_var( 'taxonomy' );
- $tax = get_taxonomy( $taxonomy );
- $term = $wp_query->get_queried_object();
- $term = $term->name;
- $title = $tax->labels->name . $t_sep . $term;
- }
-
- //If it's a search
+ // If it's a search
if ( is_search() ) {
/* translators: 1: separator, 2: search phrase */
$title = sprintf(__('Search Results %1$s %2$s'), $t_sep, strip_tags($search));
}
+ // If it's a 404 page
if ( is_404() ) {
$title = __('Page not found');
}
@@ -635,7 +668,6 @@ function wp_title($sep = '»', $display = true, $seplocation = '') {
* Display or retrieve page title for post.
*
* This is optimized for single.php template file for displaying the post title.
- * Only useful for posts, does not support pages for example.
*
* It does not support placing the separator after the title, but by leaving the
* prefix parameter empty, you can set the title separator manually. The prefix
@@ -643,19 +675,13 @@ function wp_title($sep = '»', $display = true, $seplocation = '') {
* be a space, the parameter value will need to have it at the end.
*
* @since 0.71
- * @uses $wpdb
*
* @param string $prefix Optional. What to display before the title.
* @param bool $display Optional, default is true. Whether to display or retrieve title.
* @return string|null Title when retrieving, null when displaying or failure.
*/
function single_post_title($prefix = '', $display = true) {
- global $wp_query, $post;
-
- if ( ! $post )
- $_post = $wp_query->get_queried_object();
- else
- $_post = $post;
+ $_post = get_queried_object();
if ( !isset($_post->post_title) )
return;
@@ -664,7 +690,44 @@ function single_post_title($prefix = '', $display = true) {
if ( $display )
echo $prefix . $title;
else
- return $title;
+ return $prefix . $title;
+}
+
+/**
+ * Display or retrieve title for a post type archive.
+ *
+ * This is optimized for archive.php and archive-{$post_type}.php template files
+ * for displaying the title of the post type.
+ *
+ * @since 3.1.0
+ *
+ * @param string $prefix Optional. What to display before the title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
+ * @return string|null Title when retrieving, null when displaying or failure.
+ */
+function post_type_archive_title( $prefix = '', $display = true ) {
+ if ( ! is_post_type_archive() )
+ return;
+
+ $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 );
+ /**
+ * Filter the post type archive title.
+ *
+ * @since 3.1.0
+ *
+ * @param string $post_type_name Post type 'name' label.
+ * @param string $post_type Post type.
+ */
+ $title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );
+
+ if ( $display )
+ echo $prefix . $title;
+ else
+ return $prefix . $title;
}
/**
@@ -684,23 +747,8 @@ function single_post_title($prefix = '', $display = true) {
* @param bool $display Optional, default is true. Whether to display or retrieve title.
* @return string|null Title when retrieving, null when displaying or failure.
*/
-function single_cat_title($prefix = '', $display = true ) {
- global $wp_query;
-
- if ( is_tag() )
- return single_tag_title($prefix, $display);
-
- if ( !is_category() )
- return;
-
- $cat = $wp_query->get_queried_object();
- $my_cat_name = apply_filters('single_cat_title', $cat->name);
- if ( !empty($my_cat_name) ) {
- if ( $display )
- echo $prefix . $my_cat_name;
- else
- return $my_cat_name;
- }
+function single_cat_title( $prefix = '', $display = true ) {
+ return single_term_title( $prefix, $display );
}
/**
@@ -720,23 +768,49 @@ function single_cat_title($prefix = '', $display = true ) {
* @param bool $display Optional, default is true. Whether to display or retrieve title.
* @return string|null Title when retrieving, null when displaying or failure.
*/
-function single_tag_title($prefix = '', $display = true ) {
- global $wp_query;
- if ( !is_tag() )
+function single_tag_title( $prefix = '', $display = true ) {
+ return single_term_title( $prefix, $display );
+}
+
+/**
+ * Display or retrieve page title for taxonomy term archive.
+ *
+ * Useful for taxonomy term template files for displaying the taxonomy term page title.
+ * It has less overhead than {@link wp_title()}, because of its limited implementation.
+ *
+ * It does not support placing the separator after the title, but by leaving the
+ * prefix parameter empty, you can set the title separator manually. The prefix
+ * does not automatically place a space between the prefix, so if there should
+ * be a space, the parameter value will need to have it at the end.
+ *
+ * @since 3.1.0
+ *
+ * @param string $prefix Optional. What to display before the title.
+ * @param bool $display Optional, default is true. Whether to display or retrieve title.
+ * @return string|null Title when retrieving, null when displaying or failure.
+ */
+function single_term_title( $prefix = '', $display = true ) {
+ $term = get_queried_object();
+
+ if ( !$term )
return;
- $tag = $wp_query->get_queried_object();
+ if ( is_category() )
+ $term_name = apply_filters( 'single_cat_title', $term->name );
+ elseif ( is_tag() )
+ $term_name = apply_filters( 'single_tag_title', $term->name );
+ elseif ( is_tax() )
+ $term_name = apply_filters( 'single_term_title', $term->name );
+ else
+ return;
- if ( ! $tag )
+ if ( empty( $term_name ) )
return;
- $my_tag_name = apply_filters('single_tag_title', $tag->name);
- if ( !empty($my_tag_name) ) {
- if ( $display )
- echo $prefix . $my_tag_name;
- else
- return $my_tag_name;
- }
+ if ( $display )
+ echo $prefix . $term_name;
+ else
+ return $prefix . $term_name;
}
/**
@@ -817,19 +891,18 @@ 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