<?php

/**

 * General template tags that can go anywhere in a template.

 *

 * @package WordPress

 * @subpackage Template

 */

/**

 * Load header template.

 *

 * Includes the header template for a theme or if a name is specified then a

 * specialised header will be included.

 *

 * For the parameter, if the file is called "header-special.php" then specify

 * "special".

 *

 * @uses locate_template()

 * @since 1.5.0

 * @uses do_action() Calls 'get_header' action.

 *

 * @param string $name The name of the specialised header.

 */

function get_header( $name = null ) {

	do_action( 'get_header', $name );

	$templates = array();

	$name = (string) $name;

	if ( '' !== $name )

		$templates[] = "header-{$name}.php";

	$templates[] = 'header.php';

	// Backward compat code will be removed in a future release

	if ('' == locate_template($templates, true))

		load_template( ABSPATH . WPINC . '/theme-compat/header.php');

}

/**

 * Load footer template.

 *

 * Includes the footer template for a theme or if a name is specified then a

 * specialised footer will be included.

 *

 * For the parameter, if the file is called "footer-special.php" then specify

 * "special".

 *

 * @uses locate_template()

 * @since 1.5.0

 * @uses do_action() Calls 'get_footer' action.

 *

 * @param string $name The name of the specialised footer.

 */

function get_footer( $name = null ) {

	do_action( 'get_footer', $name );

	$templates = array();

	$name = (string) $name;

	if ( '' !== $name )

		$templates[] = "footer-{$name}.php";

	$templates[] = 'footer.php';

	// Backward compat code will be removed in a future release

	if ('' == locate_template($templates, true))

		load_template( ABSPATH . WPINC . '/theme-compat/footer.php');

}

/**

 * Load sidebar template.

 *

 * Includes the sidebar template for a theme or if a name is specified then a

 * specialised sidebar will be included.

 *

 * For the parameter, if the file is called "sidebar-special.php" then specify

 * "special".

 *

 * @uses locate_template()

 * @since 1.5.0

 * @uses do_action() Calls 'get_sidebar' action.

 *

 * @param string $name The name of the specialised sidebar.

 */

function get_sidebar( $name = null ) {

	do_action( 'get_sidebar', $name );

	$templates = array();

	$name = (string) $name;

	if ( '' !== $name )

		$templates[] = "sidebar-{$name}.php";

	$templates[] = 'sidebar.php';

	// Backward compat code will be removed in a future release

	if ('' == locate_template($templates, true))

		load_template( ABSPATH . WPINC . '/theme-compat/sidebar.php');

}

/**

 * Load a template part into a template

 *

 * Makes it easy for a theme to reuse sections of code in a easy to overload way

 * for child themes.

 *

 * Includes the named template part for a theme or if a name is specified then a

 * specialised part will be included. If the theme contains no {slug}.php file

 * then no template will be included.

 *

 * The template is included using require, not require_once, so you may include the

 * same template part multiple times.

 *

 * 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.

 *

 * @param string $slug The slug name for the generic template.

 * @param string $name The name of the specialised template.

 */

function get_template_part( $slug, $name = null ) {

	do_action( "get_template_part_{$slug}", $slug, $name );

	$templates = array();

	$name = (string) $name;

	if ( '' !== $name )

		$templates[] = "{$slug}-{$name}.php";

	$templates[] = "{$slug}.php";

	locate_template($templates, true, false);

}

/**

 * Display search form.

 *

 * Will first attempt to locate the searchform.php file in either the child or

 * the parent, then load it. If it doesn't exist, then the default search form

 * will be displayed. The default search form is HTML, which will be displayed.

 * There is a filter applied to the search form HTML in order to edit or replace

 * it. The filter is 'get_search_form'.

 *

 * This function is primarily used by themes which want to hardcode the search

 * form into the sidebar and also by the search widget in WordPress.

 *

 * There is also an action that is called whenever the function is run called,

 * 'pre_get_search_form'. This can be useful for outputting JavaScript that the

 * 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( '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' );

	if ( '' != $search_form_template ) {

		ob_start();

		require( $search_form_template );

		$form = ob_get_clean();

	} else {

		if ( 'html5' == $format ) {

			$form = '<form role="search" method="get" class="search-form" action="' . esc_url( home_url( '/' ) ) . '">

				<label>

					<span class="screen-reader-text">' . _x( 'Search for:', 'label' ) . '</span>

					<input type="search" class="search-field" placeholder="' . esc_attr_x( 'Search &hellip;', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" title="' . esc_attr_x( 'Search for:', 'label' ) . '" />

				</label>

				<input type="submit" class="search-submit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />

			</form>';

		} else {

			$form = '<form role="search" method="get" id="searchform" class="searchform" action="' . esc_url( home_url( '/' ) ) . '">

				<div>

					<label class="screen-reader-text" for="s">' . _x( 'Search for:', 'label' ) . '</label>

					<input type="text" value="' . get_search_query() . '" name="s" id="s" />

					<input type="submit" id="searchsubmit" value="'. esc_attr_x( 'Search', 'submit button' ) .'" />

				</div>

			</form>';

		}

	}

	$result = apply_filters( 'get_search_form', $form );

	if ( null === $result )

		$result = $form;

	if ( $echo )

		echo $result;

	else

		return $result;

}

/**

 * Display the Log In/Out link.

 *

 * Displays a link, which allows users to navigate to the Log In page to log in

 * or log out depending on whether they are currently logged in.

 *

 * @since 1.5.0

 * @uses apply_filters() Calls 'loginout' hook on HTML link content.

 *

 * @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() )

		$link = '<a href="' . esc_url( wp_login_url($redirect) ) . '">' . __('Log in') . '</a>';

	else

		$link = '<a href="' . esc_url( wp_logout_url($redirect) ) . '">' . __('Log out') . '</a>';

	if ( $echo )

		echo apply_filters('loginout', $link);

	else

		return apply_filters('loginout', $link);

}

/**

 * Returns the Log Out URL.

 *

 * 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 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' );

	if ( !empty($redirect) ) {

		$args['redirect_to'] = urlencode( $redirect );

	}

	$logout_url = add_query_arg($args, site_url('wp-login.php', 'login'));

	$logout_url = wp_nonce_url( $logout_url, 'log-out' );

	return apply_filters('logout_url', $logout_url, $redirect);

}

/**

 * Returns the Log In URL.

 *

 * Returns the URL that allows the user to log in to the site.

 *

 * @since 2.7.0

 * @uses site_url() To generate the log in URL.

 * @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.

 */

function wp_login_url($redirect = '', $force_reauth = false) {

	$login_url = site_url('wp-login.php', 'login');

	if ( !empty($redirect) )

		$login_url = add_query_arg('redirect_to', urlencode($redirect), $login_url);

	if ( $force_reauth )

		$login_url = add_query_arg('reauth', '1', $login_url);

	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 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

	);

	$args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );

	$form = '

		<form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . esc_url( site_url( 'wp-login.php', 'login_post' ) ) . '" method="post">

			' . apply_filters( 'login_form_top', '', $args ) . '

			<p class="login-username">

				<label for="' . esc_attr( $args['id_username'] ) . '">' . esc_html( $args['label_username'] ) . '</label>

				<input type="text" name="log" id="' . esc_attr( $args['id_username'] ) . '" class="input" value="' . esc_attr( $args['value_username'] ) . '" size="20" />

			</p>

			<p class="login-password">

				<label for="' . esc_attr( $args['id_password'] ) . '">' . esc_html( $args['label_password'] ) . '</label>

				<input type="password" name="pwd" id="' . esc_attr( $args['id_password'] ) . '" class="input" value="" size="20" />

			</p>

			' . apply_filters( 'login_form_middle', '', $args ) . '

			' . ( $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>' : '' ) . '

			<p class="login-submit">

				<input type="submit" name="wp-submit" id="' . esc_attr( $args['id_submit'] ) . '" class="button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" />

				<input type="hidden" name="redirect_to" value="' . esc_url( $args['redirect'] ) . '" />

			</p>

			' . apply_filters( 'login_form_bottom', '', $args ) . '

		</form>';

	if ( $args['echo'] )

		echo $form;

	else

		return $form;

}

/**

 * Returns the Lost Password URL.

 *

 * Returns the URL that allows the user to retrieve the lost password

 *

 * @since 2.8.0

 * @uses site_url() To generate the lost password URL

 * @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 = '' ) {

	$args = array( 'action' => 'lostpassword' );

	if ( !empty($redirect) ) {

		$args['redirect_to'] = $redirect;

	}

	$lostpassword_url = add_query_arg( $args, network_site_url('wp-login.php', 'login') );

	return apply_filters( 'lostpassword_url', $lostpassword_url, $redirect );

}

/**

 * Display the Registration or Admin link.

 *

 * Display a link which allows the user to navigate to the registration page if

 * not logged in and registration is enabled or to the dashboard if logged in.

 *

 * @since 1.5.0

 * @uses apply_filters() Calls 'register' hook on register / admin link content.

 *

 * @param string $before Text to output before the link (defaults to <li>).

 * @param string $after Text to output after the link (defaults to </li>).

 * @param boolean $echo Default to echo and not return the link.

 * @return string|null String when retrieving, null when displaying.

 */

function wp_register( $before = '<li>', $after = '</li>', $echo = true ) {

	if ( ! is_user_logged_in() ) {

		if ( get_option('users_can_register') )

			$link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __('Register') . '</a>' . $after;

		else

			$link = '';

	} else {

		$link = $before . '<a href="' . admin_url() . '">' . __('Site Admin') . '</a>' . $after;

	}

	if ( $echo )

		echo apply_filters('register', $link);

	else

		return apply_filters('register', $link);

}

/**

 * Theme container function for the 'wp_meta' action.

 *

 * The 'wp_meta' action can have several purposes, depending on how you use it,

 * but one purpose might have been to allow for theme switching.

 *

 * @since 1.5.0

 * @link http://trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action.

 * @uses do_action() Calls 'wp_meta' hook.

 */

function wp_meta() {

	do_action('wp_meta');

}

/**

 * Display information about the blog.

 *

 * @see get_bloginfo() For possible values for the parameter.

 * @since 0.71

 *

 * @param string $show What to display.

 */

function bloginfo( $show='' ) {

	echo get_bloginfo( $show, 'display' );

}

/**

 * Retrieve information about the blog.

 *

 * Some show parameter values are deprecated and will be removed in future

 * versions. These options will trigger the _deprecated_argument() function.

 * The deprecated blog info options are listed in the function contents.

 *

 * The possible values for the 'show' parameter are listed below.

 * <ol>

 * <li><strong>url</strong> - Blog URI to homepage.</li>

 * <li><strong>wpurl</strong> - Blog URI path to WordPress.</li>