X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/a6f44f0edcda2471c5a33e4156c1c9488c7f3210..refs/tags/wordpress-4.4:/wp-includes/post-template.php diff --git a/wp-includes/post-template.php b/wp-includes/post-template.php index fb8d1585..3164509b 100644 --- a/wp-includes/post-template.php +++ b/wp-includes/post-template.php @@ -21,12 +21,12 @@ function the_ID() { * Retrieve the ID of the current item in the WordPress Loop. * * @since 2.1.0 - * @uses $post * - * @return int + * @return int|false The ID of the current item in the WordPress Loop. False if $post is not set. */ function get_the_ID() { - return get_post()->ID; + $post = get_post(); + return ! empty( $post ) ? $post->ID : false; } /** @@ -35,11 +35,11 @@ function get_the_ID() { * @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 null|string Null on no title. String if $echo parameter is false. + * @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) { +function the_title( $before = '', $after = '', $echo = true ) { $title = get_the_title(); if ( strlen($title) == 0 ) @@ -65,26 +65,34 @@ function the_title($before = '', $after = '', $echo = true) { * * @since 2.3.0 * - * @param string|array $args Optional. Override the defaults. - * @return string|null Null on failure or display. String when echo is false. + * @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 = '' ) { - $defaults = array('before' => '', 'after' => '', 'echo' => true, 'post' => get_post() ); - $r = wp_parse_args($args, $defaults); - extract( $r, EXTR_SKIP ); + $defaults = array( 'before' => '', 'after' => '', 'echo' => true, 'post' => get_post() ); + $r = wp_parse_args( $args, $defaults ); - $title = get_the_title( $post ); + $title = get_the_title( $r['post'] ); - if ( strlen($title) == 0 ) + if ( strlen( $title ) == 0 ) { return; + } - $title = $before . $title . $after; - $title = esc_attr(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; + } } /** @@ -96,7 +104,7 @@ function the_title_attribute( $args = '' ) { * * @since 0.71 * - * @param int|object $post Optional. Post ID or object. + * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. * @return string */ function get_the_title( $post = 0 ) { @@ -107,14 +115,46 @@ function get_the_title( $post = 0 ) { if ( ! is_admin() ) { if ( ! empty( $post->post_password ) ) { - $protected_title_format = apply_filters( 'protected_title_format', __( 'Protected: %s' ) ); + + /** + * 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 ); - } else if ( isset( $post->post_status ) && 'private' == $post->post_status ) { - $private_title_format = apply_filters( 'private_title_format', __( 'Private: %s' ) ); + } 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 ); } } + /** + * 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 ); } @@ -129,10 +169,19 @@ function get_the_title( $post = 0 ) { * * @since 1.5.0 * - * @param int $id Optional. Post ID. + * @param int|WP_Post $id Optional. Post ID or post object. */ function the_guid( $id = 0 ) { - echo esc_url( 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 ) ); } /** @@ -144,13 +193,20 @@ function the_guid( $id = 0 ) { * * @since 1.5.0 * - * @param int $id Optional. Post ID. + * @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); + /** + * 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 ); } /** @@ -159,10 +215,18 @@ function get_the_guid( $id = 0 ) { * @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. + * @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; @@ -173,8 +237,14 @@ function the_content( $more_link_text = null, $strip_teaser = false) { * * @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 $stripteaser Optional. Strip teaser content before the more text. Default is false. + * @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 ) { @@ -221,23 +291,33 @@ function get_the_content( $more_link_text = null, $strip_teaser = false ) { $output .= '' . $content[1]; } else { 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 + 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 + * Preview fix for JavaScript bug with foreign languages. * * @since 3.1.0 * @access private - * @param array $match Match array from preg_replace_callback + * + * @param array $match Match array from preg_replace_callback. * @return string */ function _convert_urlencoded_to_entities( $match ) { @@ -248,10 +328,19 @@ function _convert_urlencoded_to_entities( $match ) { * Display the post excerpt. * * @since 0.71 - * @uses apply_filters() Calls 'the_excerpt' hook on post excerpt. */ 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() ); } /** @@ -267,11 +356,21 @@ function get_the_excerpt( $deprecated = '' ) { _deprecated_argument( __FUNCTION__, '2.3' ); $post = get_post(); + if ( empty( $post ) ) { + return ''; + } if ( post_password_required() ) { return __( 'There is no excerpt because this is a protected post.' ); } + /** + * 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 ); } @@ -280,7 +379,7 @@ function get_the_excerpt( $deprecated = '' ) { * * @since 2.3.0 * - * @param int $id Optional. Post ID. + * @param int|WP_Post $id Optional. Post ID or post object. * @return bool */ function has_excerpt( $id = 0 ) { @@ -293,8 +392,8 @@ function has_excerpt( $id = 0 ) { * * @since 2.7.0 * - * @param string|array $class One or more classes to add to the class list. - * @param int $post_id An optional post ID. + * @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. Defaults to the global `$post`. */ function post_class( $class = '', $post_id = null ) { // Separates classes with a single space, collates classes for post DIV @@ -304,27 +403,40 @@ function post_class( $class = '', $post_id = null ) { /** * Retrieve the classes for the post div as an array. * - * The class names are add are many. If the post is a sticky, then the 'sticky' - * class name. The class 'hentry' is always added to each post. For each - * category, the class will be added with 'category-' with category slug is - * added. The tags are the same way as the categories with 'tag-' before the tag - * slug. 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. + * 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 $post_id An optional post ID. + * @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); + $post = get_post( $post_id ); $classes = array(); - if ( empty($post) ) + if ( $class ) { + if ( ! is_array( $class ) ) { + $class = preg_split( '#\s+#', $class ); + } + $classes = array_map( 'esc_attr', $class ); + } else { + // Ensure that we always coerce class to being an array. + $class = array(); + } + + if ( ! $post ) { return $classes; + } $classes[] = 'post-' . $post->ID; if ( ! is_admin() ) @@ -342,44 +454,70 @@ function get_post_class( $class = '', $post_id = null ) { $classes[] = 'format-standard'; } - // post requires password - if ( post_password_required($post->ID) ) + $post_password_required = post_password_required( $post->ID ); + + // Post requires password. + if ( $post_password_required ) { $classes[] = 'post-password-required'; + } elseif ( ! empty( $post->post_password ) ) { + $classes[] = 'post-password-protected'; + } + + // Post thumbnails. + if ( current_theme_supports( 'post-thumbnails' ) && has_post_thumbnail( $post->ID ) && ! is_attachment( $post ) && ! $post_password_required ) { + $classes[] = 'has-post-thumbnail'; + } // sticky for Sticky Posts - if ( is_sticky($post->ID) && is_home() && !is_paged() ) - $classes[] = 'sticky'; + if ( is_sticky( $post->ID ) ) { + if ( is_home() && ! is_paged() ) { + $classes[] = 'sticky'; + } elseif ( is_admin() ) { + $classes[] = 'status-sticky'; + } + } // hentry for hAtom compliance $classes[] = 'hentry'; - // Categories - if ( is_object_in_taxonomy( $post->post_type, 'category' ) ) { - foreach ( (array) get_the_category($post->ID) as $cat ) { - if ( empty($cat->slug ) ) - continue; - $classes[] = 'category-' . sanitize_html_class($cat->slug, $cat->term_id); - } - } - - // Tags - if ( is_object_in_taxonomy( $post->post_type, 'post_tag' ) ) { - foreach ( (array) get_the_tags($post->ID) as $tag ) { - if ( empty($tag->slug ) ) - continue; - $classes[] = 'tag-' . sanitize_html_class($tag->slug, $tag->term_id); + // 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 ); + } + } } } - if ( !empty($class) ) { - if ( !is_array( $class ) ) - $class = preg_split('#\s+#', $class); - $classes = array_merge($classes, $class); - } + $classes = array_map( 'esc_attr', $classes ); - $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 array $class An array of additional classes added to the post. + * @param int $post_id The post ID. + */ + $classes = apply_filters( 'post_class', $classes, $class, $post->ID ); - return apply_filters('post_class', $classes, $class, $post->ID); + return array_unique( $classes ); } /** @@ -399,11 +537,13 @@ function body_class( $class = '' ) { * * @since 2.8.0 * + * @global WP_Query $wp_query + * * @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; + global $wp_query; $classes = array(); @@ -458,8 +598,11 @@ function get_body_class( $class = '' ) { } elseif ( is_archive() ) { if ( is_post_type_archive() ) { $classes[] = 'post-type-archive'; - $classes[] = 'post-type-archive-' . sanitize_html_class( get_query_var( 'post_type' ) ); - } else if ( is_author() ) { + $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 ) ) { @@ -470,21 +613,36 @@ function get_body_class( $class = '' ) { $cat = $wp_query->get_queried_object(); $classes[] = 'category'; if ( isset( $cat->term_id ) ) { - $classes[] = 'category-' . sanitize_html_class( $cat->slug, $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() ) { - $tags = $wp_query->get_queried_object(); + $tag = $wp_query->get_queried_object(); $classes[] = 'tag'; - if ( isset( $tags->term_id ) ) { - $classes[] = 'tag-' . sanitize_html_class( $tags->slug, $tags->term_id ); - $classes[] = 'tag-' . $tags->term_id; + 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-' . sanitize_html_class( $term->slug, $term->term_id ); + $classes[] = 'term-' . $term_class; $classes[] = 'term-' . $term->term_id; } } @@ -497,8 +655,9 @@ function get_body_class( $class = '' ) { $classes[] = 'page-id-' . $page_id; - if ( $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status = 'publish' LIMIT 1", $page_id) ) ) + if ( get_pages( array( 'parent' => $page_id, 'number' => 1 ) ) ) { $classes[] = 'page-parent'; + } if ( $post->post_parent ) { $classes[] = 'page-child'; @@ -506,7 +665,14 @@ function get_body_class( $class = '' ) { } if ( is_page_template() ) { $classes[] = 'page-template'; - $classes[] = 'page-template-' . sanitize_html_class( str_replace( '.', '-', get_page_template_slug( $page_id ) ) ); + + $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'; } @@ -520,15 +686,15 @@ function get_body_class( $class = '' ) { $classes[] = 'no-customize-support'; } - if ( get_theme_mod( 'background_color' ) || get_background_image() ) + 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) + if ( ! $page || $page < 2 ) $page = $wp_query->get( 'paged' ); - if ( $page && $page > 1 ) { + if ( $page && $page > 1 && ! is_404() ) { $classes[] = 'paged-' . $page; if ( is_single() ) @@ -560,7 +726,17 @@ function get_body_class( $class = '' ) { $classes = array_map( 'esc_attr', $classes ); - return apply_filters( 'body_class', $classes, $class ); + /** + * 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 array $class An array of additional classes added to the body. + */ + $classes = apply_filters( 'body_class', $classes, $class ); + + return array_unique( $classes ); } /** @@ -568,7 +744,7 @@ function get_body_class( $class = '' ) { * * @since 2.7.0 * - * @param int|WP_Post $post An optional post. Global $post used if not provided. + * @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 ) { @@ -580,7 +756,7 @@ function post_password_required( $post = null ) { if ( ! isset( $_COOKIE['wp-postpass_' . COOKIEHASH] ) ) return true; - require_once ABSPATH . 'wp-includes/class-phpass.php'; + require_once ABSPATH . WPINC . '/class-phpass.php'; $hasher = new PasswordHash( 8, true ); $hash = wp_unslash( $_COOKIE[ 'wp-postpass_' . COOKIEHASH ] ); @@ -590,12 +766,9 @@ function post_password_required( $post = null ) { return ! $hasher->CheckPassword( $post->post_password, $hash ); } -/** - * Page Template Functions for usage in Themes - * - * @package WordPress - * @subpackage Template - */ +// +// Page Template Functions for usage in Themes +// /** * The formatted output of a list of pages. @@ -603,36 +776,37 @@ function post_password_required( $post = null ) { * Displays page links for paginated posts (i.e. includes the . * Quicktag one or more times). This tag must be within The Loop. * - * The defaults for overwriting are: - * 'before' - Default is '

Pages:' (string). The html or text to prepend to - * each bookmarks. - * 'after' - Default is '

' (string). The html or text to append to each - * bookmarks. - * 'link_before' - Default is '' (string). The html or text to prepend to each - * Pages link inside the tag. Also prepended to the current item, which - * is not linked. - * 'link_after' - Default is '' (string). The html or text to append to each - * Pages link inside the tag. Also appended to the current item, which - * is not linked. - * 'next_or_number' - Default is 'number' (string). Indicates whether page - * numbers should be used. Valid values are number and next. - * 'separator' - Default is ' ' (string). Text used between pagination links. - * 'nextpagelink' - Default is 'Next Page' (string). Text for link to next page. - * of the bookmark. - * 'previouspagelink' - Default is 'Previous Page' (string). Text for link to - * previous page, if available. - * 'pagelink' - Default is '%' (String).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. - * 'echo' - Default is 1 (integer). When not 0, this triggers the HTML to be - * echoed and then returned. - * * @since 1.2.0 * - * @param string|array $args Optional. Overwrite the defaults. + * @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' => '

', @@ -646,48 +820,78 @@ function wp_link_pages( $args = '' ) { 'echo' => 1 ); - $r = wp_parse_args( $args, $defaults ); - $r = apply_filters( 'wp_link_pages_args', $r ); - extract( $r, EXTR_SKIP ); + $params = wp_parse_args( $args, $defaults ); - global $page, $numpages, $multipage, $more, $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; + if ( 'number' == $r['next_or_number'] ) { + $output .= $r['before']; for ( $i = 1; $i <= $numpages; $i++ ) { - $link = $link_before . str_replace( '%', $i, $pagelink ) . $link_after; - if ( $i != $page || ! $more && 1 == $page ) + $link = $r['link_before'] . str_replace( '%', $i, $r['pagelink'] ) . $r['link_after']; + if ( $i != $page || ! $more && 1 == $page ) { $link = _wp_link_page( $i ) . $link . ''; + } + /** + * 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 ); - $output .= $separator . $link; + + // Use the custom links separator beginning with the second link. + $output .= ( 1 === $i ) ? ' ' : $r['separator']; + $output .= $link; } - $output .= $after; + $output .= $r['after']; } elseif ( $more ) { - $output .= $before; - $i = $page - 1; - if ( $i ) { - $link = _wp_link_page( $i ) . $link_before . $previouspagelink . $link_after . ''; - $link = apply_filters( 'wp_link_pages_link', $link, $i ); - $output .= $separator . $link; + $output .= $r['before']; + $prev = $page - 1; + if ( $prev > 0 ) { + $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 ); } - $i = $page + 1; - if ( $i <= $numpages ) { - $link = _wp_link_page( $i ) . $link_before . $nextpagelink . $link_after . ''; - $link = apply_filters( 'wp_link_pages_link', $link, $i ); - $output .= $separator . $link; + $next = $page + 1; + if ( $next <= $numpages ) { + if ( $prev ) { + $output .= $r['separator']; + } + $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 .= $after; + $output .= $r['after']; } } - $output = apply_filters( 'wp_link_pages', $output, $args ); - - if ( $echo ) - echo $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 ); - return $output; + if ( $r['echo'] ) { + echo $html; + } + return $html; } /** @@ -696,12 +900,15 @@ function wp_link_pages( $args = '' ) { * @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(); + $query_args = array(); if ( 1 == $i ) { $url = get_permalink(); @@ -714,6 +921,16 @@ function _wp_link_page( $i ) { $url = trailingslashit(get_permalink()) . user_trailingslashit($i, 'single_paged'); } + if ( is_preview() ) { + + if ( ( 'draft' !== $post->post_status ) && isset( $_GET['preview_id'], $_GET['preview_nonce'] ) ) { + $query_args['preview_id'] = wp_unslash( $_GET['preview_id'] ); + $query_args['preview_nonce'] = wp_unslash( $_GET['preview_nonce'] ); + } + + $url = get_preview_post_link( $post, $query_args, $url ); + } + return ''; } @@ -727,7 +944,7 @@ function _wp_link_page( $i ) { * @since 1.5.0 * * @param string $key Meta data key name. - * @return bool|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist. + * @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(); @@ -743,9 +960,10 @@ function post_custom( $key = '' ) { /** * Display list of post custom fields. * - * @internal This will probably change at some point... * @since 1.2.0 - * @uses apply_filters() Calls 'the_meta_key' on list item HTML content, with key and value as separate parameters. + * + * @internal This will probably change at some point... + * */ function the_meta() { if ( $keys = get_post_custom_keys() ) { @@ -756,7 +974,17 @@ function the_meta() { continue; $values = array_map('trim', get_post_custom_values($key)); $value = implode($values,', '); - echo apply_filters('the_meta_key', "
  • $key: $value
    • \n", $key, $value); + + /** + * Filter the HTML output of the li element in the post custom fields list. + * + * @since 2.2.0 + * + * @param string $html The HTML output for the li element. + * @param string $key Meta key. + * @param string $value Meta value. + */ + echo apply_filters( 'the_meta_key', "
  • $key: $value
    • \n", $key, $value ); } echo "\n"; } @@ -770,44 +998,83 @@ function the_meta() { * Retrieve or display list of pages as a dropdown (select list). * * @since 2.1.0 - * - * @param array|string $args Optional. Override default arguments. + * @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 = '') { +function wp_dropdown_pages( $args = '' ) { $defaults = array( 'depth' => 0, 'child_of' => 0, 'selected' => 0, 'echo' => 1, 'name' => 'page_id', 'id' => '', + 'class' => '', 'show_option_none' => '', 'show_option_no_change' => '', - 'option_none_value' => '' + '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 = ''; // Back-compat with old system where both id and name were based on $name argument - if ( empty($id) ) - $id = $name; - - if ( ! empty($pages) ) { - $output = "\n"; + 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 + * @since 4.4.0 `$r` and `$pages` added as arguments. + * + * @param string $output HTML output for drop down list of pages. + * @param array $r The parsed arguments array. + * @param array $pages List of WP_Post objects returned by `get_pages()` + */ + $html = apply_filters( 'wp_dropdown_pages', $output, $r, $pages ); + + if ( $r['echo'] ) { + echo $html; + } + return $html; } /** @@ -815,55 +1082,112 @@ function wp_dropdown_pages($args = '') { * * @since 1.5.0 * - * @param array|string $args Optional. Override default arguments. - * @return string HTML content, if not displaying. + * @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 `