diff -r 53cff4b4a802 -r bde1974c263b web/wp-includes/post-template.php --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/web/wp-includes/post-template.php Wed Feb 03 15:37:20 2010 +0000 @@ -0,0 +1,1355 @@ + '', 'after' => '', 'echo' => true); + $r = wp_parse_args($args, $defaults); + extract( $r, EXTR_SKIP ); + + + $title = $before . $title . $after; + $title = esc_attr(strip_tags($title)); + + if ( $echo ) + echo $title; + else + return $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 $id Optional. Post ID. + * @return string + */ +function get_the_title( $id = 0 ) { + $post = &get_post($id); + + $title = $post->post_title; + + if ( !is_admin() ) { + if ( !empty($post->post_password) ) { + $protected_title_format = apply_filters('protected_title_format', __('Protected: %s')); + $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')); + $title = sprintf($private_title_format, $title); + } + } + return apply_filters( 'the_title', $title, $post->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. + * + * @since 1.5.0 + * + * @param int $id Optional. Post ID. + */ +function the_guid( $id = 0 ) { + echo 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 $id Optional. Post ID. + * @return string + */ +function get_the_guid( $id = 0 ) { + $post = &get_post($id); + + return apply_filters('get_the_guid', $post->guid); +} + +/** + * Display the post content. + * + * @since 0.71 + * + * @param string $more_link_text Optional. Content for when there is more text. + * @param string $stripteaser Optional. Teaser content before the more text. + */ +function the_content($more_link_text = null, $stripteaser = 0) { + $content = get_the_content($more_link_text, $stripteaser); + $content = apply_filters('the_content', $content); + $content = str_replace(']]>', ']]>', $content); + echo $content; +} + +/** + * Retrieve the post content. + * + * @since 0.71 + * + * @param string $more_link_text Optional. Content for when there is more text. + * @param string $stripteaser Optional. Teaser content before the more text. + * @return string + */ +function get_the_content($more_link_text = null, $stripteaser = 0) { + global $id, $post, $more, $page, $pages, $multipage, $preview, $pagenow; + + if ( null === $more_link_text ) + $more_link_text = __( '(more...)' ); + + $output = ''; + $hasTeaser = false; + + // If post password required and it doesn't match the cookie. + if ( post_password_required($post) ) { + $output = get_the_password_form(); + return $output; + } + + 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]))); + + $hasTeaser = true; + } else { + $content = array($content); + } + if ( (false !== strpos($post->post_content, '') && ((!$multipage) || ($page==1))) ) + $stripteaser = 1; + $teaser = $content[0]; + if ( ($more) && ($stripteaser) && ($hasTeaser) ) + $teaser = ''; + $output .= $teaser; + if ( count($content) > 1 ) { + if ( $more ) { + $output .= '' . $content[1]; + } else { + if ( ! empty($more_link_text) ) + $output .= apply_filters( 'the_content_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_callback('/\%u([0-9A-F]{4})/', create_function('$match', 'return "" . base_convert($match[1], 16, 10) . ";";'), $output); + + return $output; +} + +/** + * 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()); +} + +/** + * Retrieve the post excerpt. + * + * @since 0.71 + * + * @param mixed $deprecated Not used. + * @return string + */ +function get_the_excerpt($deprecated = '') { + global $post; + $output = $post->post_excerpt; + if ( post_password_required($post) ) { + $output = __('There is no excerpt because this is a protected post.'); + return $output; + } + + return apply_filters('get_the_excerpt', $output); +} + +/** + * Whether post has excerpt. + * + * @since 2.3.0 + * + * @param int $id Optional. Post ID. + * @return bool + */ +function has_excerpt( $id = 0 ) { + $post = &get_post( $id ); + return ( !empty( $post->post_excerpt ) ); +} + +/** + * 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 $post_id An optional post ID. + */ +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 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. + * + * @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. + * @return array Array of classes. + */ +function get_post_class( $class = '', $post_id = null ) { + $post = get_post($post_id); + + $classes = array(); + + if ( empty($post) ) + return $classes; + + $classes[] = 'post-' . $post->ID; + $classes[] = $post->post_type; + + // sticky for Sticky Posts + if ( is_sticky($post->ID) && is_home()) + $classes[] = 'sticky'; + + // hentry for hAtom compliace + $classes[] = 'hentry'; + + // Categories + foreach ( (array) get_the_category($post->ID) as $cat ) { + if ( empty($cat->slug ) ) + continue; + $classes[] = 'category-' . sanitize_html_class($cat->slug, $cat->cat_ID); + } + + // Tags + foreach ( (array) get_the_tags($post->ID) as $tag ) { + if ( empty($tag->slug ) ) + continue; + $classes[] = 'tag-' . sanitize_html_class($tag->slug, $tag->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); + + return apply_filters('post_class', $classes, $class, $post_id); +} + +/** + * 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 + * + * @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, $current_user; + + $classes = array(); + + if ( 'rtl' == get_bloginfo('text_direction') ) + $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'; + if ( is_paged() ) + $classes[] = 'paged'; + if ( is_attachment() ) + $classes[] = 'attachment'; + if ( is_404() ) + $classes[] = 'error404'; + + if ( is_single() ) { + $wp_query->post = $wp_query->posts[0]; + setup_postdata($wp_query->post); + + $postID = $wp_query->post->ID; + $classes[] = 'single postid-' . $postID; + + if ( is_attachment() ) { + $mime_type = get_post_mime_type(); + $mime_prefix = array( 'application/', 'image/', 'text/', 'audio/', 'video/', 'music/' ); + $classes[] = 'attachmentid-' . $postID; + $classes[] = 'attachment-' . str_replace($mime_prefix, '', $mime_type); + } + } elseif ( is_archive() ) { + if ( is_author() ) { + $author = $wp_query->get_queried_object(); + $classes[] = 'author'; + $classes[] = 'author-' . sanitize_html_class($author->user_nicename , $author->ID); + } elseif ( is_category() ) { + $cat = $wp_query->get_queried_object(); + $classes[] = 'category'; + $classes[] = 'category-' . sanitize_html_class($cat->slug, $cat->cat_ID); + } elseif ( is_tag() ) { + $tags = $wp_query->get_queried_object(); + $classes[] = 'tag'; + $classes[] = 'tag-' . sanitize_html_class($tags->slug, $tags->term_id); + } + } elseif ( is_page() ) { + $classes[] = 'page'; + + $wp_query->post = $wp_query->posts[0]; + setup_postdata($wp_query->post); + + $pageID = $wp_query->post->ID; + + $classes[] = 'page-id-' . $pageID; + + if ( $wpdb->get_var( $wpdb->prepare("SELECT ID FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' LIMIT 1", $pageID) ) ) + $classes[] = 'page-parent'; + + if ( $wp_query->post->post_parent ) { + $classes[] = 'page-child'; + $classes[] = 'parent-pageid-' . $wp_query->post->post_parent; + } + if ( is_page_template() ) { + $classes[] = 'page-template'; + $classes[] = 'page-template-' . str_replace( '.php', '-php', get_post_meta( $pageID, '_wp_page_template', true ) ); + } + } elseif ( is_search() ) { + if ( !empty($wp_query->posts) ) + $classes[] = 'search-results'; + else + $classes[] = 'search-no-results'; + } + + if ( is_user_logged_in() ) + $classes[] = 'logged-in'; + + $page = $wp_query->get('page'); + + if ( !$page || $page < 2) + $page = $wp_query->get('paged'); + + if ( $page && $page > 1 ) { + $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; + } + + if ( !empty($class) ) { + if ( !is_array( $class ) ) + $class = preg_split('#\s+#', $class); + $classes = array_merge($classes, $class); + } + + $classes = array_map('esc_attr', $classes); + + return apply_filters('body_class', $classes, $class); +} + +/** + * Whether post requires password and correct password has been provided. + * + * @since 2.7.0 + * + * @param int|object $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; + + if ( $_COOKIE['wp-postpass_' . COOKIEHASH] != $post->post_password ) + return true; + + return false; +} + +/** + * Display "sticky" CSS class, if a post is sticky. + * + * @since 2.7.0 + * + * @param int $post_id An optional post ID. + */ +function sticky_class( $post_id = null ) { + if ( !is_sticky($post_id) ) + return; + + echo " sticky"; +} + +/** + * Page Template Functions for usage in Themes + * + * @package WordPress + * @subpackage Template + */ + +/** + * 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. + * + * The defaults for overwriting are: + * 'next_or_number' - Default is 'number' (string). Indicates whether page + * numbers should be used. Valid values are number and next. + * '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. + * '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. + * 'link_after' - Default is '' (string). The html or text to append to each + * Pages link inside the tag. + * + * @since 1.2.0 + * @access private + * + * @param string|array $args Optional. Overwrite the defaults. + * @return string Formatted output in HTML. + */ +function wp_link_pages($args = '') { + $defaults = array( + 'before' => '' . __('Pages:'), 'after' => '
', + 'link_before' => '', 'link_after' => '', + 'next_or_number' => 'number', 'nextpagelink' => __('Next page'), + 'previouspagelink' => __('Previous page'), 'pagelink' => '%', + 'echo' => 1 + ); + + $r = wp_parse_args( $args, $defaults ); + extract( $r, EXTR_SKIP ); + + global $post, $page, $numpages, $multipage, $more, $pagenow; + + $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 .= ''; + } + + } + $output .= $link_before; + $output .= $j; + $output .= $link_after; + if ( ($i != $page) || ((!$more) && ($page==1)) ) + $output .= ''; + } + $output .= $after; + } else { + if ( $more ) { + $output .= $before; + $i = $page - 1; + if ( $i && $more ) { + if ( 1 == $i ) { + $output .= '' . $link_before. $previouspagelink . $link_after . ''; + } else { + if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) ) + $output .= '' . $link_before. $previouspagelink . $link_after . ''; + else + $output .= '' . $link_before. $previouspagelink . $link_after . ''; + } + } + $i = $page + 1; + if ( $i <= $numpages && $more ) { + if ( 1 == $i ) { + $output .= '' . $link_before. $nextpagelink . $link_after . ''; + } else { + if ( '' == get_option('permalink_structure') || in_array($post->post_status, array('draft', 'pending')) ) + $output .= '' . $link_before. $nextpagelink . $link_after . ''; + else + $output .= '' . $link_before. $nextpagelink . $link_after . ''; + } + } + $output .= $after; + } + } + } + + if ( $echo ) + echo $output; + + return $output; +} + + +// +// Post-meta: Custom per-post fields. +// + +/** + * Retrieve post custom meta data field. + * + * @since 1.5.0 + * + * @param string $key Meta data key name. + * @return string|array Array of values or single value, if only one element exists. + */ +function post_custom( $key = '' ) { + $custom = get_post_custom(); + + if ( 1 == count($custom[$key]) ) + return $custom[$key][0]; + else + return $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. + */ +function the_meta() { + if ( $keys = get_post_custom_keys() ) { + echo " \n"; + } +} + +// +// Pages +// + +/** + * Retrieve or display list of pages as a dropdown (select list). + * + * @since 2.1.0 + * + * @param array|string $args Optional. Override default arguments. + * @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' => '', 'show_option_no_change' => '', + 'option_none_value' => '' + ); + + $r = wp_parse_args( $args, $defaults ); + extract( $r, EXTR_SKIP ); + + $pages = get_pages($r); + $output = ''; + $name = esc_attr($name); + + if ( ! empty($pages) ) { + $output = "\n"; + } + + $output = apply_filters('wp_dropdown_pages', $output); + + if ( $echo ) + echo $output; + + return $output; +} + +/** + * Retrieve or display list of pages in list (li) format. + * + * @since 1.5.0 + * + * @param array|string $args Optional. Override default arguments. + * @return string HTML content, if not displaying. + */ +function wp_list_pages($args = '') { + $defaults = array( + 'depth' => 0, 'show_date' => '', + 'date_format' => get_option('date_format'), + 'child_of' => 0, 'exclude' => '', + 'title_li' => __('Pages'), 'echo' => 1, + 'authors' => '', 'sort_column' => 'menu_order, post_title', + 'link_before' => '', 'link_after' => '', 'walker' => '', + ); + + $r = wp_parse_args( $args, $defaults ); + extract( $r, EXTR_SKIP ); + + $output = ''; + $current_page = 0; + + // sanitize, mostly to keep spaces out + $r['exclude'] = preg_replace('/[^0-9,]/', '', $r['exclude']); + + // Allow plugins to filter an array of excluded pages (but don't put a nullstring into the array) + $exclude_array = ( $r['exclude'] ) ? explode(',', $r['exclude']) : array(); + $r['exclude'] = implode( ',', apply_filters('wp_list_pages_excludes', $exclude_array) ); + + // Query pages. + $r['hierarchical'] = 0; + $pages = get_pages($r); + + if ( !empty($pages) ) { + if ( $r['title_li'] ) + $output .= '> element before content. + * + * @since 2.0.0 + * @uses apply_filters() Calls 'prepend_attachment' hook on HTML content. + * + * @param string $content + * @return string + */ +function prepend_attachment($content) { + global $post; + + if ( empty($post->post_type) || $post->post_type != 'attachment' ) + return $content; + + $p = '
'; + $p = apply_filters('prepend_attachment', $p); + + return "$p\n$content"; +} + +// +// Misc +// + +/** + * Retrieve protected post password form content. + * + * @since 1.0.0 + * @uses apply_filters() Calls 'the_password_form' filter on output. + * + * @return string HTML content for password form for password protected post. + */ +function get_the_password_form() { + global $post; + $label = 'pwbox-'.(empty($post->ID) ? rand() : $post->ID); + $output = ' + '; + return apply_filters('the_password_form', $output); +} + +/** + * Whether currently in a page template. + * + * This template tag allows you to determine whether or not you are in a page + * template. You can optional provide a template name and then the check will be + * specific to that template. + * + * @since 2.5.0 + * @uses $wp_query + * + * @param string $template The specific template name if specific matching is required. + * @return bool False on failure, true if success. + */ +function is_page_template($template = '') { + if (!is_page()) { + return false; + } + + global $wp_query; + + $page = $wp_query->get_queried_object(); + $custom_fields = get_post_custom_values('_wp_page_template',$page->ID); + $page_template = $custom_fields[0]; + + // We have no argument passed so just see if a page_template has been specified + if ( empty( $template ) ) { + if (!empty( $page_template ) ) { + return true; + } + } elseif ( $template == $page_template) { + return true; + } + + return false; +} + +/** + * Retrieve formatted date timestamp of a revision (linked to that revisions's page). + * + * @package WordPress + * @subpackage Post_Revisions + * @since 2.6.0 + * + * @uses date_i18n() + * + * @param int|object $revision Revision ID or revision object. + * @param bool $link Optional, default is true. Link to revisions's page? + * @return string i18n formatted datetimestamp or localized 'Current Revision'. + */ +function wp_post_revision_title( $revision, $link = true ) { + if ( !$revision = get_post( $revision ) ) + return $revision; + + if ( !in_array( $revision->post_type, array( 'post', 'page', 'revision' ) ) ) + return false; + + /* translators: revision date format, see http://php.net/date */ + $datef = _x( 'j F, Y @ G:i', 'revision date format'); + /* translators: 1: date */ + $autosavef = __( '%1$s [Autosave]' ); + /* translators: 1: date */ + $currentf = __( '%1$s [Current Revision]' ); + + $date = date_i18n( $datef, strtotime( $revision->post_modified_gmt . ' +0000' ) ); + if ( $link && current_user_can( 'edit_post', $revision->ID ) && $link = get_edit_post_link( $revision->ID ) ) + $date = "$date"; + + if ( !wp_is_post_revision( $revision ) ) + $date = sprintf( $currentf, $date ); + elseif ( wp_is_post_autosave( $revision ) ) + $date = sprintf( $autosavef, $date ); + + return $date; +} + +/** + * Display list of a post's revisions. + * + * Can output either a UL with edit links or a TABLE with diff interface, and + * restore action links. + * + * Second argument controls parameters: + * (bool) parent : include the parent (the "Current Revision") in the list. + * (string) format : 'list' or 'form-table'. 'list' outputs UL, 'form-table' + * outputs TABLE with UI. + * (int) right : what revision is currently being viewed - used in + * form-table format. + * (int) left : what revision is currently being diffed against right - + * used in form-table format. + * + * @package WordPress + * @subpackage Post_Revisions + * @since 2.6.0 + * + * @uses wp_get_post_revisions() + * @uses wp_post_revision_title() + * @uses get_edit_post_link() + * @uses get_the_author_meta() + * + * @todo split into two functions (list, form-table) ? + * + * @param int|object $post_id Post ID or post object. + * @param string|array $args See description {@link wp_parse_args()}. + * @return null + */ +function wp_list_post_revisions( $post_id = 0, $args = null ) { + if ( !$post = get_post( $post_id ) ) + return; + + $defaults = array( 'parent' => false, 'right' => false, 'left' => false, 'format' => 'list', 'type' => 'all' ); + extract( wp_parse_args( $args, $defaults ), EXTR_SKIP ); + + switch ( $type ) { + case 'autosave' : + if ( !$autosave = wp_get_post_autosave( $post->ID ) ) + return; + $revisions = array( $autosave ); + break; + case 'revision' : // just revisions - remove autosave later + case 'all' : + default : + if ( !$revisions = wp_get_post_revisions( $post->ID ) ) + return; + break; + } + + /* translators: post revision: 1: when, 2: author name */ + $titlef = _x( '%1$s by %2$s', 'post revision' ); + + if ( $parent ) + array_unshift( $revisions, $post ); + + $rows = ''; + $class = false; + $can_edit_post = current_user_can( 'edit_post', $post->ID ); + foreach ( $revisions as $revision ) { + if ( !current_user_can( 'read_post', $revision->ID ) ) + continue; + if ( 'revision' === $type && wp_is_post_autosave( $revision ) ) + continue; + + $date = wp_post_revision_title( $revision ); + $name = get_the_author_meta( 'display_name', $revision->post_author ); + + if ( 'form-table' == $format ) { + if ( $left ) + $left_checked = $left == $revision->ID ? ' checked="checked"' : ''; + else + $left_checked = $right_checked ? ' checked="checked"' : ''; // [sic] (the next one) + $right_checked = $right == $revision->ID ? ' checked="checked"' : ''; + + $class = $class ? '' : " class='alternate'"; + + if ( $post->ID != $revision->ID && $can_edit_post ) + $actions = 'ID|$revision->ID" ) . '">' . __( 'Restore' ) . ''; + else + $actions = ''; + + $rows .= "