get_comment_link( WP_Comment|int|null $comment = null, array $args = array() ): string

Parameters

$commentWP_Comment|int|nulloptional

Comment to retrieve. Default current comment.Default: null

$argsarrayoptional

An array of optional arguments to override the defaults.Default: array()

• $typestring

  Passed to get_page_of_comment().

• $pageint

  Current page of comments, for calculating comment pagination.

• $per_pageint

  Per-page value for comment pagination.

• $max_depthint

  Passed to get_page_of_comment().

• $cpageint|string

  Value to use for the comment's "comment-page" or "cpage" value. If provided, this value overrides any value calculated from $page and $per_page.

Return

string

The permalink to the given comment.

Hooks fired · 1

One hook fires while get_comment_link() runs, in this order:

1. 1
   apply_filters( get_comment_link )filterline 866 (+88 into the body)

   Filters the returned single comment permalink.

Uses · 10

• get_comment()Retrieves comment data given a comment ID or comment object.
• wp_parse_args()Merges user defined arguments into defaults array.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• get_option()Retrieves an option value based on an option name.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• get_page_of_comment()Calculates what page number a comment will appear on for comment paging.
• trailingslashit()Appends a trailing slash.
• user_trailingslashit()Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
• add_query_arg()Retrieves a modified URL query string.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 21

• TwentyNineteen_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
• TwentyTwenty_Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
• WP_Comments_List_Table::column_comment()
• WP_Comments_List_Table::column_date()
• WP_REST_Comments_Controller::prepare_item_for_response()Prepares a single comment output for response.
• WP_Widget_Recent_Comments::widget()Outputs the content for the current Recent Comments widget instance.
• Walker_Comment::comment()Outputs a single comment.
• Walker_Comment::html5_comment()Outputs a comment in the HTML5 format.
• _wp_ajax_delete_comment_response()Sends back current comment total and new page links if they need to be updated.
• _wp_dashboard_recent_comments_row()Outputs a row for the Recent Comments widget.
• comment_link()Displays the link to the comments.
• get_comment_reply_link()Retrieves HTML content for reply to comment link.

Source

View on Trac ↗View on GitHub ↗

778function get_comment_link( $comment = null, $args = array() ) {779	global $wp_rewrite, $in_comment_loop;780 781	$comment = get_comment( $comment );782 783	// Back-compat.784	if ( ! is_array( $args ) ) {785		$args = array( 'page' => $args );786	}787 788	$defaults = array(789		'type'      => 'all',790		'page'      => '',791		'per_page'  => '',792		'max_depth' => '',793		'cpage'     => null,794	);795 796	$args = wp_parse_args( $args, $defaults );797 798	$comment_link = get_permalink( $comment->comment_post_ID );799 800	// The 'cpage' param takes precedence.801	if ( ! is_null( $args['cpage'] ) ) {802		$cpage = $args['cpage'];803 804		// No 'cpage' is provided, so we calculate one.805	} else {806		if ( '' === $args['per_page'] && get_option( 'page_comments' ) ) {807			$args['per_page'] = get_option( 'comments_per_page' );808		}809 810		if ( empty( $args['per_page'] ) ) {811			$args['per_page'] = 0;812			$args['page']     = 0;813		}814 815		$cpage = $args['page'];816 817		if ( '' === $cpage ) {818			if ( ! empty( $in_comment_loop ) ) {819				$cpage = (int) get_query_var( 'cpage' );820			} else {821				// Requires a database hit, so we only do it when we can't figure out from context.822				$cpage = get_page_of_comment( $comment->comment_ID, $args );823			}824		}825 826		/*827		 * If the default page displays the oldest comments, the permalinks for comments on the default page828		 * do not need a 'cpage' query var.829		 */830		if ( 'oldest' === get_option( 'default_comments_page' ) && 1 === $cpage ) {831			$cpage = '';832		}833	}834 835	if ( $cpage && get_option( 'page_comments' ) ) {836		if ( $wp_rewrite->using_permalinks() ) {837			if ( $cpage ) {838				$comment_link = trailingslashit( $comment_link ) . $wp_rewrite->comments_pagination_base . '-' . $cpage;839			}840 841			$comment_link = user_trailingslashit( $comment_link, 'comment' );842		} elseif ( $cpage ) {843			$comment_link = add_query_arg( 'cpage', $cpage, $comment_link );844		}845	}846 847	if ( $wp_rewrite->using_permalinks() ) {848		$comment_link = user_trailingslashit( $comment_link, 'comment' );849	}850 851	$comment_link = $comment_link . '#comment-' . $comment->comment_ID;852 853	/**854	 * Filters the returned single comment permalink.855	 *856	 * @since 2.8.0857	 * @since 4.4.0 Added the `$cpage` parameter.

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/comment-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.