{"pageProps":{"title":"pre_comment_user_ip","titleType":"Hook","type":"hooks","content":"<article><h1>pre_comment_user_ip <span>WordPress Filter Hook</span></h1><p class=\"main-description\">The pre_comment_user_ip hook is a WordPress hook that is triggered before a comment is saved to the database. This hook can be used to check the comment author's IP address and to make sure that it is not on a blacklist.</p><h2><span class=\"hook-func\">apply_filters</span>( 'pre_comment_user_ip',  <nobr><span class=\"arg-type\">string</span> <span class=\"arg-name\">$comment_author_ip</span></nobr> ) <a id=\"block-level-html-elements-by-default\" href=\"#pre_comment_user_ip\">#</a></h2><section class=\"summary\"><p>Filters the comment author&#8217;s IP address before it is set.</p></section><div class=\"content-toc\"><div class=\"table-of-contents\"><h2>Contents</h2><ul class=\"items\"><li><a href=\"#parameters\">Parameters</a></li><li><a href=\"#more-information\">More Information</a></li><li><a href=\"#source\">Source</a></li><li><a href=\"#related\">Related</a><ul><li><a href=\"#used-by\">Used By</a></ul></li><li><a href=\"#changelog\">Changelog</a></li></ul></div><hr /><section class=\"parameters\"><h2 id=\"parameters\" class=\"toc-heading\" tabindex=\"-1\" ><a href=\"#parameters\" class=\"dashicons-before dashicons-admin-links\">Parameters</a></h2><dl><dt>$comment_author_ip</dt><dd><p class=\"desc\"><span class=\"type\">(<span class=\"string\">string</span>)</span><span class=\"description\">The comment author's IP address.</span></p></dd></dl></section><hr /><section class=\"explanation\"><p class=\"toc-jump\"><a href=\"#top\">Top &uarr;</a></p><h2 id=\"more-information\" class=\"toc-heading\" tabindex=\"-1\" ><a href=\"#more-information\" class=\"dashicons-before dashicons-admin-links\">More Information</a></h2><p>With this filter, we can change the comment author&#8217;s IP before it&#8217;s recorded. Example use case can be when a client submits a comment through a proxy server.</p><p>The general format of the header is:<br /><code>X-Forwarded-For: client1, proxy1, proxy2</code></p><p>where the value is a comma+space separated list of IP addresses, the left-most being the original client, and each successive proxy that passed the request adding the IP address where it received the request from. In this example, the request goes through the IPs: client1 -&gt; proxy1 -&gt; proxy2 -&gt; proxy3. Proxy3 is not shown in the <code>X-Forwarded-For</code> header here and appears as the remote address of the request.</p><p>Since it is easy to forge an <code>X-Forwarded-For</code> header, the given information should be used with care.</p><p><code>X-Forwarded-For</code>, <code>X-Forwarded-By</code>, and <code>X-Forwarded-Proto</code> are non-standard header fields and in increasing cases, have been superseded by the standard <code>Forwarded</code> header defined in RFC 7239. Example of a <code>Forwarded</code> header:<br /><code>Forwarded: for=192.0.2.60;proto=http;by=203.0.113.43</code></p></section><hr /><section class=\"source-content\"><p class=\"toc-jump\"><a href=\"#top\">Top &uarr;</a></p><h2 id=\"source\" class=\"toc-heading\" tabindex=\"-1\" ><a href=\"#source\" class=\"dashicons-before dashicons-admin-links\">Source</a></h2><p>File: <a href=\"/reference/files/wp-includes/comment.php\">wp-includes/comment.php</a></p><p><a href=\"https://core.trac.wordpress.org/browser/tags/6.0/src/wp-includes/comment.php#L2110\">View on Trac</a></p></section><hr /><section class=\"related\"><p class=\"toc-jump\"><a href=\"#top\">Top &uarr;</a></p><h2 id=\"related\" class=\"toc-heading\" tabindex=\"-1\" ><a href=\"#related\" class=\"dashicons-before dashicons-admin-links\">Related</a></h2><article class=\"used-by\"><p class=\"toc-jump\"><a href=\"#top\">Top &uarr;</a></p><h3 id=\"used-by\" class=\"toc-heading\" tabindex=\"-1\" ><a href=\"#used-by\" class=\"dashicons-before dashicons-admin-links\">Used By</a></h3><table id=\"used-by-table\"><caption class=\"screen-reader-text\">Used By</caption><thead><tr><th>Used By</th><th class=\"related-desc\">Description</th></tr></thead><tbody><tr><td><span>wp-includes/comment.php:</span><a href=\"/reference/functions/wp_filter_comment\">wp_filter_comment()</a></td><td class=\"related-desc\"><p>Filters and sanitizes comment data.</p></td></tr><tbody></table></article></section><hr /><section class=\"changelog\"><p class=\"toc-jump\"><a href=\"#top\">Top &uarr;</a></p><h2 id=\"changelog\" class=\"toc-heading\" tabindex=\"-1\" ><a href=\"#changelog\" class=\"dashicons-before dashicons-admin-links\">Changelog</a></h2><table><caption class=\"screen-reader-text\">Changelog</caption><thead><tr><th class=\"changelog-version\">Version</th><th class=\"changelog-desc\">Description</th></tr></thead><tbody><tr><td><a href=\"/reference/since/1.5.0\" alt=\"WordPress 1.5.0\">1.5.0</a></td><td>Introduced.</td></tr></tbody></table></section></div></article>","description":"Filters the comment author&#8217;s IP address before it is set.","sidebarFiles":{"Hook":[{"componentTitle":"allow_empty_comment","componentLink":"/reference/hooks/allow_empty_comment","private":"","deprecated":""},{"componentTitle":"check_comment_flood","componentLink":"/reference/hooks/check_comment_flood","private":"","deprecated":""},{"componentTitle":"clean_comment_cache","componentLink":"/reference/hooks/clean_comment_cache","private":"","deprecated":""},{"componentTitle":"close_comments_for_post_types","componentLink":"/reference/hooks/close_comments_for_post_types","private":"","deprecated":""},{"componentTitle":"comment_{$new_status}_{$comment->comment_type}","componentLink":"/reference/hooks/comment_new_status_comment-comment_type","private":"","deprecated":""},{"componentTitle":"comment_{$old_status}_to_{$new_status}","componentLink":"/reference/hooks/comment_old_status_to_new_status","private":"","deprecated":""},{"componentTitle":"comment_closed","componentLink":"/reference/hooks/comment_closed","private":"","deprecated":""},{"componentTitle":"comment_cookie_lifetime","componentLink":"/reference/hooks/comment_cookie_lifetime","private":"","deprecated":""},{"componentTitle":"comment_duplicate_message","componentLink":"/reference/hooks/comment_duplicate_message","private":"","deprecated":""},{"componentTitle":"comment_duplicate_trigger","componentLink":"/reference/hooks/comment_duplicate_trigger","private":"","deprecated":""},{"componentTitle":"comment_flood_filter","componentLink":"/reference/hooks/comment_flood_filter","private":"","deprecated":""},{"componentTitle":"comment_flood_message","componentLink":"/reference/hooks/comment_flood_message","private":"","deprecated":""},{"componentTitle":"comment_flood_trigger","componentLink":"/reference/hooks/comment_flood_trigger","private":"","deprecated":""},{"componentTitle":"comment_id_not_found","componentLink":"/reference/hooks/comment_id_not_found","private":"","deprecated":""},{"componentTitle":"comment_max_links_url","componentLink":"/reference/hooks/comment_max_links_url","private":"","deprecated":""},{"componentTitle":"comment_on_draft","componentLink":"/reference/hooks/comment_on_draft","private":"","deprecated":""},{"componentTitle":"comment_on_password_protected","componentLink":"/reference/hooks/comment_on_password_protected","private":"","deprecated":""},{"componentTitle":"comment_on_trash","componentLink":"/reference/hooks/comment_on_trash","private":"","deprecated":""},{"componentTitle":"comment_post","componentLink":"/reference/hooks/comment_post","private":"","deprecated":""},{"componentTitle":"comment_save_pre","componentLink":"/reference/hooks/comment_save_pre","private":"","deprecated":""},{"componentTitle":"delete_comment","componentLink":"/reference/hooks/delete_comment","private":"","deprecated":""},{"componentTitle":"deleted_comment","componentLink":"/reference/hooks/deleted_comment","private":"","deprecated":""},{"componentTitle":"do_all_pings","componentLink":"/reference/hooks/do_all_pings","private":"","deprecated":""},{"componentTitle":"duplicate_comment_id","componentLink":"/reference/hooks/duplicate_comment_id","private":"","deprecated":""},{"componentTitle":"edit_comment","componentLink":"/reference/hooks/edit_comment","private":"","deprecated":""},{"componentTitle":"get_comment","componentLink":"/reference/hooks/get_comment","private":"","deprecated":""},{"componentTitle":"get_default_comment_status","componentLink":"/reference/hooks/get_default_comment_status","private":"","deprecated":""},{"componentTitle":"get_page_of_comment","componentLink":"/reference/hooks/get_page_of_comment","private":"","deprecated":""},{"componentTitle":"get_page_of_comment_query_args","componentLink":"/reference/hooks/get_page_of_comment_query_args","private":"","deprecated":""},{"componentTitle":"notify_post_author","componentLink":"/reference/hooks/notify_post_author","private":"","deprecated":""},{"componentTitle":"pingback_useragent","componentLink":"/reference/hooks/pingback_useragent","private":"","deprecated":""},{"componentTitle":"pre_comment_approved","componentLink":"/reference/hooks/pre_comment_approved","private":"","deprecated":""},{"componentTitle":"pre_comment_author_email","componentLink":"/reference/hooks/pre_comment_author_email","private":"","deprecated":""},{"componentTitle":"pre_comment_author_name","componentLink":"/reference/hooks/pre_comment_author_name","private":"","deprecated":""},{"componentTitle":"pre_comment_author_url","componentLink":"/reference/hooks/pre_comment_author_url","private":"","deprecated":""},{"componentTitle":"pre_comment_content","componentLink":"/reference/hooks/pre_comment_content","private":"","deprecated":""},{"componentTitle":"pre_comment_on_post","componentLink":"/reference/hooks/pre_comment_on_post","private":"","deprecated":""},{"componentTitle":"pre_comment_user_agent","componentLink":"/reference/hooks/pre_comment_user_agent","private":"","deprecated":""},{"componentTitle":"pre_comment_user_ip","componentLink":"/reference/hooks/pre_comment_user_ip","private":"","deprecated":"","active":"active"},{"componentTitle":"pre_ping","componentLink":"/reference/hooks/pre_ping","private":"","deprecated":""},{"componentTitle":"pre_user_id","componentLink":"/reference/hooks/pre_user_id","private":"","deprecated":""},{"componentTitle":"pre_wp_update_comment_count_now","componentLink":"/reference/hooks/pre_wp_update_comment_count_now","private":"","deprecated":""},{"componentTitle":"preprocess_comment","componentLink":"/reference/hooks/preprocess_comment","private":"","deprecated":""},{"componentTitle":"spam_comment","componentLink":"/reference/hooks/spam_comment","private":"","deprecated":""},{"componentTitle":"spammed_comment","componentLink":"/reference/hooks/spammed_comment","private":"","deprecated":""},{"componentTitle":"transition_comment_status","componentLink":"/reference/hooks/transition_comment_status","private":"","deprecated":""},{"componentTitle":"trash_comment","componentLink":"/reference/hooks/trash_comment","private":"","deprecated":""},{"componentTitle":"trashed_comment","componentLink":"/reference/hooks/trashed_comment","private":"","deprecated":""},{"componentTitle":"unspam_comment","componentLink":"/reference/hooks/unspam_comment","private":"","deprecated":""},{"componentTitle":"unspammed_comment","componentLink":"/reference/hooks/unspammed_comment","private":"","deprecated":""},{"componentTitle":"untrash_comment","componentLink":"/reference/hooks/untrash_comment","private":"","deprecated":""},{"componentTitle":"untrashed_comment","componentLink":"/reference/hooks/untrashed_comment","private":"","deprecated":""},{"componentTitle":"wp_anonymize_comment","componentLink":"/reference/hooks/wp_anonymize_comment","private":"","deprecated":""},{"componentTitle":"wp_blacklist_check","componentLink":"/reference/hooks/wp_blacklist_check","private":"","deprecated":"deprecated"},{"componentTitle":"wp_check_comment_disallowed_list","componentLink":"/reference/hooks/wp_check_comment_disallowed_list","private":"","deprecated":""},{"componentTitle":"wp_count_comments","componentLink":"/reference/hooks/wp_count_comments","private":"","deprecated":""},{"componentTitle":"wp_get_comment_fields_max_lengths","componentLink":"/reference/hooks/wp_get_comment_fields_max_lengths","private":"","deprecated":""},{"componentTitle":"wp_get_current_commenter","componentLink":"/reference/hooks/wp_get_current_commenter","private":"","deprecated":""},{"componentTitle":"wp_insert_comment","componentLink":"/reference/hooks/wp_insert_comment","private":"","deprecated":""},{"componentTitle":"wp_is_comment_flood","componentLink":"/reference/hooks/wp_is_comment_flood","private":"","deprecated":""},{"componentTitle":"wp_set_comment_status","componentLink":"/reference/hooks/wp_set_comment_status","private":"","deprecated":""},{"componentTitle":"wp_update_comment_count","componentLink":"/reference/hooks/wp_update_comment_count","private":"","deprecated":""},{"componentTitle":"wp_update_comment_data","componentLink":"/reference/hooks/wp_update_comment_data","private":"","deprecated":""},{"componentTitle":"wp_update_comment_type_batch_size","componentLink":"/reference/hooks/wp_update_comment_type_batch_size","private":"","deprecated":""}],"Function":[{"componentTitle":"add_comment_meta()","componentLink":"/reference/functions/add_comment_meta","private":"","deprecated":""},{"componentTitle":"check_comment_flood_db()","componentLink":"/reference/functions/check_comment_flood_db","private":"","deprecated":""},{"componentTitle":"check_comment()","componentLink":"/reference/functions/check_comment","private":"","deprecated":""},{"componentTitle":"clean_comment_cache()","componentLink":"/reference/functions/clean_comment_cache","private":"","deprecated":""},{"componentTitle":"delete_comment_meta()","componentLink":"/reference/functions/delete_comment_meta","private":"","deprecated":""},{"componentTitle":"discover_pingback_server_uri()","componentLink":"/reference/functions/discover_pingback_server_uri","private":"","deprecated":""},{"componentTitle":"do_all_enclosures()","componentLink":"/reference/functions/do_all_enclosures","private":"","deprecated":""},{"componentTitle":"do_all_pingbacks()","componentLink":"/reference/functions/do_all_pingbacks","private":"","deprecated":""},{"componentTitle":"do_all_pings()","componentLink":"/reference/functions/do_all_pings","private":"","deprecated":""},{"componentTitle":"do_all_trackbacks()","componentLink":"/reference/functions/do_all_trackbacks","private":"","deprecated":""},{"componentTitle":"do_trackbacks()","componentLink":"/reference/functions/do_trackbacks","private":"","deprecated":""},{"componentTitle":"generic_ping()","componentLink":"/reference/functions/generic_ping","private":"","deprecated":""},{"componentTitle":"get_approved_comments()","componentLink":"/reference/functions/get_approved_comments","private":"","deprecated":""},{"componentTitle":"get_comment_count()","componentLink":"/reference/functions/get_comment_count","private":"","deprecated":""},{"componentTitle":"get_comment_meta()","componentLink":"/reference/functions/get_comment_meta","private":"","deprecated":""},{"componentTitle":"get_comment_pages_count()","componentLink":"/reference/functions/get_comment_pages_count","private":"","deprecated":""},{"componentTitle":"get_comment_statuses()","componentLink":"/reference/functions/get_comment_statuses","private":"","deprecated":""},{"componentTitle":"get_comment()","componentLink":"/reference/functions/get_comment","private":"","deprecated":""},{"componentTitle":"get_comments()","componentLink":"/reference/functions/get_comments","private":"","deprecated":""},{"componentTitle":"get_default_comment_status()","componentLink":"/reference/functions/get_default_comment_status","private":"","deprecated":""},{"componentTitle":"get_lastcommentmodified()","componentLink":"/reference/functions/get_lastcommentmodified","private":"","deprecated":""},{"componentTitle":"get_page_of_comment()","componentLink":"/reference/functions/get_page_of_comment","private":"","deprecated":""},{"componentTitle":"pingback_ping_source_uri()","componentLink":"/reference/functions/pingback_ping_source_uri","private":"","deprecated":""},{"componentTitle":"pingback()","componentLink":"/reference/functions/pingback","private":"","deprecated":""},{"componentTitle":"privacy_ping_filter()","componentLink":"/reference/functions/privacy_ping_filter","private":"","deprecated":""},{"componentTitle":"sanitize_comment_cookies()","componentLink":"/reference/functions/sanitize_comment_cookies","private":"","deprecated":""},{"componentTitle":"separate_comments()","componentLink":"/reference/functions/separate_comments","private":"","deprecated":""},{"componentTitle":"trackback()","componentLink":"/reference/functions/trackback","private":"","deprecated":""},{"componentTitle":"update_comment_cache()","componentLink":"/reference/functions/update_comment_cache","private":"","deprecated":""},{"componentTitle":"update_comment_meta()","componentLink":"/reference/functions/update_comment_meta","private":"","deprecated":""},{"componentTitle":"weblog_ping()","componentLink":"/reference/functions/weblog_ping","private":"","deprecated":""},{"componentTitle":"wp_allow_comment()","componentLink":"/reference/functions/wp_allow_comment","private":"","deprecated":""},{"componentTitle":"wp_cache_set_comments_last_changed()","componentLink":"/reference/functions/wp_cache_set_comments_last_changed","private":"","deprecated":""},{"componentTitle":"wp_check_comment_data_max_lengths()","componentLink":"/reference/functions/wp_check_comment_data_max_lengths","private":"","deprecated":""},{"componentTitle":"wp_check_comment_disallowed_list()","componentLink":"/reference/functions/wp_check_comment_disallowed_list","private":"","deprecated":""},{"componentTitle":"wp_check_comment_flood()","componentLink":"/reference/functions/wp_check_comment_flood","private":"","deprecated":""},{"componentTitle":"wp_comments_personal_data_eraser()","componentLink":"/reference/functions/wp_comments_personal_data_eraser","private":"","deprecated":""},{"componentTitle":"wp_comments_personal_data_exporter()","componentLink":"/reference/functions/wp_comments_personal_data_exporter","private":"","deprecated":""},{"componentTitle":"wp_count_comments()","componentLink":"/reference/functions/wp_count_comments","private":"","deprecated":""},{"componentTitle":"wp_defer_comment_counting()","componentLink":"/reference/functions/wp_defer_comment_counting","private":"","deprecated":""},{"componentTitle":"wp_delete_comment()","componentLink":"/reference/functions/wp_delete_comment","private":"","deprecated":""},{"componentTitle":"wp_filter_comment()","componentLink":"/reference/functions/wp_filter_comment","private":"","deprecated":""},{"componentTitle":"wp_get_comment_fields_max_lengths()","componentLink":"/reference/functions/wp_get_comment_fields_max_lengths","private":"","deprecated":""},{"componentTitle":"wp_get_comment_status()","componentLink":"/reference/functions/wp_get_comment_status","private":"","deprecated":""},{"componentTitle":"wp_get_current_commenter()","componentLink":"/reference/functions/wp_get_current_commenter","private":"","deprecated":""},{"componentTitle":"wp_get_unapproved_comment_author_email()","componentLink":"/reference/functions/wp_get_unapproved_comment_author_email","private":"","deprecated":""},{"componentTitle":"wp_handle_comment_submission()","componentLink":"/reference/functions/wp_handle_comment_submission","private":"","deprecated":""},{"componentTitle":"wp_insert_comment()","componentLink":"/reference/functions/wp_insert_comment","private":"","deprecated":""},{"componentTitle":"wp_new_comment_notify_moderator()","componentLink":"/reference/functions/wp_new_comment_notify_moderator","private":"","deprecated":""},{"componentTitle":"wp_new_comment_notify_postauthor()","componentLink":"/reference/functions/wp_new_comment_notify_postauthor","private":"","deprecated":""},{"componentTitle":"wp_new_comment()","componentLink":"/reference/functions/wp_new_comment","private":"","deprecated":""},{"componentTitle":"wp_queue_comments_for_comment_meta_lazyload()","componentLink":"/reference/functions/wp_queue_comments_for_comment_meta_lazyload","private":"","deprecated":""},{"componentTitle":"wp_register_comment_personal_data_eraser()","componentLink":"/reference/functions/wp_register_comment_personal_data_eraser","private":"","deprecated":""},{"componentTitle":"wp_register_comment_personal_data_exporter()","componentLink":"/reference/functions/wp_register_comment_personal_data_exporter","private":"","deprecated":""},{"componentTitle":"wp_set_comment_cookies()","componentLink":"/reference/functions/wp_set_comment_cookies","private":"","deprecated":""},{"componentTitle":"wp_set_comment_status()","componentLink":"/reference/functions/wp_set_comment_status","private":"","deprecated":""},{"componentTitle":"wp_spam_comment()","componentLink":"/reference/functions/wp_spam_comment","private":"","deprecated":""},{"componentTitle":"wp_throttle_comment_flood()","componentLink":"/reference/functions/wp_throttle_comment_flood","private":"","deprecated":""},{"componentTitle":"wp_transition_comment_status()","componentLink":"/reference/functions/wp_transition_comment_status","private":"","deprecated":""},{"componentTitle":"wp_trash_comment()","componentLink":"/reference/functions/wp_trash_comment","private":"","deprecated":""},{"componentTitle":"wp_unspam_comment()","componentLink":"/reference/functions/wp_unspam_comment","private":"","deprecated":""},{"componentTitle":"wp_untrash_comment()","componentLink":"/reference/functions/wp_untrash_comment","private":"","deprecated":""},{"componentTitle":"wp_update_comment_count_now()","componentLink":"/reference/functions/wp_update_comment_count_now","private":"","deprecated":""},{"componentTitle":"wp_update_comment_count()","componentLink":"/reference/functions/wp_update_comment_count","private":"","deprecated":""},{"componentTitle":"wp_update_comment()","componentLink":"/reference/functions/wp_update_comment","private":"","deprecated":""},{"componentTitle":"xmlrpc_pingback_error()","componentLink":"/reference/functions/xmlrpc_pingback_error","private":"","deprecated":""},{"componentTitle":"_clear_modified_cache_on_transition_comment_status()","componentLink":"/reference/functions/_clear_modified_cache_on_transition_comment_status","private":"private","deprecated":""},{"componentTitle":"_close_comments_for_old_post()","componentLink":"/reference/functions/_close_comments_for_old_post","private":"private","deprecated":""},{"componentTitle":"_close_comments_for_old_posts()","componentLink":"/reference/functions/_close_comments_for_old_posts","private":"private","deprecated":""},{"componentTitle":"_prime_comment_caches()","componentLink":"/reference/functions/_prime_comment_caches","private":"private","deprecated":""},{"componentTitle":"_wp_batch_update_comment_type()","componentLink":"/reference/functions/_wp_batch_update_comment_type","private":"","deprecated":""}]}},"__N_SSG":true}