enmi-conf.org: comparison wp/wp-includes/link-template.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 * Returns a link to the feed for all posts in a given category. A specific feed
 * can be requested or left blank to get the default feed.
 *
 * @since 2.5.0
 *
-* @param int    $cat_id Category ID.
+* @param int|WP_Term|object $cat  The ID or category object whose feed link will be retrieved.
-* @param string $feed   Optional. Feed type. Possible values include 'rss2', 'atom'.
+* @param string             $feed Optional. Feed type. Possible values include 'rss2', 'atom'.
-*                       Default is the value of get_default_feed().
+*                                 Default is the value of get_default_feed().
-* @return string Link to the feed for the category specified by $cat_id.
+* @return string Link to the feed for the category specified by `$cat`.
 */
-function get_category_feed_link( $cat_id, $feed = '' ) {
+function get_category_feed_link( $cat, $feed = '' ) {
-	return get_term_feed_link( $cat_id, 'category', $feed );
+	return get_term_feed_link( $cat, 'category', $feed );
 }
 /**
 * Retrieves the feed link for a term.
 *
 * Returns a link to the feed for all posts in a given term. A specific feed
 * can be requested or left blank to get the default feed.
 *
 * @since 3.0.0
 *
-* @param int    $term_id  Term ID.
+* @param int|WP_Term|object $term     The ID or term object whose feed link will be retrieved.
-* @param string $taxonomy Optional. Taxonomy of `$term_id`. Default 'category'.
+* @param string             $taxonomy Optional. Taxonomy of `$term_id`.
-* @param string $feed     Optional. Feed type. Possible values include 'rss2', 'atom'.
+* @param string             $feed     Optional. Feed type. Possible values include 'rss2', 'atom'.
-*                         Default is the value of get_default_feed().
+*                                     Default is the value of get_default_feed().
-* @return string|false Link to the feed for the term specified by $term_id and $taxonomy.
+* @return string|false Link to the feed for the term specified by `$term` and `$taxonomy`.
 */
-function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
+function get_term_feed_link( $term, $taxonomy = '', $feed = '' ) {
-	$term_id = (int) $term_id;
+	if ( ! is_object( $term ) ) {
+		$term = (int) $term;
-	$term = get_term( $term_id, $taxonomy );
+	}
+	$term = get_term( $term, $taxonomy );
 	if ( empty( $term ) || is_wp_error( $term ) ) {
 		return false;
 	}
+	$taxonomy = $term->taxonomy;
 	if ( empty( $feed ) ) {
 		$feed = get_default_feed();
 	}
 	$permalink_structure = get_option( 'permalink_structure' );
 	if ( ! $permalink_structure ) {
 		if ( 'category' === $taxonomy ) {
-			$link = home_url( "?feed=$feed&amp;cat=$term_id" );
+			$link = home_url( "?feed=$feed&amp;cat=$term->term_id" );
 		} elseif ( 'post_tag' === $taxonomy ) {
 			$link = home_url( "?feed=$feed&amp;tag=$term->slug" );
 		} else {
 			$t    = get_taxonomy( $taxonomy );
 			$link = home_url( "?feed=$feed&amp;$t->query_var=$term->slug" );
 		}
 	} else {
-		$link = get_term_link( $term_id, $term->taxonomy );
+		$link = get_term_link( $term, $term->taxonomy );
 		if ( get_default_feed() == $feed ) {
 			$feed_link = 'feed';
 		} else {
 			$feed_link = "feed/$feed";
 		}
 /**
 * Retrieves the permalink for a tag feed.
 *
 * @since 2.3.0
 *
-* @param int    $tag_id Tag ID.
+* @param int|WP_Term|object $tag  The ID or term object whose feed link will be retrieved.
-* @param string $feed   Optional. Feed type. Possible values include 'rss2', 'atom'.
+* @param string             $feed Optional. Feed type. Possible values include 'rss2', 'atom'.
-*                       Default is the value of get_default_feed().
+*                                 Default is the value of get_default_feed().
-* @return string The feed permalink for the given tag.
+* @return string                  The feed permalink for the given tag.
 */
-function get_tag_feed_link( $tag_id, $feed = '' ) {
+function get_tag_feed_link( $tag, $feed = '' ) {
-	return get_term_feed_link( $tag_id, 'post_tag', $feed );
+	return get_term_feed_link( $tag, 'post_tag', $feed );
 }
 /**
 * Retrieves the edit link for a tag.
 *
 * @since 2.7.0
 *
-* @param int    $tag_id   Tag ID.
+* @param int|WP_Term|object $tag      The ID or term object whose edit link will be retrieved.
-* @param string $taxonomy Optional. Taxonomy slug. Default 'post_tag'.
+* @param string             $taxonomy Optional. Taxonomy slug. Default 'post_tag'.
 * @return string The edit tag link URL for the given tag.
 */
-function get_edit_tag_link( $tag_id, $taxonomy = 'post_tag' ) {
+function get_edit_tag_link( $tag, $taxonomy = 'post_tag' ) {
 	/**
 	 * Filters the edit link for a tag (or term in another taxonomy).
 	 *
 	 * @since 2.7.0
 	 *
 	 * @param string $link The term edit link.
 	 */
-	return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag_id, $taxonomy ) );
+	return apply_filters( 'get_edit_tag_link', get_edit_term_link( $tag, $taxonomy ) );
 }
 /**
 * Displays or retrieves the edit link for a tag with formatting.
 *
 * Retrieves the URL for editing a given term.
 *
 * @since 3.1.0
 * @since 4.5.0 The `$taxonomy` parameter was made optional.
 *
-* @param int    $term_id     Term ID.
+* @param int|WP_Term|object $term        The ID or term object whose edit link will be retrieved.
-* @param string $taxonomy    Optional. Taxonomy. Defaults to the taxonomy of the term identified
+* @param string             $taxonomy    Optional. Taxonomy. Defaults to the taxonomy of the term identified
-*                            by `$term_id`.
+*                                        by `$term`.
-* @param string $object_type Optional. The object type. Used to highlight the proper post type
+* @param string             $object_type Optional. The object type. Used to highlight the proper post type
-*                            menu on the linked page. Defaults to the first object_type associated
+*                                        menu on the linked page. Defaults to the first object_type associated
-*                            with the taxonomy.
+*                                        with the taxonomy.
 * @return string|null The edit term link URL for the given term, or null on failure.
 */
-function get_edit_term_link( $term_id, $taxonomy = '', $object_type = '' ) {
+function get_edit_term_link( $term, $taxonomy = '', $object_type = '' ) {
-	$term = get_term( $term_id, $taxonomy );
+	$term = get_term( $term, $taxonomy );
 	if ( ! $term || is_wp_error( $term ) ) {
 		return;
 	}
-	$tax = get_taxonomy( $term->taxonomy );
+	$tax     = get_taxonomy( $term->taxonomy );
-	if ( ! $tax || ! current_user_can( 'edit_term', $term->term_id ) ) {
+	$term_id = $term->term_id;
+	if ( ! $tax || ! current_user_can( 'edit_term', $term_id ) ) {
 		return;
 	}
 	$args = array(
 		'taxonomy' => $taxonomy,
-		'tag_ID'   => $term->term_id,
+		'tag_ID'   => $term_id,
 	);
 	if ( $object_type ) {
 		$args['post_type'] = $object_type;
 	} elseif ( ! empty( $tax->object_type ) ) {
 	 * @since 3.1.0
 	 *
 	 * @param string $location    The edit link.
 	 * @param int    $term_id     Term ID.
 	 * @param string $taxonomy    Taxonomy name.
-	 * @param string $object_type The object type (eg. the post type).
+	 * @param string $object_type The object type.
 	 */
 	return apply_filters( 'get_edit_term_link', $location, $term_id, $taxonomy, $object_type );
 }
 /**
 * Displays or retrieves the edit term link with formatting.
 *
 * @since 3.1.0
 *
-* @param string  $link   Optional. Anchor text. If empty, default is 'Edit This'. Default empty.
+* @param string           $link   Optional. Anchor text. If empty, default is 'Edit This'. Default empty.
-* @param string  $before Optional. Display before edit link. Default empty.
+* @param string           $before Optional. Display before edit link. Default empty.
-* @param string  $after  Optional. Display after edit link. Default empty.
+* @param string           $after  Optional. Display after edit link. Default empty.
-* @param WP_Term $term   Optional. Term object. If null, the queried object will be inspected. Default null.
+* @param int|WP_Term|null $term   Optional. Term ID or object. If null, the queried object will be inspected. Default null.
-* @param bool    $echo   Optional. Whether or not to echo the return. Default true.
+* @param bool             $echo   Optional. Whether or not to echo the return. Default true.
 * @return string|void HTML content.
 */
 function edit_term_link( $link = '', $before = '', $after = '', $term = null, $echo = true ) {
 	if ( is_null( $term ) ) {
 		$term = get_queried_object();
+	} else {
+		$term = get_term( $term );
 	}
 	if ( ! $term ) {
 		return;
 	}
 	 * Filters the comment edit link anchor tag.
 	 *
 	 * @since 2.3.0
 	 *
 	 * @param string $link       Anchor tag for the edit link.
-	 * @param int    $comment_id Comment ID.
+	 * @param string $comment_id Comment ID as a numeric string.
 	 * @param string $text       Anchor text.
 	 */
 	echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after;
 }
 * @since 1.5.0
 *
 * @param bool         $in_same_term   Optional. Whether post should be in a same taxonomy term. Default false.
 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
-* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
+* @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
 *                             corresponding post exists.
 */
 function get_previous_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
 	return get_adjacent_post( $in_same_term, $excluded_terms, true, $taxonomy );
 }
 * @since 1.5.0
 *
 * @param bool         $in_same_term   Optional. Whether post should be in a same taxonomy term. Default false.
 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty.
 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
-* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
+* @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
 *                             corresponding post exists.
 */
 function get_next_post( $in_same_term = false, $excluded_terms = '', $taxonomy = 'category' ) {
 	return get_adjacent_post( $in_same_term, $excluded_terms, false, $taxonomy );
 }
 *
 * @param bool         $in_same_term   Optional. Whether post should be in a same taxonomy term. Default false.
 * @param int[]|string $excluded_terms Optional. Array or comma-separated list of excluded term IDs. Default empty string.
 * @param bool         $previous       Optional. Whether to retrieve previous post. Default true
 * @param string       $taxonomy       Optional. Taxonomy, if $in_same_term is true. Default 'category'.
-* @return null|string|WP_Post Post object if successful. Null if global $post is not set. Empty string if no
+* @return WP_Post|null|string Post object if successful. Null if global $post is not set. Empty string if no
 *                             corresponding post exists.
 */
 function get_adjacent_post( $in_same_term = false, $excluded_terms = '', $previous = true, $taxonomy = 'category' ) {
 	global $wpdb;
 	 */
 	$excluded_terms = apply_filters( "get_{$adjacent}_post_excluded_terms", $excluded_terms );
 	if ( $in_same_term || ! empty( $excluded_terms ) ) {
 		if ( $in_same_term ) {
-			$join  .= " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy tt ON tr.term_taxonomy_id = tt.term_taxonomy_id";
+			$join  .= " INNER JOIN $wpdb->term_relationships AS tr ON p.ID = tr.object_id INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id";
 			$where .= $wpdb->prepare( 'AND tt.taxonomy = %s', $taxonomy );
 			if ( ! is_object_in_taxonomy( $post->post_type, $taxonomy ) ) {
 				return '';
 			}
 		 * Results should include private posts belonging to the current user, or private posts where the
 		 * current user has the 'read_private_posts' cap.
 		 */
 		$private_states = get_post_stati( array( 'private' => true ) );
 		$where         .= " AND ( p.post_status = 'publish'";
-		foreach ( (array) $private_states as $state ) {
+		foreach ( $private_states as $state ) {
 			if ( current_user_can( $read_private_cap ) ) {
 				$where .= $wpdb->prepare( ' OR p.post_status = %s', $state );
 			} else {
 				$where .= $wpdb->prepare( ' OR (p.post_author = %d AND p.post_status = %s)', $user_id, $state );
 			}
 	if ( empty( $aria_label ) ) {
 		$aria_label = $screen_reader_text;
 	}
 	$template = '
-	<nav class="navigation %1$s" role="navigation" aria-label="%4$s">
+	<nav class="navigation %1$s" aria-label="%4$s">
 		<h2 class="screen-reader-text">%2$s</h2>
 		<div class="nav-links">%3$s</div>
 	</nav>';
 	/**
 	 *
 	 * Note: The filtered template HTML must contain specifiers for the navigation
 	 * class (%1$s), the screen-reader-text value (%2$s), placement of the navigation
 	 * links (%3$s), and ARIA label text if screen-reader-text does not fit that (%4$s):
 	 *
-	 *     <nav class="navigation %1$s" role="navigation" aria-label="%4$s">
+	 *     <nav class="navigation %1$s" aria-label="%4$s">
 	 *         <h2 class="screen-reader-text">%2$s</h2>
 	 *         <div class="nav-links">%3$s</div>
 	 *     </nav>
 	 *
 	 * @since 4.4.0
 * filter.
 *
 * @since 3.0.0
 *
 * @param int    $id          Optional. A post or site ID. Default is 0, which means the current post or site.
-* @param string $context     Optional. Whether the ID is a 'site' id, 'post' id, or 'media' id. If 'post',
+* @param string $context     Optional. Whether the ID is a 'site' ID, 'post' ID, or 'media' ID. If 'post',
 *                            the post_type of the post is consulted. If 'query', the current query is consulted
 *                            to determine the ID and context. Default 'post'.
 * @param bool   $allow_slugs Optional. Whether to allow post slugs in the shortlink. It is up to the plugin how
 *                            and whether to honor this. Default true.
 * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6