diff options
Diffstat (limited to 'srcs/wordpress/wp-includes/general-template.php')
| -rw-r--r-- | srcs/wordpress/wp-includes/general-template.php | 4746 |
1 files changed, 0 insertions, 4746 deletions
diff --git a/srcs/wordpress/wp-includes/general-template.php b/srcs/wordpress/wp-includes/general-template.php deleted file mode 100644 index f9b5661..0000000 --- a/srcs/wordpress/wp-includes/general-template.php +++ /dev/null @@ -1,4746 +0,0 @@ -<?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". - * - * @since 1.5.0 - * - * @param string $name The name of the specialised header. - */ -function get_header( $name = null ) { - /** - * Fires before the header template file is loaded. - * - * @since 2.1.0 - * @since 2.8.0 $name parameter added. - * - * @param string|null $name Name of the specific header file to use. null for the default header. - */ - do_action( 'get_header', $name ); - - $templates = array(); - $name = (string) $name; - if ( '' !== $name ) { - $templates[] = "header-{$name}.php"; - } - - $templates[] = 'header.php'; - - locate_template( $templates, true ); -} - -/** - * 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". - * - * @since 1.5.0 - * - * @param string $name The name of the specialised footer. - */ -function get_footer( $name = null ) { - /** - * Fires before the footer template file is loaded. - * - * @since 2.1.0 - * @since 2.8.0 $name parameter added. - * - * @param string|null $name Name of the specific footer file to use. null for the default footer. - */ - do_action( 'get_footer', $name ); - - $templates = array(); - $name = (string) $name; - if ( '' !== $name ) { - $templates[] = "footer-{$name}.php"; - } - - $templates[] = 'footer.php'; - - locate_template( $templates, true ); -} - -/** - * 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". - * - * @since 1.5.0 - * - * @param string $name The name of the specialised sidebar. - */ -function get_sidebar( $name = null ) { - /** - * Fires before the sidebar template file is loaded. - * - * @since 2.2.0 - * @since 2.8.0 $name parameter added. - * - * @param string|null $name Name of the specific sidebar file to use. null for the default sidebar. - */ - do_action( 'get_sidebar', $name ); - - $templates = array(); - $name = (string) $name; - if ( '' !== $name ) { - $templates[] = "sidebar-{$name}.php"; - } - - $templates[] = 'sidebar.php'; - - locate_template( $templates, true ); -} - -/** - * Loads a template part into a template. - * - * Provides a simple mechanism for child themes to overload reusable sections of code - * in the theme. - * - * 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". - * - * @since 3.0.0 - * - * @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 ) { - /** - * Fires before the specified template part file is loaded. - * - * The dynamic portion of the hook name, `$slug`, refers to the slug name - * for the generic template part. - * - * @since 3.0.0 - * - * @param string $slug The slug name for the generic template. - * @param string|null $name The name of the specialized template. - */ - do_action( "get_template_part_{$slug}", $slug, $name ); - - $templates = array(); - $name = (string) $name; - if ( '' !== $name ) { - $templates[] = "{$slug}-{$name}.php"; - } - - $templates[] = "{$slug}.php"; - - /** - * Fires before a template part is loaded. - * - * @since 5.2.0 - * - * @param string $slug The slug name for the generic template. - * @param string $name The name of the specialized template. - * @param string[] $templates Array of template files to search for, in order. - */ - do_action( 'get_template_part', $slug, $name, $templates ); - - 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 {@see '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, - * {@see '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 - * @since 5.2.0 The $args array parameter was added in place of an $echo boolean flag. - * - * @param array $args { - * Optional. Array of display arguments. - * - * @type bool $echo Whether to echo or return the form. Default true. - * @type string $aria_label ARIA label for the search form. Useful to distinguish - * multiple search forms on the same page and improve - * accessibility. Default empty. - * } - * @return string|void String when the $echo param is false. - */ -function get_search_form( $args = array() ) { - /** - * Fires before the search form is retrieved, at the start of get_search_form(). - * - * @since 2.7.0 as 'get_search_form' action. - * @since 3.6.0 - * - * @link https://core.trac.wordpress.org/ticket/19321 - */ - do_action( 'pre_get_search_form' ); - - $echo = true; - - if ( ! is_array( $args ) ) { - /* - * Back compat: to ensure previous uses of get_search_form() continue to - * function as expected, we handle a value for the boolean $echo param removed - * in 5.2.0. Then we deal with the $args array and cast its defaults. - */ - $echo = (bool) $args; - - // Set an empty array and allow default arguments to take over. - $args = array(); - } - - // Defaults are to echo and to output no custom label on the form. - $defaults = array( - 'echo' => $echo, - 'aria_label' => '', - ); - - $args = wp_parse_args( $args, $defaults ); - - /** - * Filters the array of arguments used when generating the search form. - * - * @since 5.2.0 - * - * @param array $args The array of arguments for building the search form. - */ - $args = apply_filters( 'search_form_args', $args ); - - $format = current_theme_supports( 'html5', 'search-form' ) ? 'html5' : 'xhtml'; - - /** - * Filters the HTML format of the search form. - * - * @since 3.6.0 - * - * @param string $format The type of markup to use in the search form. - * Accepts '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 { - // Build a string containing an aria-label to use for the search form. - if ( isset( $args['aria_label'] ) && $args['aria_label'] ) { - $aria_label = 'aria-label="' . esc_attr( $args['aria_label'] ) . '" '; - } else { - /* - * If there's no custom aria-label, we can set a default here. At the - * moment it's empty as there's uncertainty about what the default should be. - */ - $aria_label = ''; - } - if ( 'html5' == $format ) { - $form = '<form role="search" ' . $aria_label . '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 …', 'placeholder' ) . '" value="' . get_search_query() . '" name="s" /> - </label> - <input type="submit" class="search-submit" value="' . esc_attr_x( 'Search', 'submit button' ) . '" /> - </form>'; - } else { - $form = '<form role="search" ' . $aria_label . '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>'; - } - } - - /** - * Filters the HTML output of the search form. - * - * @since 2.7.0 - * - * @param string $form The search form HTML output. - */ - $result = apply_filters( 'get_search_form', $form ); - - if ( null === $result ) { - $result = $form; - } - - if ( isset( $args['echo'] ) && $args['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 - * - * @param string $redirect Optional path to redirect to on login/logout. - * @param bool $echo Default to echo and not return the link. - * @return string|void String when retrieving. - */ -function wp_loginout( $redirect = '', $echo = true ) { - if ( ! is_user_logged_in() ) { - $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 ) { - /** - * Filters the HTML output for the Log In/Log Out link. - * - * @since 1.5.0 - * - * @param string $link The HTML link content. - */ - echo apply_filters( 'loginout', $link ); - } else { - /** This filter is documented in wp-includes/general-template.php */ - return apply_filters( 'loginout', $link ); - } -} - -/** - * Retrieves the logout URL. - * - * Returns the URL that allows the user to log out of the site. - * - * @since 2.7.0 - * - * @param string $redirect Path to redirect to on logout. - * @return string The logout URL. Note: HTML-encoded via esc_html() in wp_nonce_url(). - */ -function wp_logout_url( $redirect = '' ) { - $args = array(); - if ( ! empty( $redirect ) ) { - $args['redirect_to'] = urlencode( $redirect ); - } - - $logout_url = add_query_arg( $args, site_url( 'wp-login.php?action=logout', 'login' ) ); - $logout_url = wp_nonce_url( $logout_url, 'log-out' ); - - /** - * Filters the logout URL. - * - * @since 2.8.0 - * - * @param string $logout_url The HTML-encoded logout URL. - * @param string $redirect Path to redirect to on logout. - */ - return apply_filters( 'logout_url', $logout_url, $redirect ); -} - -/** - * Retrieves the login URL. - * - * @since 2.7.0 - * - * @param string $redirect Path to redirect to on log in. - * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. - * Default false. - * @return string The login URL. Not HTML-encoded. - */ -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 ); - } - - /** - * Filters the login URL. - * - * @since 2.8.0 - * @since 4.2.0 The `$force_reauth` parameter was added. - * - * @param string $login_url The login URL. Not HTML-encoded. - * @param string $redirect The path to redirect to on login, if supplied. - * @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. - */ - return apply_filters( 'login_url', $login_url, $redirect, $force_reauth ); -} - -/** - * Returns the URL that allows the user to register on the site. - * - * @since 3.6.0 - * - * @return string User registration URL. - */ -function wp_registration_url() { - /** - * Filters the user registration URL. - * - * @since 3.6.0 - * - * @param string $register The user 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. - * - * The login format HTML is echoed by default. Pass a false value for `$echo` to return it instead. - * - * @since 3.0.0 - * - * @param array $args { - * Optional. Array of options to control the form output. Default empty array. - * - * @type bool $echo Whether to display the login form or return the form HTML code. - * Default true (echo). - * @type string $redirect URL to redirect to. Must be absolute, as in "https://example.com/mypage/". - * Default is to redirect back to the request URI. - * @type string $form_id ID attribute value for the form. Default 'loginform'. - * @type string $label_username Label for the username or email address field. Default 'Username or Email Address'. - * @type string $label_password Label for the password field. Default 'Password'. - * @type string $label_remember Label for the remember field. Default 'Remember Me'. - * @type string $label_log_in Label for the submit button. Default 'Log In'. - * @type string $id_username ID attribute value for the username field. Default 'user_login'. - * @type string $id_password ID attribute value for the password field. Default 'user_pass'. - * @type string $id_remember ID attribute value for the remember field. Default 'rememberme'. - * @type string $id_submit ID attribute value for the submit button. Default 'wp-submit'. - * @type bool $remember Whether to display the "rememberme" checkbox in the form. - * @type string $value_username Default value for the username field. Default empty. - * @type bool $value_remember Whether the "Remember Me" checkbox should be checked by default. - * Default false (unchecked). - * - * } - * @return string|void String when retrieving. - */ -function wp_login_form( $args = array() ) { - $defaults = array( - 'echo' => true, - // Default 'redirect' value takes the user back to the request URI. - 'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], - 'form_id' => 'loginform', - 'label_username' => __( 'Username or Email Address' ), - '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' => '', - // Set 'value_remember' to true to default the "Remember me" checkbox to checked. - 'value_remember' => false, - ); - - /** - * Filters the default login form output arguments. - * - * @since 3.0.0 - * - * @see wp_login_form() - * - * @param array $defaults An array of default login form arguments. - */ - $args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) ); - - /** - * Filters content to display at the top of the login form. - * - * The filter evaluates just following the opening form tag element. - * - * @since 3.0.0 - * - * @param string $content Content to display. Default empty. - * @param array $args Array of login form arguments. - */ - $login_form_top = apply_filters( 'login_form_top', '', $args ); - - /** - * Filters content to display in the middle of the login form. - * - * The filter evaluates just following the location where the 'login-password' - * field is displayed. - * - * @since 3.0.0 - * - * @param string $content Content to display. Default empty. - * @param array $args Array of login form arguments. - */ - $login_form_middle = apply_filters( 'login_form_middle', '', $args ); - - /** - * Filters content to display at the bottom of the login form. - * - * The filter evaluates just preceding the closing form tag element. - * - * @since 3.0.0 - * - * @param string $content Content to display. Default empty. - * @param array $args Array of login form arguments. - */ - $login_form_bottom = apply_filters( 'login_form_bottom', '', $args ); - - $form = ' - <form name="' . $args['form_id'] . '" id="' . $args['form_id'] . '" action="' . esc_url( site_url( 'wp-login.php', 'login_post' ) ) . '" method="post"> - ' . $login_form_top . ' - <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> - ' . $login_form_middle . ' - ' . ( $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 button-primary" value="' . esc_attr( $args['label_log_in'] ) . '" /> - <input type="hidden" name="redirect_to" value="' . esc_url( $args['redirect'] ) . '" /> - </p> - ' . $login_form_bottom . ' - </form>'; - - if ( $args['echo'] ) { - echo $form; - } else { - return $form; - } -} - -/** - * Returns the URL that allows the user to retrieve the lost password - * - * @since 2.8.0 - * - * @param string $redirect Path to redirect to on login. - * @return string Lost password URL. - */ -function wp_lostpassword_url( $redirect = '' ) { - $args = array(); - if ( ! empty( $redirect ) ) { - $args['redirect_to'] = urlencode( $redirect ); - } - - $lostpassword_url = add_query_arg( $args, network_site_url( 'wp-login.php?action=lostpassword', 'login' ) ); - - /** - * Filters the Lost Password URL. - * - * @since 2.8.0 - * - * @param string $lostpassword_url The lost password page URL. - * @param string $redirect The path to redirect to on 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 - * - * @param string $before Text to output before the link. Default `<li>`. - * @param string $after Text to output after the link. Default `</li>`. - * @param bool $echo Default to echo and not return the link. - * @return string|void String when retrieving. - */ -function wp_register( $before = '<li>', $after = '</li>', $echo = true ) { - if ( ! is_user_logged_in() ) { - if ( get_option( 'users_can_register' ) ) { - $link = $before . '<a href="' . esc_url( wp_registration_url() ) . '">' . __( 'Register' ) . '</a>' . $after; - } else { - $link = ''; - } - } elseif ( current_user_can( 'read' ) ) { - $link = $before . '<a href="' . admin_url() . '">' . __( 'Site Admin' ) . '</a>' . $after; - } else { - $link = ''; - } - - /** - * Filters the HTML link to the Registration or Admin page. - * - * Users are sent to the admin page if logged-in, or the registration page - * if enabled and logged-out. - * - * @since 1.5.0 - * - * @param string $link The HTML code for the link to the Registration or Admin page. - */ - $link = apply_filters( 'register', $link ); - - if ( $echo ) { - echo $link; - } else { - return $link; - } -} - -/** - * Theme container function for the 'wp_meta' action. - * - * The {@see '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 https://core.trac.wordpress.org/ticket/1458 Explanation of 'wp_meta' action. - */ -function wp_meta() { - /** - * Fires before displaying echoed content in the sidebar. - * - * @since 1.5.0 - */ - do_action( 'wp_meta' ); -} - -/** - * Displays information about the current site. - * - * @since 0.71 - * - * @see get_bloginfo() For possible `$show` values - * - * @param string $show Optional. Site information to display. Default empty. - */ -function bloginfo( $show = '' ) { - echo get_bloginfo( $show, 'display' ); -} - -/** - * Retrieves information about the current site. - * - * Possible values for `$show` include: - * - * - 'name' - Site title (set in Settings > General) - * - 'description' - Site tagline (set in Settings > General) - * - 'wpurl' - The WordPress address (URL) (set in Settings > General) - * - 'url' - The Site address (URL) (set in Settings > General) - * - 'admin_email' - Admin email (set in Settings > General) - * - 'charset' - The "Encoding for pages and feeds" (set in Settings > Reading) - * - 'version' - The current WordPress version - * - 'html_type' - The content-type (default: "text/html"). Themes and plugins - * can override the default value using the {@see 'pre_option_html_type'} filter - * - 'text_direction' - The text direction determined by the site's language. is_rtl() - * should be used instead - * - 'language' - Language code for the current site - * - 'stylesheet_url' - URL to the stylesheet for the active theme. An active child theme - * will take precedence over this value - * - 'stylesheet_directory' - Directory path for the active theme. An active child theme - * will take precedence over this value - * - 'template_url' / 'template_directory' - URL of the active theme's directory. An active - * child theme will NOT take precedence over this value - * - 'pingback_url' - The pingback XML-RPC file URL (xmlrpc.php) - * - 'atom_url' - The Atom feed URL (/feed/atom) - * - 'rdf_url' - The RDF/RSS 1.0 feed URL (/feed/rdf) - * - 'rss_url' - The RSS 0.92 feed URL (/feed/rss) - * - 'rss2_url' - The RSS 2.0 feed URL (/feed) - * - 'comments_atom_url' - The comments Atom feed URL (/comments/feed) - * - 'comments_rss2_url' - The comments RSS 2.0 feed URL (/comments/feed) - * - * Some `$show` values are deprecated and will be removed in future versions. - * These options will trigger the _deprecated_argument() function. - * - * Deprecated arguments include: - * - * - 'siteurl' - Use 'url' instead - * - 'home' - Use 'url' instead - * - * @since 0.71 - * - * @global string $wp_version - * - * @param string $show Optional. Site info to retrieve. Default empty (site name). - * @param string $filter Optional. How to filter what is retrieved. Default 'raw'. - * @return string Mostly string values, might be empty. - */ -function get_bloginfo( $show = '', $filter = 'raw' ) { - switch ( $show ) { - case 'home': // DEPRECATED - case 'siteurl': // DEPRECATED - _deprecated_argument( - __FUNCTION__, - '2.2.0', - sprintf( - /* translators: 1: 'siteurl'/'home' argument, 2: bloginfo() function name, 3: 'url' argument. */ - __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s option instead.' ), - '<code>' . $show . '</code>', - '<code>bloginfo()</code>', - '<code>url</code>' - ) - ); - // Intentional fall-through to be handled by the 'url' case. - case 'url': - $output = home_url(); - break; - case 'wpurl': - $output = site_url(); - break; - case 'description': - $output = get_option( 'blogdescription' ); - break; - case 'rdf_url': - $output = get_feed_link( 'rdf' ); - break; - case 'rss_url': - $output = get_feed_link( 'rss' ); - break; - case 'rss2_url': - $output = get_feed_link( 'rss2' ); - break; - case 'atom_url': - $output = get_feed_link( 'atom' ); - break; - case 'comments_atom_url': - $output = get_feed_link( 'comments_atom' ); - break; - case 'comments_rss2_url': - $output = get_feed_link( 'comments_rss2' ); - break; - case 'pingback_url': - $output = site_url( 'xmlrpc.php' ); - break; - case 'stylesheet_url': - $output = get_stylesheet_uri(); - break; - case 'stylesheet_directory': - $output = get_stylesheet_directory_uri(); - break; - case 'template_directory': - case 'template_url': - $output = get_template_directory_uri(); - break; - case 'admin_email': - $output = get_option( 'admin_email' ); - break; - case 'charset': - $output = get_option( 'blog_charset' ); - if ( '' == $output ) { - $output = 'UTF-8'; - } - break; - case 'html_type': - $output = get_option( 'html_type' ); - break; - case 'version': - global $wp_version; - $output = $wp_version; - break; - case 'language': - /* - * translators: Translate this to the correct language tag for your locale, - * see https://www.w3.org/International/articles/language-tags/ for reference. - * Do not translate into your own language. - */ - $output = __( 'html_lang_attribute' ); - if ( 'html_lang_attribute' === $output || preg_match( '/[^a-zA-Z0-9-]/', $output ) ) { - $output = determine_locale(); - $output = str_replace( '_', '-', $output ); - } - break; - case 'text_direction': - _deprecated_argument( - __FUNCTION__, - '2.2.0', - sprintf( - /* translators: 1: 'text_direction' argument, 2: bloginfo() function name, 3: is_rtl() function name. */ - __( 'The %1$s option is deprecated for the family of %2$s functions. Use the %3$s function instead.' ), - '<code>' . $show . '</code>', - '<code>bloginfo()</code>', - '<code>is_rtl()</code>' - ) - ); - if ( function_exists( 'is_rtl' ) ) { - $output = is_rtl() ? 'rtl' : 'ltr'; - } else { - $output = 'ltr'; - } - break; - case 'name': - default: - $output = get_option( 'blogname' ); - break; - } - - $url = true; - if ( strpos( $show, 'url' ) === false && - strpos( $show, 'directory' ) === false && - strpos( $show, 'home' ) === false ) { - $url = false; - } - - if ( 'display' == $filter ) { - if ( $url ) { - /** - * Filters the URL returned by get_bloginfo(). - * - * @since 2.0.5 - * - * @param mixed $output The URL returned by bloginfo(). - * @param mixed $show Type of information requested. - */ - $output = apply_filters( 'bloginfo_url', $output, $show ); - } else { - /** - * Filters the site information returned by get_bloginfo(). - * - * @since 0.71 - * - * @param mixed $output The requested non-URL site information. - * @param mixed $show Type of information requested. - */ - $output = apply_filters( 'bloginfo', $output, $show ); - } - } - - return $output; -} - -/** - * Returns the Site Icon URL. - * - * @since 4.3.0 - * - * @param int $size Optional. Size of the site icon. Default 512 (pixels). - * @param string $url Optional. Fallback url if no site icon is found. Default empty. - * @param int $blog_id Optional. ID of the blog to get the site icon for. Default current blog. - * @return string Site Icon URL. - */ -function get_site_icon_url( $size = 512, $url = '', $blog_id = 0 ) { - $switched_blog = false; - - if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) { - switch_to_blog( $blog_id ); - $switched_blog = true; - } - - $site_icon_id = get_option( 'site_icon' ); - - if ( $site_icon_id ) { - if ( $size >= 512 ) { - $size_data = 'full'; - } else { - $size_data = array( $size, $size ); - } - $url = wp_get_attachment_image_url( $site_icon_id, $size_data ); - } - - if ( $switched_blog ) { - restore_current_blog(); - } - - /** - * Filters the site icon URL. - * - * @since 4.4.0 - * - * @param string $url Site icon URL. - * @param int $size Size of the site icon. - * @param int $blog_id ID of the blog to get the site icon for. - */ - return apply_filters( 'get_site_icon_url', $url, $size, $blog_id ); -} - -/** - * Displays the Site Icon URL. - * - * @since 4.3.0 - * - * @param int $size Optional. Size of the site icon. Default 512 (pixels). - * @param string $url Optional. Fallback url if no site icon is found. Default empty. - * @param int $blog_id Optional. ID of the blog to get the site icon for. Default current blog. - */ -function site_icon_url( $size = 512, $url = '', $blog_id = 0 ) { - echo esc_url( get_site_icon_url( $size, $url, $blog_id ) ); -} - -/** - * Whether the site has a Site Icon. - * - * @since 4.3.0 - * - * @param int $blog_id Optional. ID of the blog in question. Default current blog. - * @return bool Whether the site has a site icon or not. - */ -function has_site_icon( $blog_id = 0 ) { - return (bool) get_site_icon_url( 512, '', $blog_id ); -} - -/** - * Determines whether the site has a custom logo. - * - * @since 4.5.0 - * - * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog. - * @return bool Whether the site has a custom logo or not. - */ -function has_custom_logo( $blog_id = 0 ) { - $switched_blog = false; - - if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) { - switch_to_blog( $blog_id ); - $switched_blog = true; - } - - $custom_logo_id = get_theme_mod( 'custom_logo' ); - - if ( $switched_blog ) { - restore_current_blog(); - } - - return (bool) $custom_logo_id; -} - -/** - * Returns a custom logo, linked to home. - * - * @since 4.5.0 - * - * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog. - * @return string Custom logo markup. - */ -function get_custom_logo( $blog_id = 0 ) { - $html = ''; - $switched_blog = false; - - if ( is_multisite() && ! empty( $blog_id ) && (int) $blog_id !== get_current_blog_id() ) { - switch_to_blog( $blog_id ); - $switched_blog = true; - } - - $custom_logo_id = get_theme_mod( 'custom_logo' ); - - // We have a logo. Logo is go. - if ( $custom_logo_id ) { - $custom_logo_attr = array( - 'class' => 'custom-logo', - ); - - /* - * If the logo alt attribute is empty, get the site title and explicitly - * pass it to the attributes used by wp_get_attachment_image(). - */ - $image_alt = get_post_meta( $custom_logo_id, '_wp_attachment_image_alt', true ); - if ( empty( $image_alt ) ) { - $custom_logo_attr['alt'] = get_bloginfo( 'name', 'display' ); - } - - /* - * If the alt attribute is not empty, there's no need to explicitly pass - * it because wp_get_attachment_image() already adds the alt attribute. - */ - $html = sprintf( - '<a href="%1$s" class="custom-logo-link" rel="home">%2$s</a>', - esc_url( home_url( '/' ) ), - wp_get_attachment_image( $custom_logo_id, 'full', false, $custom_logo_attr ) - ); - } elseif ( is_customize_preview() ) { - // If no logo is set but we're in the Customizer, leave a placeholder (needed for the live preview). - $html = sprintf( - '<a href="%1$s" class="custom-logo-link" style="display:none;"><img class="custom-logo"/></a>', - esc_url( home_url( '/' ) ) - ); - } - - if ( $switched_blog ) { - restore_current_blog(); - } - - /** - * Filters the custom logo output. - * - * @since 4.5.0 - * @since 4.6.0 Added the `$blog_id` parameter. - * - * @param string $html Custom logo HTML output. - * @param int $blog_id ID of the blog to get the custom logo for. - */ - return apply_filters( 'get_custom_logo', $html, $blog_id ); -} - -/** - * Displays a custom logo, linked to home. - * - * @since 4.5.0 - * - * @param int $blog_id Optional. ID of the blog in question. Default is the ID of the current blog. - */ -function the_custom_logo( $blog_id = 0 ) { - echo get_custom_logo( $blog_id ); -} - -/** - * Returns document title for the current page. - * - * @since 4.4.0 - * - * @global int $page Page number of a single post. - * @global int $paged Page number of a list of posts. - * - * @return string Tag with the document title. - */ -function wp_get_document_title() { - - /** - * Filters the document title before it is generated. - * - * Passing a non-empty value will short-circuit wp_get_document_title(), - * returning that value instead. - * - * @since 4.4.0 - * - * @param string $title The document title. Default empty string. - */ - $title = apply_filters( 'pre_get_document_title', '' ); - if ( ! empty( $title ) ) { - return $title; - } - - global $page, $paged; - - $title = array( - 'title' => '', - ); - - // If it's a 404 page, use a "Page not found" title. - if ( is_404() ) { - $title['title'] = __( 'Page not found' ); - - // If it's a search, use a dynamic search results title. - } elseif ( is_search() ) { - /* translators: %s: Search query. */ - $title['title'] = sprintf( __( 'Search Results for “%s”' ), get_search_query() ); - - // If on the front page, use the site title. - } elseif ( is_front_page() ) { - $title['title'] = get_bloginfo( 'name', 'display' ); - - // If on a post type archive, use the post type archive title. - } elseif ( is_post_type_archive() ) { - $title['title'] = post_type_archive_title( '', false ); - - // If on a taxonomy archive, use the term title. - } elseif ( is_tax() ) { - $title['title'] = single_term_title( '', false ); - - /* - * If we're on the blog page that is not the homepage or - * a single post of any post type, use the post title. - */ - } elseif ( is_home() || is_singular() ) { - $title['title'] = single_post_title( '', false ); - - // If on a category or tag archive, use the term title. - } elseif ( is_category() || is_tag() ) { - $title['title'] = single_term_title( '', false ); - - // If on an author archive, use the author's display name. - } elseif ( is_author() && get_queried_object() ) { - $author = get_queried_object(); - $title['title'] = $author->display_name; - - // If it's a date archive, use the date as the title. - } elseif ( is_year() ) { - $title['title'] = get_the_date( _x( 'Y', 'yearly archives date format' ) ); - - } elseif ( is_month() ) { - $title['title'] = get_the_date( _x( 'F Y', 'monthly archives date format' ) ); - - } elseif ( is_day() ) { - $title['title'] = get_the_date(); - } - - // Add a page number if necessary. - if ( ( $paged >= 2 || $page >= 2 ) && ! is_404() ) { - /* translators: %s: Page number. */ - $title['page'] = sprintf( __( 'Page %s' ), max( $paged, $page ) ); - } - - // Append the description or site title to give |