* Retrieve the ID of the current item in the WordPress Loop.
*
* @since 2.1.0
- * @uses $post
*
- * @return int
+ * @return int|bool 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;
}
/**
*
* @since 2.3.0
*
- * @param string|array $args Optional. Override the defaults.
+ * @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|null Null on failure or display. 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;
+ }
}
/**
*
* @since 0.71
*
- * @param int|WP_Post $post Optional. Post ID or post 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 ) {
*
* @since 2.8.0
*
- * @param string $prepend Text displayed before the post title.
- * Default 'Protected: %s'.
+ * @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' ) );
+ $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 ) {
+ } elseif ( isset( $post->post_status ) && 'private' == $post->post_status ) {
/**
* Filter the text prepended to the post title of private posts.
*
* @since 2.8.0
*
- * @param string $prepend Text displayed before the post title.
- * Default 'Private: %s'.
+ * @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' ) );
+ $private_title_format = apply_filters( 'private_title_format', __( 'Private: %s' ), $post );
$title = sprintf( $private_title_format, $title );
}
}
* @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 ) );
}
/**
* @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 );
* @since 0.71
*
* @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 ) {
}
}
- 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
_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.' );
*
* 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
- * 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.
+ * 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.
+ * @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 );
+ }
+
+ if ( ! $post ) {
return $classes;
+ }
$classes[] = 'post-' . $post->ID;
if ( ! is_admin() )
}
// 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.
* @param string $class A comma-separated list of additional classes added to the post.
* @param int $post_id The post ID.
*/
- return apply_filters( 'post_class', $classes, $class, $post->ID );
+ $classes = apply_filters( 'post_class', $classes, $class, $post->ID );
+
+ return array_unique( $classes );
}
/**
if ( is_array( $post_type ) )
$post_type = reset( $post_type );
$classes[] = 'post-type-archive-' . sanitize_html_class( $post_type );
- } else if ( is_author() ) {
+ } elseif ( is_author() ) {
$author = $wp_query->get_queried_object();
$classes[] = 'author';
if ( isset( $author->user_nicename ) ) {
$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;
}
}
$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';
}
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';
}
$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() )
* @param array $classes An array of body classes.
* @param string $class A comma-separated list of additional classes added to the body.
*/
- return apply_filters( 'body_class', $classes, $class );
+ $classes = apply_filters( 'body_class', $classes, $class );
+
+ return array_unique( $classes );
}
/**
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 ] );
* Displays page links for paginated posts (i.e. includes the <!--nextpage-->.
* Quicktag one or more times). This tag must be within The Loop.
*
- * The defaults for overwriting are:
- * 'before' - Default is '<p> Pages:' (string). The html or text to prepend to
- * each bookmarks.
- * 'after' - Default is '</p>' (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 <a> 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 <a> 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.
+ * @param string|array $args {
+ * Optional. Array or string of default arguments.
+ *
+ * @type string $before HTML or text to prepend to each link. Default is `<p> Pages:`.
+ * @type string $after HTML or text to append to each link. Default is `</p>`.
+ * @type string $link_before HTML or text to prepend to each link, inside the `<a>` 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 `<a>` 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 = '' ) {
'echo' => 1
);
- $r = wp_parse_args( $args, $defaults );
+ $params = wp_parse_args( $args, $defaults );
/**
* Filter the arguments used in retrieving page links for paginated posts.
*
* @since 3.0.0
*
- * @param array $r An array of arguments for page links for paginated posts.
+ * @param array $params An array of arguments for page links for paginated posts.
*/
- $r = apply_filters( 'wp_link_pages_args', $r );
- extract( $r, EXTR_SKIP );
+ $r = apply_filters( 'wp_link_pages_args', $params );
global $page, $numpages, $multipage, $more;
$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 . '</a>';
-
+ }
/**
* Filter the HTML output of individual page number links.
*
* @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 . '</a>';
+ $output .= $r['before'];
+ $prev = $page - 1;
+ if ( $prev ) {
+ $link = _wp_link_page( $prev ) . $r['link_before'] . $r['previouspagelink'] . $r['link_after'] . '</a>';
/** This filter is documented in wp-includes/post-template.php */
- $link = apply_filters( 'wp_link_pages_link', $link, $i );
- $output .= $separator . $link;
+ $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 . '</a>';
+ $next = $page + 1;
+ if ( $next <= $numpages ) {
+ if ( $prev ) {
+ $output .= $r['separator'];
+ }
+ $link = _wp_link_page( $next ) . $r['link_before'] . $r['nextpagelink'] . $r['link_after'] . '</a>';
/** This filter is documented in wp-includes/post-template.php */
- $link = apply_filters( 'wp_link_pages_link', $link, $i );
- $output .= $separator . $link;
+ $output .= apply_filters( 'wp_link_pages_link', $link, $next );
}
- $output .= $after;
+ $output .= $r['after'];
}
}
* @param string $output HTML output of paginated posts' page links.
* @param array $args An array of arguments.
*/
- $output = apply_filters( 'wp_link_pages', $output, $args );
-
- if ( $echo )
- echo $output;
+ $html = apply_filters( 'wp_link_pages', $output, $args );
- return $output;
+ if ( $r['echo'] ) {
+ echo $html;
+ }
+ return $html;
}
/**
*
* @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() ) {
* 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.
+ *
+ * @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.
+ * 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' => '',
'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 = "<select name='" . esc_attr( $name ) . "' id='" . esc_attr( $id ) . "'>\n";
- if ( $show_option_no_change )
- $output .= "\t<option value=\"-1\">$show_option_no_change</option>";
- if ( $show_option_none )
- $output .= "\t<option value=\"" . esc_attr($option_none_value) . "\">$show_option_none</option>\n";
- $output .= walk_page_dropdown_tree($pages, $depth, $r);
+ if ( empty( $r['id'] ) ) {
+ $r['id'] = $r['name'];
+ }
+
+ if ( ! empty( $pages ) ) {
+ $output = "<select name='" . esc_attr( $r['name'] ) . "' id='" . esc_attr( $r['id'] ) . "'>\n";
+ if ( $r['show_option_no_change'] ) {
+ $output .= "\t<option value=\"-1\">" . $r['show_option_no_change'] . "</option>\n";
+ }
+ if ( $r['show_option_none'] ) {
+ $output .= "\t<option value=\"" . esc_attr( $r['option_none_value'] ) . '">' . $r['show_option_none'] . "</option>\n";
+ }
+ $output .= walk_page_dropdown_tree( $pages, $r['depth'], $r );
$output .= "</select>\n";
}
*
* @param string $output HTML output for drop down list of pages.
*/
- $output = apply_filters( 'wp_dropdown_pages', $output );
-
- if ( $echo )
- echo $output;
+ $html = apply_filters( 'wp_dropdown_pages', $output );
- return $output;
+ if ( $r['echo'] ) {
+ echo $html;
+ }
+ return $html;
}
/**
*
* @since 1.5.0
*
- * @param array|string $args Optional. Override default arguments.
- * @return string HTML content, if not displaying.
+ * @see get_pages()
+ *
+ * @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 `<ul>` tags. Default 'Pages'.
+ * @type Walker $walker Walker instance to use for listing pages. Default empty (Walker_Page).
+ * }
+ * @return string HTML list of pages.
*/
-function wp_list_pages($args = '') {
+function wp_list_pages( $args = '' ) {
$defaults = array(
'depth' => 0, 'show_date' => '',
- 'date_format' => get_option('date_format'),
+ 'date_format' => get_option( 'date_format' ),
'child_of' => 0, 'exclude' => '',
- 'title_li' => __('Pages'), 'echo' => 1,
+ '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']);
+ $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();
+ $exclude_array = ( $r['exclude'] ) ? explode( ',', $r['exclude'] ) : array();
/**
* Filter the array of pages to exclude from the pages list.
// Query pages.
$r['hierarchical'] = 0;
- $pages = get_pages($r);
+ $pages = get_pages( $r );
- if ( !empty($pages) ) {
- if ( $r['title_li'] )
+ if ( ! empty( $pages ) ) {
+ if ( $r['title_li'] ) {
$output .= '<li class="pagenav">' . $r['title_li'] . '<ul>';
-
+ }
global $wp_query;
if ( is_page() || is_attachment() || $wp_query->is_posts_page ) {
$current_page = get_queried_object_id();
}
}
- $output .= walk_page_tree($pages, $r['depth'], $current_page, $r);
+ $output .= walk_page_tree( $pages, $r['depth'], $current_page, $r );
- if ( $r['title_li'] )
+ if ( $r['title_li'] ) {
$output .= '</ul></li>';
+ }
}
/**
* @param string $output HTML output of the pages list.
* @param array $r An array of page-listing arguments.
*/
- $output = apply_filters( 'wp_list_pages', $output, $r );
+ $html = apply_filters( 'wp_list_pages', $output, $r );
- if ( $r['echo'] )
- echo $output;
- else
- return $output;
+ if ( $r['echo'] ) {
+ echo $html;
+ } else {
+ return $html;
+ }
}
/**
* wp_list_pages()} function. Check that function for more info on those
* arguments.
*
- * <ul>
- * <li><strong>sort_column</strong> - How to sort the list of pages. Defaults
- * to 'menu_order, post_title'. Use column for posts table.</li>
- * <li><strong>menu_class</strong> - Class to use for the div ID which contains
- * the page list. Defaults to 'menu'.</li>
- * <li><strong>echo</strong> - Whether to echo list or return it. Defaults to
- * echo.</li>
- * <li><strong>link_before</strong> - Text before show_home argument text.</li>
- * <li><strong>link_after</strong> - Text after show_home argument text.</li>
- * <li><strong>show_home</strong> - If you set this argument, then it will
- * display the link to the home page. The show_home argument really just needs
- * to be set to the value of the text of the link.</li>
- * </ul>
- *
* @since 2.7.0
*
- * @param array|string $args
+ * @param array|string $args {
+ * Optional. Arguments to generate a page menu. See wp_list_pages() for additional arguments.
+ *
+ * @type string $sort_column How to short the list of pages. Accepts post column names.
+ * Default 'menu_order, post_title'.
+ * @type string $menu_class Class to use for the div ID containing the page list. Default 'menu'.
+ * @type bool $echo Whether to echo the list or return it. Accepts true (echo) or false (return).
+ * Default true.
+ * @type string $link_before The HTML or text to prepend to $show_home text. Default empty.
+ * @type string $link_after The HTML or text to append to $show_home text. Default empty.
+ * @type int|bool|string $show_home Whether to display the link to the home page. Can just enter the text
+ * you'd like shown for the home link. 1|true defaults to 'Home'.
+ * }
* @return string html menu
*/
function wp_page_menu( $args = array() ) {
* @since 2.1.0
* @var string
*/
- var $tree_type = 'page';
+ public $tree_type = 'page';
/**
* @see Walker::$db_fields
* @todo Decouple this.
* @var array
*/
- var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
+ public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
/**
* @see Walker::start_lvl()
* @param int $depth Depth of page. Used for padding.
* @param array $args
*/
- function start_lvl( &$output, $depth = 0, $args = array() ) {
+ public function start_lvl( &$output, $depth = 0, $args = array() ) {
$indent = str_repeat("\t", $depth);
$output .= "\n$indent<ul class='children'>\n";
}
* @param int $depth Depth of page. Used for padding.
* @param array $args
*/
- function end_lvl( &$output, $depth = 0, $args = array() ) {
+ public function end_lvl( &$output, $depth = 0, $args = array() ) {
$indent = str_repeat("\t", $depth);
$output .= "$indent</ul>\n";
}
* @param int $current_page Page ID.
* @param array $args
*/
- function start_el( &$output, $page, $depth = 0, $args = array(), $current_page = 0 ) {
- if ( $depth )
- $indent = str_repeat("\t", $depth);
- else
+ public function start_el( &$output, $page, $depth = 0, $args = array(), $current_page = 0 ) {
+ if ( $depth ) {
+ $indent = str_repeat( "\t", $depth );
+ } else {
$indent = '';
+ }
- extract($args, EXTR_SKIP);
- $css_class = array('page_item', 'page-item-'.$page->ID);
+ $css_class = array( 'page_item', 'page-item-' . $page->ID );
- if( isset( $args['pages_with_children'][ $page->ID ] ) )
+ if ( isset( $args['pages_with_children'][ $page->ID ] ) ) {
$css_class[] = 'page_item_has_children';
+ }
- if ( !empty($current_page) ) {
+ if ( ! empty( $current_page ) ) {
$_current_page = get_post( $current_page );
- if ( in_array( $page->ID, $_current_page->ancestors ) )
+ if ( $_current_page && in_array( $page->ID, $_current_page->ancestors ) ) {
$css_class[] = 'current_page_ancestor';
- if ( $page->ID == $current_page )
+ }
+ if ( $page->ID == $current_page ) {
$css_class[] = 'current_page_item';
- elseif ( $_current_page && $page->ID == $_current_page->post_parent )
+ } elseif ( $_current_page && $page->ID == $_current_page->post_parent ) {
$css_class[] = 'current_page_parent';
+ }
} elseif ( $page->ID == get_option('page_for_posts') ) {
$css_class[] = 'current_page_parent';
}
* @param array $args An array of arguments.
* @param int $current_page ID of the current page.
*/
- $css_class = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page ) );
+ $css_classes = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page ) );
- if ( '' === $page->post_title )
+ if ( '' === $page->post_title ) {
$page->post_title = sprintf( __( '#%d (no title)' ), $page->ID );
+ }
- /** This filter is documented in wp-includes/post-template.php */
- $output .= $indent . '<li class="' . $css_class . '"><a href="' . get_permalink($page->ID) . '">' . $link_before . apply_filters( 'the_title', $page->post_title, $page->ID ) . $link_after . '</a>';
+ $args['link_before'] = empty( $args['link_before'] ) ? '' : $args['link_before'];
+ $args['link_after'] = empty( $args['link_after'] ) ? '' : $args['link_after'];
- if ( !empty($show_date) ) {
- if ( 'modified' == $show_date )
+ /** This filter is documented in wp-includes/post-template.php */
+ $output .= $indent . sprintf(
+ '<li class="%s"><a href="%s">%s%s%s</a>',
+ $css_classes,
+ get_permalink( $page->ID ),
+ $args['link_before'],
+ apply_filters( 'the_title', $page->post_title, $page->ID ),
+ $args['link_after']
+ );
+
+ if ( ! empty( $args['show_date'] ) ) {
+ if ( 'modified' == $args['show_date'] ) {
$time = $page->post_modified;
- else
+ } else {
$time = $page->post_date;
+ }
- $output .= " " . mysql2date($date_format, $time);
+ $date_format = empty( $args['date_format'] ) ? '' : $args['date_format'];
+ $output .= " " . mysql2date( $date_format, $time );
}
}
* @param int $depth Depth of page. Not Used.
* @param array $args
*/
- function end_el( &$output, $page, $depth = 0, $args = array() ) {
+ public function end_el( &$output, $page, $depth = 0, $args = array() ) {
$output .= "</li>\n";
}
* @since 2.1.0
* @var string
*/
- var $tree_type = 'page';
+ public $tree_type = 'page';
/**
* @see Walker::$db_fields
* @todo Decouple this
* @var array
*/
- var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
+ public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
/**
* @see Walker::start_el()
* @since 2.1.0
*
* @param string $output Passed by reference. Used to append additional content.
- * @param object $page Page data object.
- * @param int $depth Depth of page in reference to parent pages. Used for padding.
- * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option element.
+ * @param object $page Page data object.
+ * @param int $depth Depth of page in reference to parent pages. Used for padding.
+ * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option
+ * element. Uses 'value_field' argument to fill "value" attribute. See {@see wp_dropdown_pages()}.
* @param int $id
*/
- function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) {
+ public function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) {
$pad = str_repeat(' ', $depth * 3);
- $output .= "\t<option class=\"level-$depth\" value=\"$page->ID\"";
+ if ( ! isset( $args['value_field'] ) || ! isset( $page->{$args['value_field']} ) ) {
+ $args['value_field'] = 'ID';
+ }
+
+ $output .= "\t<option class=\"level-$depth\" value=\"" . esc_attr( $page->{$args['value_field']} ) . "\"";
if ( $page->ID == $args['selected'] )
$output .= ' selected="selected"';
$output .= '>';
* @since 2.0.0
*
* @param int|WP_Post $id Optional. Post ID or post object.
- * @param bool $fullsize Optional, default is false. Whether to use full size.
- * @param bool $deprecated Deprecated. Not used.
- * @param bool $permalink Optional, default is false. Whether to include permalink.
+ * @param bool $fullsize Optional, default is false. Whether to use full size.
+ * @param bool $deprecated Deprecated. Not used.
+ * @param bool $permalink Optional, default is false. Whether to include permalink.
*/
function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
if ( !empty( $deprecated ) )
* Retrieve an attachment page link using an image or icon, if possible.
*
* @since 2.5.0
- * @uses apply_filters() Calls 'wp_get_attachment_link' filter on HTML content with same parameters as function.
*
- * @param int|WP_Post $id Optional. Post ID or post object.
- * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string.
- * @param bool $permalink Optional, default is false. Whether to add permalink to image.
- * @param bool $icon Optional, default is false. Whether to include icon.
- * @param string|bool $text Optional, default is false. If string, then will be link text.
+ * @param int|WP_Post $id Optional. Post ID or post object.
+ * @param string $size Optional, default is 'thumbnail'. Size of image, either array or string.
+ * @param bool $permalink Optional, default is false. Whether to add permalink to image.
+ * @param bool $icon Optional, default is false. Whether to include icon.
+ * @param string|bool $text Optional, default is false. If string, then will be link text.
+ * @param array|string $attr Optional. Array or string of attributes.
* @return string HTML content.
*/
-function wp_get_attachment_link( $id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false ) {
+function wp_get_attachment_link( $id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false, $attr = '' ) {
$id = intval( $id );
$_post = get_post( $id );
if ( $permalink )
$url = get_attachment_link( $_post->ID );
- $post_title = esc_attr( $_post->post_title );
-
- if ( $text )
+ if ( $text ) {
$link_text = $text;
- elseif ( $size && 'none' != $size )
- $link_text = wp_get_attachment_image( $id, $size, $icon );
- else
+ } elseif ( $size && 'none' != $size ) {
+ $link_text = wp_get_attachment_image( $id, $size, $icon, $attr );
+ } else {
$link_text = '';
+ }
if ( trim( $link_text ) == '' )
$link_text = $_post->post_title;
}
/**
- * Wrap attachment in <<p>> element before content.
+ * Wrap attachment in paragraph tag before content.
*
* @since 2.0.0
*
if ( empty($post->post_type) || $post->post_type != 'attachment' )
return $content;
- if ( 0 === strpos( $post->post_mime_type, 'video' ) ) {
+ if ( wp_attachment_is( 'video', $post ) ) {
$meta = wp_get_attachment_metadata( get_the_ID() );
$atts = array( 'src' => wp_get_attachment_url() );
if ( ! empty( $meta['width'] ) && ! empty( $meta['height'] ) ) {
$atts['width'] = (int) $meta['width'];
$atts['height'] = (int) $meta['height'];
}
+ if ( has_post_thumbnail() ) {
+ $atts['poster'] = wp_get_attachment_url( get_post_thumbnail_id() );
+ }
$p = wp_video_shortcode( $atts );
- } elseif ( 0 === strpos( $post->post_mime_type, 'audio' ) ) {
+ } elseif ( wp_attachment_is( 'audio', $post ) ) {
$p = wp_audio_shortcode( array( 'src' => wp_get_attachment_url() ) );
} else {
$p = '<p class="attachment">';
* Retrieve protected post password form content.
*
* @since 1.0.0
- * @uses apply_filters() Calls 'the_password_form' filter on output.
- * @param int|WP_Post $post Optional. A post ID or post object.
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
* @return string HTML content for password form for password protected post.
*/
function get_the_password_form( $post = 0 ) {
* Whether currently in a page template.
*
* This template tag allows you to determine if you are in a page template.
- * You can optionally provide a template name and then the check will be
- * specific to that template.
+ * You can optionally provide a template name or array of template names
+ * and then the check will be specific to that template.
*
* @since 2.5.0
- * @uses $wp_query
+ * @since 4.2.0 The `$template` parameter was changed to also accept an array of page templates.
*
- * @param string $template The specific template name if specific matching is required.
+ * @param string|array $template The specific template name or array of templates to match.
* @return bool True on success, false on failure.
*/
function is_page_template( $template = '' ) {
if ( $template == $page_template )
return true;
+ if ( is_array( $template ) ) {
+ if ( ( in_array( 'default', $template, true ) && ! $page_template )
+ || in_array( $page_template, $template, true )
+ ) {
+ return true;
+ }
+ }
+
if ( 'default' == $template && ! $page_template )
return true;
*
* @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'.
return false;
/* translators: revision date format, see http://php.net/date */
- $datef = _x( 'j F, Y @ G:i', 'revision date format');
+ $datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
/* translators: 1: date */
$autosavef = _x( '%1$s [Autosave]', 'post revision title extra' );
/* translators: 1: date */
*
* @since 3.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 gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
$author = get_the_author_meta( 'display_name', $revision->post_author );
/* translators: revision date format, see http://php.net/date */
- $datef = _x( 'j F, Y @ G:i:s', 'revision date format');
+ $datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
$gravatar = get_avatar( $revision->post_author, 24 );
*
* @since 2.6.0
*
- * @uses wp_get_post_revisions()
- * @uses wp_post_revision_title_expanded()
- * @uses get_edit_post_link()
- * @uses get_the_author_meta()
- *
- * @param int|WP_Post $post_id Optional. Post ID or post object.
- * @param string $type 'all' (default), 'revision' or 'autosave'
+ * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
+ * @param string $type 'all' (default), 'revision' or 'autosave'
* @return null
*/
function wp_list_post_revisions( $post_id = 0, $type = 'all' ) {
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff