X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/7688c6ba71852cd89123b62b2d57683535e4702a..53f4633144ed68c8b8fb5861f992b5489894a940:/wp-includes/post-template.php diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index a956dc48..1b4901cc 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -1,22 +1,45 @@ ID : false; } - -function the_title($before = '', $after = '', $echo = true) { +/** + * Display or retrieve the current post title with optional content. + * + * @since 0.71 + * + * @param string $before Optional. Content to prepend to the title. + * @param string $after Optional. Content to append to the title. + * @param bool $echo Optional, default to true.Whether to display or return. + * @return string|void String if $echo parameter is false. + */ +function the_title( $before = '', $after = '', $echo = true ) { $title = get_the_title(); if ( strlen($title) == 0 ) @@ -30,465 +53,1810 @@ function the_title($before = '', $after = '', $echo = true) { return $title; } +/** + * Sanitize the current title when retrieving or displaying. + * + * Works like {@link the_title()}, except the parameters can be in a string or + * an array. See the function for what can be override in the $args parameter. + * + * The title before it is displayed will have the tags stripped and {@link + * esc_attr()} before it is passed to the user or displayed. The default + * as with {@link the_title()}, is to display the title. + * + * @since 2.3.0 + * + * @param string|array $args { + * Title attribute arguments. Optional. + * + * @type string $before Markup to prepend to the title. Default empty. + * @type string $after Markup to append to the title. Default empty. + * @type bool $echo Whether to echo or return the title. Default true for echo. + * @type WP_Post $post Current post object to retrieve the title for. + * } + * @return string|void String when echo is false. + */ function the_title_attribute( $args = '' ) { - $title = get_the_title(); - - if ( strlen($title) == 0 ) - return; + $defaults = array( 'before' => '', 'after' => '', 'echo' => true, 'post' => get_post() ); + $r = wp_parse_args( $args, $defaults ); - $defaults = array('before' => '', 'after' => '', 'echo' => true); - $r = wp_parse_args($args, $defaults); - extract( $r, EXTR_SKIP ); + $title = get_the_title( $r['post'] ); + if ( strlen( $title ) == 0 ) { + return; + } - $title = $before . $title . $after; - $title = attribute_escape(strip_tags($title)); + $title = $r['before'] . $title . $r['after']; + $title = esc_attr( strip_tags( $title ) ); - if ( $echo ) + if ( $r['echo'] ) { echo $title; - else + } else { return $title; + } } -function get_the_title( $id = 0 ) { - $post = &get_post($id); - - $title = $post->post_title; - if ( !empty($post->post_password) ) - $title = sprintf(__('Protected: %s'), $title); - else if ( 'private' == $post->post_status ) - $title = sprintf(__('Private: %s'), $title); +/** + * Retrieve post title. + * + * If the post is protected and the visitor is not an admin, then "Protected" + * will be displayed before the post title. If the post is private, then + * "Private" will be located before the post title. + * + * @since 0.71 + * + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. + * @return string + */ +function get_the_title( $post = 0 ) { + $post = get_post( $post ); + + $title = isset( $post->post_title ) ? $post->post_title : ''; + $id = isset( $post->ID ) ? $post->ID : 0; + + if ( ! is_admin() ) { + if ( ! empty( $post->post_password ) ) { + + /** + * Filter the text prepended to the post title for protected posts. + * + * The filter is only applied on the front end. + * + * @since 2.8.0 + * + * @param string $prepend Text displayed before the post title. + * Default 'Protected: %s'. + * @param WP_Post $post Current post object. + */ + $protected_title_format = apply_filters( 'protected_title_format', __( 'Protected: %s' ), $post ); + $title = sprintf( $protected_title_format, $title ); + } elseif ( isset( $post->post_status ) && 'private' == $post->post_status ) { + + /** + * Filter the text prepended to the post title of private posts. + * + * The filter is only applied on the front end. + * + * @since 2.8.0 + * + * @param string $prepend Text displayed before the post title. + * Default 'Private: %s'. + * @param WP_Post $post Current post object. + */ + $private_title_format = apply_filters( 'private_title_format', __( 'Private: %s' ), $post ); + $title = sprintf( $private_title_format, $title ); + } + } - return apply_filters( 'the_title', $title ); + /** + * Filter the post title. + * + * @since 0.71 + * + * @param string $title The post title. + * @param int $id The post ID. + */ + return apply_filters( 'the_title', $title, $id ); } +/** + * Display the Post Global Unique Identifier (guid). + * + * The guid will appear to be a link, but should not be used as an link to the + * post. The reason you should not use it as a link, is because of moving the + * blog across domains. + * + * Url is escaped to make it xml safe + * + * @since 1.5.0 + * + * @param int|WP_Post $id Optional. Post ID or post object. + */ function the_guid( $id = 0 ) { - echo get_the_guid($id); + /** + * Filter the escaped Global Unique Identifier (guid) of the post. + * + * @since 4.2.0 + * + * @see get_the_guid() + * + * @param string $post_guid Escaped Global Unique Identifier (guid) of the post. + */ + echo apply_filters( 'the_guid', get_the_guid( $id ) ); } +/** + * Retrieve the Post Global Unique Identifier (guid). + * + * The guid will appear to be a link, but should not be used as an link to the + * post. The reason you should not use it as a link, is because of moving the + * blog across domains. + * + * @since 1.5.0 + * + * @param int|WP_Post $id Optional. Post ID or post object. + * @return string + */ function get_the_guid( $id = 0 ) { - $post = &get_post($id); - - return apply_filters('get_the_guid', $post->guid); + $post = get_post($id); + + /** + * Filter the Global Unique Identifier (guid) of the post. + * + * @since 1.5.0 + * + * @param string $post_guid Global Unique Identifier (guid) of the post. + */ + return apply_filters( 'get_the_guid', $post->guid ); } -function the_content($more_link_text = '(more...)', $stripteaser = 0, $more_file = '') { - $content = get_the_content($more_link_text, $stripteaser, $more_file); - $content = apply_filters('the_content', $content); - $content = str_replace(']]>', ']]>', $content); +/** + * Display the post content. + * + * @since 0.71 + * + * @param string $more_link_text Optional. Content for when there is more text. + * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default is false. + */ +function the_content( $more_link_text = null, $strip_teaser = false) { + $content = get_the_content( $more_link_text, $strip_teaser ); + + /** + * Filter the post content. + * + * @since 0.71 + * + * @param string $content Content of the current post. + */ + $content = apply_filters( 'the_content', $content ); + $content = str_replace( ']]>', ']]>', $content ); echo $content; } +/** + * Retrieve the post content. + * + * @since 0.71 + * + * @global int $page + * @global int $more + * @global bool $preview + * @global array $pages + * @global int $multipage + * + * @param string $more_link_text Optional. Content for when there is more text. + * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default is false. + * @return string + */ +function get_the_content( $more_link_text = null, $strip_teaser = false ) { + global $page, $more, $preview, $pages, $multipage; + + $post = get_post(); + + if ( null === $more_link_text ) + $more_link_text = __( '(more…)' ); -function get_the_content($more_link_text = '(more...)', $stripteaser = 0, $more_file = '') { - global $id, $post, $more, $single, $withcomments, $page, $pages, $multipage, $numpages; - global $preview; - global $pagenow; $output = ''; + $has_teaser = false; - if ( !empty($post->post_password) ) { // if there's a password - if ( stripslashes($_COOKIE['wp-postpass_'.COOKIEHASH]) != $post->post_password ) { // and it doesn't match the cookie - $output = get_the_password_form(); - return $output; - } - } + // If post password required and it doesn't match the cookie. + if ( post_password_required( $post ) ) + return get_the_password_form( $post ); - if ( $more_file != '' ) - $file = $more_file; - else - $file = $pagenow; //$_SERVER['PHP_SELF']; + if ( $page > count( $pages ) ) // if the requested page doesn't exist + $page = count( $pages ); // give them the highest numbered page that DOES exist - if ( $page > count($pages) ) // if the requested page doesn't exist - $page = count($pages); // give them the highest numbered page that DOES exist + $content = $pages[$page - 1]; + if ( preg_match( '//', $content, $matches ) ) { + $content = explode( $matches[0], $content, 2 ); + if ( ! empty( $matches[1] ) && ! empty( $more_link_text ) ) + $more_link_text = strip_tags( wp_kses_no_null( trim( $matches[1] ) ) ); - $content = $pages[$page-1]; - if ( preg_match('//', $content, $matches) ) { - $content = explode($matches[0], $content, 2); - if ( !empty($matches[1]) && !empty($more_link_text) ) - $more_link_text = strip_tags(wp_kses_no_null(trim($matches[1]))); + $has_teaser = true; } else { - $content = array($content); + $content = array( $content ); } - if ( (false !== strpos($post->post_content, '') && ((!$multipage) || ($page==1))) ) - $stripteaser = 1; + + if ( false !== strpos( $post->post_content, '' ) && ( ! $multipage || $page == 1 ) ) + $strip_teaser = true; + $teaser = $content[0]; - if ( ($more) && ($stripteaser) ) + + if ( $more && $strip_teaser && $has_teaser ) $teaser = ''; + $output .= $teaser; - if ( count($content) > 1 ) { + + if ( count( $content ) > 1 ) { if ( $more ) { - $output .= ''.$content[1]; + $output .= '' . $content[1]; } else { - $output = balanceTags($output); - if ( ! empty($more_link_text) ) - $output .= ' $more_link_text"; + if ( ! empty( $more_link_text ) ) + + /** + * Filter the Read More link text. + * + * @since 2.8.0 + * + * @param string $more_link_element Read More link element. + * @param string $more_link_text Read More text. + */ + $output .= apply_filters( 'the_content_more_link', ' ID}\" class=\"more-link\">$more_link_text", $more_link_text ); + $output = force_balance_tags( $output ); } - } - if ( $preview ) // preview fix for javascript bug with foreign languages - $output = preg_replace('/\%u([0-9A-F]{4,4})/e', "'&#'.base_convert('\\1',16,10).';'", $output); + + if ( $preview ) // Preview fix for JavaScript bug with foreign languages. + $output = preg_replace_callback( '/\%u([0-9A-F]{4})/', '_convert_urlencoded_to_entities', $output ); return $output; } +/** + * Preview fix for JavaScript bug with foreign languages. + * + * @since 3.1.0 + * @access private + * @param array $match Match array from preg_replace_callback + * @return string + */ +function _convert_urlencoded_to_entities( $match ) { + return '&#' . base_convert( $match[1], 16, 10 ) . ';'; +} +/** + * Display the post excerpt. + * + * @since 0.71 + */ function the_excerpt() { - echo apply_filters('the_excerpt', get_the_excerpt()); + + /** + * Filter the displayed post excerpt. + * + * @since 0.71 + * + * @see get_the_excerpt() + * + * @param string $post_excerpt The post excerpt. + */ + echo apply_filters( 'the_excerpt', get_the_excerpt() ); } +/** + * Retrieve the post excerpt. + * + * @since 0.71 + * + * @param mixed $deprecated Not used. + * @return string + */ +function get_the_excerpt( $deprecated = '' ) { + if ( !empty( $deprecated ) ) + _deprecated_argument( __FUNCTION__, '2.3' ); + + $post = get_post(); + if ( empty( $post ) ) { + return ''; + } -function get_the_excerpt($deprecated = true) { - global $id, $post; - $output = ''; - $output = $post->post_excerpt; - if ( !empty($post->post_password) ) { // if there's a password - if ( $_COOKIE['wp-postpass_'.COOKIEHASH] != $post->post_password ) { // and it doesn't match the cookie - $output = __('There is no excerpt because this is a protected post.'); - return $output; - } + if ( post_password_required() ) { + return __( 'There is no excerpt because this is a protected post.' ); } - return apply_filters('get_the_excerpt', $output); + /** + * Filter the retrieved post excerpt. + * + * @since 1.2.0 + * + * @param string $post_excerpt The post excerpt. + */ + return apply_filters( 'get_the_excerpt', $post->post_excerpt ); } +/** + * Whether post has excerpt. + * + * @since 2.3.0 + * + * @param int|WP_Post $id Optional. Post ID or post object. + * @return bool + */ function has_excerpt( $id = 0 ) { - $post = &get_post( $id ); + $post = get_post( $id ); return ( !empty( $post->post_excerpt ) ); } -function wp_link_pages($args = '') { +/** + * Display the classes for the post div. + * + * @since 2.7.0 + * + * @param string|array $class One or more classes to add to the class list. + * @param int|WP_Post $post_id Optional. Post ID or post object. + */ +function post_class( $class = '', $post_id = null ) { + // Separates classes with a single space, collates classes for post DIV + echo 'class="' . join( ' ', get_post_class( $class, $post_id ) ) . '"'; +} + +/** + * Retrieve the classes for the post div as an array. + * + * The class names are many. If the post is a sticky, then the 'sticky' + * class name. The class 'hentry' is always added to each post. If the post has a + * post thumbnail, 'has-post-thumbnail' is added as a class. For each taxonomy that + * the post belongs to, a class will be added of the format '{$taxonomy}-{$slug}' - + * eg 'category-foo' or 'my_custom_taxonomy-bar'. The 'post_tag' taxonomy is a special + * case; the class has the 'tag-' prefix instead of 'post_tag-'. All classes are + * passed through the filter, 'post_class' with the list of classes, followed by + * $class parameter value, with the post ID as the last parameter. + * + * @since 2.7.0 + * @since 4.2.0 Custom taxonomy classes were added. + * + * @param string|array $class One or more classes to add to the class list. + * @param int|WP_Post $post_id Optional. Post ID or post object. + * @return array Array of classes. + */ +function get_post_class( $class = '', $post_id = null ) { + $post = get_post( $post_id ); + + $classes = array(); + + if ( $class ) { + if ( ! is_array( $class ) ) { + $class = preg_split( '#\s+#', $class ); + } + $classes = array_map( 'esc_attr', $class ); + } + + if ( ! $post ) { + return $classes; + } + + $classes[] = 'post-' . $post->ID; + if ( ! is_admin() ) + $classes[] = $post->post_type; + $classes[] = 'type-' . $post->post_type; + $classes[] = 'status-' . $post->post_status; + + // Post Format + if ( post_type_supports( $post->post_type, 'post-formats' ) ) { + $post_format = get_post_format( $post->ID ); + + if ( $post_format && !is_wp_error($post_format) ) + $classes[] = 'format-' . sanitize_html_class( $post_format ); + else + $classes[] = 'format-standard'; + } + + // Post requires password + if ( post_password_required( $post->ID ) ) { + $classes[] = 'post-password-required'; + // Post thumbnails + } elseif ( ! is_attachment( $post ) && current_theme_supports( 'post-thumbnails' ) && has_post_thumbnail( $post->ID ) ) { + $classes[] = 'has-post-thumbnail'; + } + + // sticky for Sticky Posts + if ( is_sticky( $post->ID ) ) { + if ( is_home() && ! is_paged() ) { + $classes[] = 'sticky'; + } elseif ( is_admin() ) { + $classes[] = 'status-sticky'; + } + } + + // hentry for hAtom compliance + $classes[] = 'hentry'; + + // All public taxonomies + $taxonomies = get_taxonomies( array( 'public' => true ) ); + foreach ( (array) $taxonomies as $taxonomy ) { + if ( is_object_in_taxonomy( $post->post_type, $taxonomy ) ) { + foreach ( (array) get_the_terms( $post->ID, $taxonomy ) as $term ) { + if ( empty( $term->slug ) ) { + continue; + } + + $term_class = sanitize_html_class( $term->slug, $term->term_id ); + if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) { + $term_class = $term->term_id; + } + + // 'post_tag' uses the 'tag' prefix for backward compatibility. + if ( 'post_tag' == $taxonomy ) { + $classes[] = 'tag-' . $term_class; + } else { + $classes[] = sanitize_html_class( $taxonomy . '-' . $term_class, $taxonomy . '-' . $term->term_id ); + } + } + } + } + + $classes = array_map( 'esc_attr', $classes ); + + /** + * Filter the list of CSS classes for the current post. + * + * @since 2.7.0 + * + * @param array $classes An array of post classes. + * @param string $class A comma-separated list of additional classes added to the post. + * @param int $post_id The post ID. + */ + $classes = apply_filters( 'post_class', $classes, $class, $post->ID ); + + return array_unique( $classes ); +} + +/** + * Display the classes for the body element. + * + * @since 2.8.0 + * + * @param string|array $class One or more classes to add to the class list. + */ +function body_class( $class = '' ) { + // Separates classes with a single space, collates classes for body element + echo 'class="' . join( ' ', get_body_class( $class ) ) . '"'; +} + +/** + * Retrieve the classes for the body element as an array. + * + * @since 2.8.0 + * + * @global WP_Query $wp_query + * @global wpdb $wpdb + * + * @param string|array $class One or more classes to add to the class list. + * @return array Array of classes. + */ +function get_body_class( $class = '' ) { + global $wp_query, $wpdb; + + $classes = array(); + + if ( is_rtl() ) + $classes[] = 'rtl'; + + if ( is_front_page() ) + $classes[] = 'home'; + if ( is_home() ) + $classes[] = 'blog'; + if ( is_archive() ) + $classes[] = 'archive'; + if ( is_date() ) + $classes[] = 'date'; + if ( is_search() ) { + $classes[] = 'search'; + $classes[] = $wp_query->posts ? 'search-results' : 'search-no-results'; + } + if ( is_paged() ) + $classes[] = 'paged'; + if ( is_attachment() ) + $classes[] = 'attachment'; + if ( is_404() ) + $classes[] = 'error404'; + + if ( is_single() ) { + $post_id = $wp_query->get_queried_object_id(); + $post = $wp_query->get_queried_object(); + + $classes[] = 'single'; + if ( isset( $post->post_type ) ) { + $classes[] = 'single-' . sanitize_html_class($post->post_type, $post_id); + $classes[] = 'postid-' . $post_id; + + // Post Format + if ( post_type_supports( $post->post_type, 'post-formats' ) ) { + $post_format = get_post_format( $post->ID ); + + if ( $post_format && !is_wp_error($post_format) ) + $classes[] = 'single-format-' . sanitize_html_class( $post_format ); + else + $classes[] = 'single-format-standard'; + } + } + + if ( is_attachment() ) { + $mime_type = get_post_mime_type($post_id); + $mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' ); + $classes[] = 'attachmentid-' . $post_id; + $classes[] = 'attachment-' . str_replace( $mime_prefix, '', $mime_type ); + } + } elseif ( is_archive() ) { + if ( is_post_type_archive() ) { + $classes[] = 'post-type-archive'; + $post_type = get_query_var( 'post_type' ); + if ( is_array( $post_type ) ) + $post_type = reset( $post_type ); + $classes[] = 'post-type-archive-' . sanitize_html_class( $post_type ); + } elseif ( is_author() ) { + $author = $wp_query->get_queried_object(); + $classes[] = 'author'; + if ( isset( $author->user_nicename ) ) { + $classes[] = 'author-' . sanitize_html_class( $author->user_nicename, $author->ID ); + $classes[] = 'author-' . $author->ID; + } + } elseif ( is_category() ) { + $cat = $wp_query->get_queried_object(); + $classes[] = 'category'; + if ( isset( $cat->term_id ) ) { + $cat_class = sanitize_html_class( $cat->slug, $cat->term_id ); + if ( is_numeric( $cat_class ) || ! trim( $cat_class, '-' ) ) { + $cat_class = $cat->term_id; + } + + $classes[] = 'category-' . $cat_class; + $classes[] = 'category-' . $cat->term_id; + } + } elseif ( is_tag() ) { + $tag = $wp_query->get_queried_object(); + $classes[] = 'tag'; + if ( isset( $tag->term_id ) ) { + $tag_class = sanitize_html_class( $tag->slug, $tag->term_id ); + if ( is_numeric( $tag_class ) || ! trim( $tag_class, '-' ) ) { + $tag_class = $tag->term_id; + } + + $classes[] = 'tag-' . $tag_class; + $classes[] = 'tag-' . $tag->term_id; + } + } elseif ( is_tax() ) { + $term = $wp_query->get_queried_object(); + if ( isset( $term->term_id ) ) { + $term_class = sanitize_html_class( $term->slug, $term->term_id ); + if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) { + $term_class = $term->term_id; + } + + $classes[] = 'tax-' . sanitize_html_class( $term->taxonomy ); + $classes[] = 'term-' . $term_class; + $classes[] = 'term-' . $term->term_id; + } + } + } elseif ( is_page() ) { + $classes[] = 'page'; + + $page_id = $wp_query->get_queried_object_id(); + + $post = get_post($page_id); + + $classes[] = 'page-id-' . $page_id; + + if ( get_pages( array( 'parent' => $page_id, 'number' => 1 ) ) ) { + $classes[] = 'page-parent'; + } + + if ( $post->post_parent ) { + $classes[] = 'page-child'; + $classes[] = 'parent-pageid-' . $post->post_parent; + } + if ( is_page_template() ) { + $classes[] = 'page-template'; + + $template_slug = get_page_template_slug( $page_id ); + $template_parts = explode( '/', $template_slug ); + + foreach ( $template_parts as $part ) { + $classes[] = 'page-template-' . sanitize_html_class( str_replace( array( '.', '/' ), '-', basename( $part, '.php' ) ) ); + } + $classes[] = 'page-template-' . sanitize_html_class( str_replace( '.', '-', $template_slug ) ); + } else { + $classes[] = 'page-template-default'; + } + } + + if ( is_user_logged_in() ) + $classes[] = 'logged-in'; + + if ( is_admin_bar_showing() ) { + $classes[] = 'admin-bar'; + $classes[] = 'no-customize-support'; + } + + if ( get_background_color() !== get_theme_support( 'custom-background', 'default-color' ) || get_background_image() ) + $classes[] = 'custom-background'; + + $page = $wp_query->get( 'page' ); + + if ( ! $page || $page < 2 ) + $page = $wp_query->get( 'paged' ); + + if ( $page && $page > 1 && ! is_404() ) { + $classes[] = 'paged-' . $page; + + if ( is_single() ) + $classes[] = 'single-paged-' . $page; + elseif ( is_page() ) + $classes[] = 'page-paged-' . $page; + elseif ( is_category() ) + $classes[] = 'category-paged-' . $page; + elseif ( is_tag() ) + $classes[] = 'tag-paged-' . $page; + elseif ( is_date() ) + $classes[] = 'date-paged-' . $page; + elseif ( is_author() ) + $classes[] = 'author-paged-' . $page; + elseif ( is_search() ) + $classes[] = 'search-paged-' . $page; + elseif ( is_post_type_archive() ) + $classes[] = 'post-type-paged-' . $page; + } + + if ( ! empty( $class ) ) { + if ( !is_array( $class ) ) + $class = preg_split( '#\s+#', $class ); + $classes = array_merge( $classes, $class ); + } else { + // Ensure that we always coerce class to being an array. + $class = array(); + } + + $classes = array_map( 'esc_attr', $classes ); + + /** + * Filter the list of CSS body classes for the current post or page. + * + * @since 2.8.0 + * + * @param array $classes An array of body classes. + * @param string $class A comma-separated list of additional classes added to the body. + */ + $classes = apply_filters( 'body_class', $classes, $class ); + + return array_unique( $classes ); +} + +/** + * Whether post requires password and correct password has been provided. + * + * @since 2.7.0 + * + * @param int|WP_Post|null $post An optional post. Global $post used if not provided. + * @return bool false if a password is not required or the correct password cookie is present, true otherwise. + */ +function post_password_required( $post = null ) { + $post = get_post($post); + + if ( empty( $post->post_password ) ) + return false; + + if ( ! isset( $_COOKIE['wp-postpass_' . COOKIEHASH] ) ) + return true; + + require_once ABSPATH . WPINC . '/class-phpass.php'; + $hasher = new PasswordHash( 8, true ); + + $hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] ); + if ( 0 !== strpos( $hash, '$P$B' ) ) + return true; + + return ! $hasher->CheckPassword( $post->post_password, $hash ); +} + +// +// Page Template Functions for usage in Themes +// + +/** + * The formatted output of a list of pages. + * + * Displays page links for paginated posts (i.e. includes the . + * Quicktag one or more times). This tag must be within The Loop. + * + * @since 1.2.0 + * + * @global int $page + * @global int $numpages + * @global int $multipage + * @global int $more + * + * @param string|array $args { + * Optional. Array or string of default arguments. + * + * @type string $before HTML or text to prepend to each link. Default is `

Pages:`. + * @type string $after HTML or text to append to each link. Default is `

`. + * @type string $link_before HTML or text to prepend to each link, inside the `` tag. + * Also prepended to the current item, which is not linked. Default empty. + * @type string $link_after HTML or text to append to each Pages link inside the `` tag. + * Also appended to the current item, which is not linked. Default empty. + * @type string $next_or_number Indicates whether page numbers should be used. Valid values are number + * and next. Default is 'number'. + * @type string $separator Text between pagination links. Default is ' '. + * @type string $nextpagelink Link text for the next page link, if available. Default is 'Next Page'. + * @type string $previouspagelink Link text for the previous page link, if available. Default is 'Previous Page'. + * @type string $pagelink Format string for page numbers. The % in the parameter string will be + * replaced with the page number, so 'Page %' generates "Page 1", "Page 2", etc. + * Defaults to '%', just the page number. + * @type int|bool $echo Whether to echo or not. Accepts 1|true or 0|false. Default 1|true. + * } + * @return string Formatted output in HTML. + */ +function wp_link_pages( $args = '' ) { + global $page, $numpages, $multipage, $more; + $defaults = array( - 'before' => '

' . __('Pages:'), 'after' => '

', - 'next_or_number' => 'number', 'nextpagelink' => __('Next page'), - 'previouspagelink' => __('Previous page'), 'pagelink' => '%', - 'more_file' => '', 'echo' => 1 + 'before' => '

' . __( 'Pages:' ), + 'after' => '

', + 'link_before' => '', + 'link_after' => '', + 'next_or_number' => 'number', + 'separator' => ' ', + 'nextpagelink' => __( 'Next page' ), + 'previouspagelink' => __( 'Previous page' ), + 'pagelink' => '%', + 'echo' => 1 ); - $r = wp_parse_args( $args, $defaults ); - extract( $r, EXTR_SKIP ); + $params = wp_parse_args( $args, $defaults ); - global $post, $id, $page, $numpages, $multipage, $more, $pagenow; - if ( $more_file != '' ) - $file = $more_file; - else - $file = $pagenow; + /** + * Filter the arguments used in retrieving page links for paginated posts. + * + * @since 3.0.0 + * + * @param array $params An array of arguments for page links for paginated posts. + */ + $r = apply_filters( 'wp_link_pages_args', $params ); $output = ''; if ( $multipage ) { - if ( 'number' == $next_or_number ) { - $output .= $before; - for ( $i = 1; $i < ($numpages+1); $i = $i + 1 ) { - $j = str_replace('%',"$i",$pagelink); - $output .= ' '; - if ( ($i != $page) || ((!$more) && ($page==1)) ) { - if ( 1 == $i ) { - $output .= ''; - } else { - if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) ) - $output .= ''; - else - $output .= ''; - } + if ( 'number' == $r['next_or_number'] ) { + $output .= $r['before']; + for ( $i = 1; $i <= $numpages; $i++ ) { + $link = $r['link_before'] . str_replace( '%', $i, $r['pagelink'] ) . $r['link_after']; + if ( $i != $page || ! $more && 1 == $page ) { + $link = _wp_link_page( $i ) . $link . ''; } - $output .= $j; - if ( ($i != $page) || ((!$more) && ($page==1)) ) - $output .= ''; + /** + * Filter the HTML output of individual page number links. + * + * @since 3.6.0 + * + * @param string $link The page number HTML output. + * @param int $i Page number for paginated posts' page links. + */ + $link = apply_filters( 'wp_link_pages_link', $link, $i ); + + // Use the custom links separator beginning with the second link. + $output .= ( 1 === $i ) ? ' ' : $r['separator']; + $output .= $link; } - $output .= $after; - } else { - if ( $more ) { - $output .= $before; - $i = $page - 1; - if ( $i && $more ) { - if ( 1 == $i ) { - $output .= '' . $previouspagelink . ''; - } else { - if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) ) - $output .= '' . $previouspagelink . ''; - else - $output .= '' . $previouspagelink . ''; - } - } - $i = $page + 1; - if ( $i <= $numpages && $more ) { - if ( 1 == $i ) { - $output .= '' . $nextpagelink . ''; - } else { - if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) ) - $output .= '' . $nextpagelink . ''; - else - $output .= '' . $nextpagelink . ''; - } + $output .= $r['after']; + } elseif ( $more ) { + $output .= $r['before']; + $prev = $page - 1; + if ( $prev ) { + $link = _wp_link_page( $prev ) . $r['link_before'] . $r['previouspagelink'] . $r['link_after'] . ''; + + /** This filter is documented in wp-includes/post-template.php */ + $output .= apply_filters( 'wp_link_pages_link', $link, $prev ); + } + $next = $page + 1; + if ( $next <= $numpages ) { + if ( $prev ) { + $output .= $r['separator']; } - $output .= $after; + $link = _wp_link_page( $next ) . $r['link_before'] . $r['nextpagelink'] . $r['link_after'] . ''; + + /** This filter is documented in wp-includes/post-template.php */ + $output .= apply_filters( 'wp_link_pages_link', $link, $next ); } + $output .= $r['after']; } } - if ( $echo ) - echo $output; - - return $output; + /** + * Filter the HTML output of page links for paginated posts. + * + * @since 3.6.0 + * + * @param string $output HTML output of paginated posts' page links. + * @param array $args An array of arguments. + */ + $html = apply_filters( 'wp_link_pages', $output, $args ); + + if ( $r['echo'] ) { + echo $html; + } + return $html; } +/** + * Helper function for wp_link_pages(). + * + * @since 3.1.0 + * @access private + * + * @global WP_Rewrite $wp_rewrite + * + * @param int $i Page number. + * @return string Link. + */ +function _wp_link_page( $i ) { + global $wp_rewrite; + $post = get_post(); + + if ( 1 == $i ) { + $url = get_permalink(); + } else { + if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) ) + $url = add_query_arg( 'page', $i, get_permalink() ); + elseif ( 'page' == get_option('show_on_front') && get_option('page_on_front') == $post->ID ) + $url = trailingslashit(get_permalink()) . user_trailingslashit("$wp_rewrite->pagination_base/" . $i, 'single_paged'); + else + $url = trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged'); + } + + if ( is_preview() ) { + $url = add_query_arg( array( + 'preview' => 'true' + ), $url ); + + if ( ( 'draft' !== $post->post_status ) && isset( $_GET['preview_id'], $_GET['preview_nonce'] ) ) { + $url = add_query_arg( array( + 'preview_id' => wp_unslash( $_GET['preview_id'] ), + 'preview_nonce' => wp_unslash( $_GET['preview_nonce'] ) + ), $url ); + } + } + + return ''; +} // // Post-meta: Custom per-post fields. // - +/** + * Retrieve post custom meta data field. + * + * @since 1.5.0 + * + * @param string $key Meta data key name. + * @return false|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist. + */ function post_custom( $key = '' ) { $custom = get_post_custom(); - if ( 1 == count($custom[$key]) ) + if ( !isset( $custom[$key] ) ) + return false; + elseif ( 1 == count($custom[$key]) ) return $custom[$key][0]; else return $custom[$key]; } - -// this will probably change at some point... +/** + * Display list of post custom fields. + * + * @internal This will probably change at some point... + * @since 1.2.0 + */ function the_meta() { - global $id; - if ( $keys = get_post_custom_keys() ) { echo "\n"; } } - // // Pages // -function wp_dropdown_pages($args = '') { +/** + * Retrieve or display list of pages as a dropdown (select list). + * + * @since 2.1.0 + * @since 4.2.0 The `$value_field` argument was added. + * @since 4.3.0 The `$class` argument was added. + * + * @param array|string $args { + * Optional. Array or string of arguments to generate a pages drop-down element. + * + * @type int $depth Maximum depth. Default 0. + * @type int $child_of Page ID to retrieve child pages of. Default 0. + * @type int|string $selected Value of the option that should be selected. Default 0. + * @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1, + * or their bool equivalents. Default 1. + * @type string $name Value for the 'name' attribute of the select element. + * Default 'page_id'. + * @type string $id Value for the 'id' attribute of the select element. + * @type string $class Value for the 'class' attribute of the select element. Default: none. + * Defaults to the value of `$name`. + * @type string $show_option_none Text to display for showing no pages. Default empty (does not display). + * @type string $show_option_no_change Text to display for "no change" option. Default empty (does not display). + * @type string $option_none_value Value to use when no page is selected. Default empty. + * @type string $value_field Post field used to populate the 'value' attribute of the option + * elements. Accepts any valid post field. Default 'ID'. + * } + * @return string HTML content, if not displaying. + */ +function wp_dropdown_pages( $args = '' ) { $defaults = array( 'depth' => 0, 'child_of' => 0, 'selected' => 0, 'echo' => 1, - 'name' => 'page_id', 'show_option_none' => '' + 'name' => 'page_id', 'id' => '', + 'class' => '', + 'show_option_none' => '', 'show_option_no_change' => '', + 'option_none_value' => '', + 'value_field' => 'ID', ); $r = wp_parse_args( $args, $defaults ); - extract( $r, EXTR_SKIP ); - $pages = get_pages($r); + $pages = get_pages( $r ); $output = ''; - - if ( ! empty($pages) ) { - $output = "\n"; + // Back-compat with old system where both id and name were based on $name argument + if ( empty( $r['id'] ) ) { + $r['id'] = $r['name']; } - $output = apply_filters('wp_dropdown_pages', $output); + if ( ! empty( $pages ) ) { + $class = ''; + if ( ! empty( $r['class'] ) ) { + $class = " class='" . esc_attr( $r['class'] ) . "'"; + } - if ( $echo ) - echo $output; + $output = "\n"; + } - return $output; + /** + * Filter the HTML output of a list of pages as a drop down. + * + * @since 2.1.0 + * + * @param string $output HTML output for drop down list of pages. + */ + $html = apply_filters( 'wp_dropdown_pages', $output ); + + if ( $r['echo'] ) { + echo $html; + } + return $html; } -function wp_list_pages($args = '') { +/** + * Retrieve or display list of pages in list (li) format. + * + * @since 1.5.0 + * + * @see get_pages() + * + * @global WP_Query $wp_query + * + * @param array|string $args { + * Array or string of arguments. Optional. + * + * @type int $child_of Display only the sub-pages of a single page by ID. Default 0 (all pages). + * @type string $authors Comma-separated list of author IDs. Default empty (all authors). + * @type string $date_format PHP date format to use for the listed pages. Relies on the 'show_date' parameter. + * Default is the value of 'date_format' option. + * @type int $depth Number of levels in the hierarchy of pages to include in the generated list. + * Accepts -1 (any depth), 0 (all pages), 1 (top-level pages only), and n (pages to + * the given n depth). Default 0. + * @type bool $echo Whether or not to echo the list of pages. Default true. + * @type string $exclude Comma-separated list of page IDs to exclude. Default empty. + * @type array $include Comma-separated list of page IDs to include. Default empty. + * @type string $link_after Text or HTML to follow the page link label. Default null. + * @type string $link_before Text or HTML to precede the page link label. Default null. + * @type string $post_type Post type to query for. Default 'page'. + * @type string $post_status Comma-separated list of post statuses to include. Default 'publish'. + * @type string $show_date Whether to display the page publish or modified date for each page. Accepts + * 'modified' or any other value. An empty value hides the date. Default empty. + * @type string $sort_column Comma-separated list of column names to sort the pages by. Accepts 'post_author', + * 'post_date', 'post_title', 'post_name', 'post_modified', 'post_modified_gmt', + * 'menu_order', 'post_parent', 'ID', 'rand', or 'comment_count'. Default 'post_title'. + * @type string $title_li List heading. Passing a null or empty value will result in no heading, and the list + * will not be wrapped with unordered list `