get_page_of_comment( int $comment_id, array $args = array() ): int|null

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$comment_idint

Comment ID.

$argsarrayoptional

Array of optional arguments.Default: array()

• $typestringdefault: 'all'

  Limit paginated comments to those matching a given type. Accepts 'comment', 'trackback', 'pingback', 'pings' (trackbacks and pingbacks), or 'all'.

• $per_pageint

  Per-page count to use when calculating pagination. Defaults to the value of the 'comments_per_page' option.

• $max_depthint|string

  If greater than 1, comment page will be determined for the top-level parent $comment_id. Defaults to the value of the 'thread_comments_depth' option.

Return value

int|null

Comment page number or null on error.

Performance profile

How much work a call to get_page_of_comment() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->query().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

10–124

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 142.

Plugin surface

2 hooks

Third-party callbacks on 'get_page_of_comment_query_args', 'get_page_of_comment' run inside this call, and their cost is not bounded by anything here.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• sqldatabase query->query()called directly
• cacheobject cachewp_cache_get()one call below get_page_of_comment()
• serializeserialisationmaybe_unserialize()one call below get_page_of_comment()

Further down the call graph this can also reach transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 45 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_page_of_comment() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while get_page_of_comment() runs, in this order:

1. 1
   apply_filters( get_page_of_comment_query_args )filterline 1210 (+103 into the body)

   Filters the arguments used to query comments in get_page_of_comment().

2. 2
   apply_filters( get_page_of_comment )filterline 1252 (+145 into the body)

   Filters the calculated page on which a comment appears.

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_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.
• is_user_logged_in()Determines whether the current visitor is a logged in user.
• get_current_user_id()Gets the current user's ID.
• wp_get_unapproved_comment_author_email()Gets unapproved comment author's email.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Comment_Query::__construct()Constructor.

Used by · 2

• get_comment_link()Retrieves the link to a given comment.
• get_page_of_comment()Calculates what page number a comment will appear on for comment paging.

Source code

View on Trac ↗View on GitHub ↗

1107function get_page_of_comment( $comment_id, $args = array() ) {1108	global $wpdb;1109 1110	$page = null;1111 1112	$comment = get_comment( $comment_id );1113	if ( ! $comment ) {1114		return null;1115	}1116 1117	$defaults      = array(1118		'type'      => 'all',1119		'page'      => '',1120		'per_page'  => '',1121		'max_depth' => '',1122	);1123	$args          = wp_parse_args( $args, $defaults );1124	$original_args = $args;1125 1126	// Order of precedence: 1. `$args['per_page']`, 2. 'comments_per_page' query_var, 3. 'comments_per_page' option.1127	if ( get_option( 'page_comments' ) ) {1128		if ( '' === $args['per_page'] ) {1129			$args['per_page'] = get_query_var( 'comments_per_page' );1130		}1131 1132		if ( '' === $args['per_page'] ) {1133			$args['per_page'] = get_option( 'comments_per_page' );1134		}1135	}1136 1137	if ( empty( $args['per_page'] ) ) {1138		$args['per_page'] = 0;1139		$args['page']     = 0;1140	}1141 1142	if ( $args['per_page'] < 1 ) {1143		$page = 1;1144	}1145 1146	if ( null === $page ) {1147		if ( '' === $args['max_depth'] ) {1148			if ( get_option( 'thread_comments' ) ) {1149				$args['max_depth'] = get_option( 'thread_comments_depth' );1150			} else {1151				$args['max_depth'] = -1;1152			}1153		}1154 1155		// Find this comment's top-level parent if threading is enabled.1156		if ( $args['max_depth'] > 1 && '0' !== $comment->comment_parent ) {1157			return get_page_of_comment( $comment->comment_parent, $args );1158		}1159 1160		$comment_args = array(1161			'type'       => $args['type'],1162			'post_id'    => $comment->comment_post_ID,1163			'fields'     => 'ids',1164			'count'      => true,1165			'status'     => 'approve',1166			'orderby'    => 'none',1167			'parent'     => 0,1168			'date_query' => array(1169				array(1170					'column' => "$wpdb->comments.comment_date_gmt",1171					'before' => $comment->comment_date_gmt,1172				),1173			),1174		);1175 1176		if ( is_user_logged_in() ) {1177			$comment_args['include_unapproved'] = array( get_current_user_id() );1178		} else {1179			$unapproved_email = wp_get_unapproved_comment_author_email();1180 1181			if ( $unapproved_email ) {1182				$comment_args['include_unapproved'] = array( $unapproved_email );1183			}1184		}1185 1186		/**

Changelog

Introduced in 2.7.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 7.1.0 tag, from src/wp-includes/comment.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.