Documenting some hooks inline

adminpages/affiliates.php

@@ -320,7 +320,12 @@
 				</tbody>
 			</table>
 
-			<?php do_action("pmpro_affiliate_after_settings"); ?>
+			<?php
+				/**
+				 * Action to add additional fields to the affiliate edit form.
+				 */
+				do_action("pmpro_affiliate_after_settings");
+			?>
 
 			<p class="submit topborder">
 				<input name="edit" type="hidden" value="<?php if(!empty($edit)) echo esc_attr( $edit ); ?>" />
@@ -381,7 +386,12 @@
 						<th><?php esc_html_e( 'Conversion %', 'pmpro-affiliates' ); ?></th>
 						<th><?php esc_html_e( 'Commission Earned', 'pmpro-affiliate' ); ?></th>
 						<th><?php esc_html_e( 'Revenue Contributed', 'pmpro-affiliates' ); ?></th>
-						<?php do_action( "pmpro_affiliate_extra_cols_header" ); ?>
+						<?php
+							/**
+							 * Action to add additional columns to the affiliates table.
+							 */
+							do_action( "pmpro_affiliate_extra_cols_header" );
+						?>
 					</tr>
 				</thead>
 				<tbody>
@@ -463,7 +473,15 @@
 							<td>
 								<?php echo pmpro_formatPrice( $earnings ); ?>
 							</td>
-							<?php do_action( "pmpro_affiliate_extra_cols_body", $affiliate, $earnings ); ?>
+							<?php
+								/**
+								 * Action to populate additional columns in the affiliates table.
+								 *
+								 * @param object $affiliate The affiliate object
+								 * @param float $earnings The earnings for the affiliate
+								 */
+								do_action( "pmpro_affiliate_extra_cols_body", $affiliate, $earnings );
+							?>
 						</tr>
 					<?php } ?>
 				</tbody>

adminpages/report-csv.php

@@ -63,6 +63,13 @@
 		'total',
 	);
 
+	/**
+	 * Filter the headings for the CSV export.
+	 *
+	 * @param array $headings The headings for the CSV export.
+	 *
+	 * @return array The modified headings.
+	 */
 	$headings = apply_filters( 'pmpro_affiliate_list_csv_extra_columns', $headings ); // Add to the string.
 
 	echo implode( ',', $headings ) . "\n";
@@ -84,6 +91,14 @@
 				pmpro_enclose( $order->total ),
 			);
 
+			/**
+			 * Filter the data for the CSV export.
+			 *
+			 * @param array $pmpro_affiliate_report_data The data for the CSV export.
+			 * @param object $order The order object.
+			 * @param object $level The membership level object.
+			 * @return array The modified data.
+			 */
 			$pmpro_affiliate_report_data = apply_filters( 'pmpro_affiliate_list_csv_extra_column_data', $pmpro_affiliate_report_data, $order, $level );
 
 			echo implode( ',', $pmpro_affiliate_report_data ) . "\n";

adminpages/report.php

@@ -96,7 +96,12 @@
 					<th><?php esc_html_e( 'Commission Earned', 'pmpro-affiliates' ); ?></th>
 					<th><?php esc_html_e( 'Order Total', 'pmpro-affiliates' ); ?></th>
 					<th><?php esc_html_e( 'Status', 'pmpro-affiliates' ); ?></th>
-					<?php do_action( "pmpro_affiliate_report_extra_cols_header" ); ?>
+					<?php
+						/**
+						 * Action to add additional columns to the affiliates report table.
+						 */
+						do_action( "pmpro_affiliate_report_extra_cols_header" );
+					?>
 				</tr>
 			</thead>
 			<tbody>
@@ -156,7 +161,14 @@
 							<td><?php echo pmpro_formatPrice( $order->total * $order->commissionrate ); ?></td>
 							<td><?php echo pmpro_formatPrice( $order->total ); ?></td>
 							<td><?php echo '<span class="pmpro_affiliate_paid_status" id="order_' . esc_attr( $order->order_id ) . '">' . $affiliate_paid . '</span>'; // We escape the $affiliate_paid before outputting further up.?></td>
-							<?php do_action( "pmpro_affiliate_report_extra_cols_body", $order ); ?>
+							<?php
+								/**
+								 * Action to populate additional columns in the affiliates report table.
+								 *
+								 * @param object $order The order object.
+								 */
+								do_action( "pmpro_affiliate_report_extra_cols_body", $order );
+							?>
 						</tr>
 						<?php
 					}

pmpro-affiliates.php

@@ -280,6 +280,14 @@ function pmpro_affiliates_generate_affiliate_after_checkout( $user_id, $morder )
 	$pmpro_create_affiliate_level = get_option( 'pmpro_create_affiliate_level_' . $pmpro_level->id );
 	$code                         = pmpro_affiliates_getNewCode();
 	if ( ! empty( $pmpro_create_affiliate_level ) ) {
+		/**
+		 * Filter the number of days to set the cookie for the affiliate.
+		 *
+		 * @param int $days The number of days to set the cookie for the affiliate.
+		 * @param int $user_id The user ID.
+		 * @param object $pmpro_level The membership level object.
+		 * @return int The number of days to set the cookie for the affiliate.
+		 */
 		$days     = intval( apply_filters( 'pmproaf_default_cookie_duration', 30, $user_id, $pmpro_level ) );
 		$sqlQuery = "INSERT INTO $wpdb->pmpro_affiliates (code, name, affiliateuser, trackingcode, cookiedays, enabled) VALUES('" . esc_sql( $code ) . "', '" . esc_sql( $user->display_name ) . "', '" . esc_sql( $user->user_login ) . "', '', $days, '1')";
 		$wpdb->query( $sqlQuery );