functions.php — Advanced Ads – Ad Manager & AdSense 2.0.26

advanced-ads / includes / functions.php

advanced-ads / includes Last commit date

functions.php

111 lines

1	<?php
2	/**
3	* Functions that are directly available in WordPress themes (and plugins)
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.48.0
8	*/
9
10	use AdvancedAds\Framework\Utilities\Params;
11
12	/**
13	* Returns the default arguments for an entity.
14	*
15	* @param string $method The method to get the entity.
16	* @param int\|string $id The ID of the entity.
17	* @param array<string, mixed> $args Additional arguments for the entity.
18	*
19	* @return array<string, mixed> The default arguments for the entity.
20	*/
21	function wp_advads_default_entity_arguments( $method, $id, $args ): array {
22	$args = (array) $args;
23
24	$args['previous_id'] = $args['id'] ?? null;
25	$args['previous_method'] = $args['method'] ?? null;
26
27	if ( $id \|\| ! isset( $args['id'] ) ) {
28	$args['id'] = $id;
29	}
30
31	$args['method'] = $method;
32
33	return apply_filters( 'advanced-ads-ad-select-args', $args, $method, $id );
34	}
35
36	/**
37	* Sets additional arguments for an entity.
38	*
39	* @param object $entity The entity object.
40	* @param array<string, mixed> $args The additional arguments to set for the entity.
41	*
42	* @return void
43	*/
44	function wp_advads_set_additional_args( $entity, $args ): void {
45	$entity->set_prop_temp( 'ad_args', $args );
46	}
47
48	/**
49	* Get user IP address.
50	*
51	* @return bool\|string IP address or false if not found
52	*/
53	function get_user_ip_address() {
54	// phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- NO NEED TO SANITIZE HEADERS
55
56	// Define the list of IP headers in the order of priority.
57	$ip_headers = [
58	'HTTP_CF_CONNECTING_IP', // Cloudflare.
59	'HTTP_CLIENT_IP', // General.
60	'HTTP_X_REAL_IP', // General.
61	'HTTP_X_FORWARDED_FOR', // General.
62	'HTTP_X_FORWARDED', // General.
63	'HTTP_X_CLUSTER_CLIENT_IP', // General.
64	'HTTP_FORWARDED_FOR', // General.
65	'HTTP_FORWARDED', // General.
66	'REMOTE_ADDR', // Default server value.
67	];
68
69	// Get the server's IP address.
70	$server_ip = Params::server( 'SERVER_ADDR', '' );
71
72	foreach ( $ip_headers as $header ) {
73	// Check if the header exists and is not empty.
74	$data = Params::server( $header, '' );
75	if ( ! empty( $data ) ) {
76	// Split the header value by comma to handle multiple IP addresses.
77	$ip_list = explode( ',', $data );
78
79	foreach ( $ip_list as $ip ) {
80	// Trim whitespace and remove any 'for=' prefix from the IP address.
81	$ip = trim( str_replace( 'for=', '', $ip ) );
82
83	// Validate the IP address and ensure it's not the server's IP.
84	if ( filter_var( $ip, FILTER_VALIDATE_IP ) && $ip !== $server_ip ) {
85	return $ip;
86	}
87	}
88	}
89	}
90	// phpcs:enable
91	return false;
92	}
93
94	/**
95	* Returns an empty array if the value is null.
96	*/
97	if ( ! function_exists( '__return_array_if_null' ) ) {
98	// phpcs:disable
99	/**
100	* Returns an empty array if the value is null.
101	*
102	* @param mixed $value The value to check.
103	*
104	* @return array<string, mixed>
105	*/
106	function __return_array_if_null( $value ): array {
107	return $value ?? [];
108	}
109	// phpcs:enable
110	}
111