From cf3dbbcaf3b9839a77e281c82dc2f841f7342d08 Mon Sep 17 00:00:00 2001
From: Brian Coords <bacoords@gmail.com>
Date: Mon, 22 Jan 2024 22:33:11 -0800
Subject: [PATCH] Docs: prefixes all php filters with wpdocs_ (#53914)

---
 docs/reference-guides/filters/block-filters.md   | 16 ++++++++--------
 docs/reference-guides/filters/editor-filters.md  |  8 ++++----
 .../filters/global-styles-filters.md             |  4 ++--
 docs/reference-guides/filters/parser-filters.md  |  4 ++--
 4 files changed, 16 insertions(+), 16 deletions(-)

diff --git a/docs/reference-guides/filters/block-filters.md b/docs/reference-guides/filters/block-filters.md
index 4c7e3df7cec12..7e164a10e6c93 100644
--- a/docs/reference-guides/filters/block-filters.md
+++ b/docs/reference-guides/filters/block-filters.md
@@ -19,11 +19,11 @@ _Example_:
 ```php
 <?php
 
-function filter_metadata_registration( $metadata ) {
+function wpdocs_filter_metadata_registration( $metadata ) {
 	$metadata['apiVersion'] = 1;
 	return $metadata;
 };
-add_filter( 'block_type_metadata', 'filter_metadata_registration' );
+add_filter( 'block_type_metadata', 'wpdocs_filter_metadata_registration' );
 
 register_block_type( __DIR__ );
 ```
@@ -40,11 +40,11 @@ The filter takes two params:
 _Example:_
 
 ```php
-function filter_metadata_registration( $settings, $metadata ) {
+function wpdocs_filter_metadata_registration( $settings, $metadata ) {
 	$settings['api_version'] = $metadata['apiVersion'] + 1;
 	return $settings;
 };
-add_filter( 'block_type_metadata_settings', 'filter_metadata_registration', 10, 2 );
+add_filter( 'block_type_metadata_settings', 'wpdocs_filter_metadata_registration', 10, 2 );
 
 register_block_type( __DIR__ );
 ```
@@ -352,14 +352,14 @@ On the server, you can filter the list of blocks shown in the inserter using the
 <?php
 // my-plugin.php
 
-function filter_allowed_block_types_when_post_provided( $allowed_block_types, $editor_context ) {
+function wpdocs_filter_allowed_block_types_when_post_provided( $allowed_block_types, $editor_context ) {
 	if ( ! empty( $editor_context->post ) ) {
 		return array( 'core/paragraph', 'core/heading' );
 	}
 	return $allowed_block_types;
 }
 
-add_filter( 'allowed_block_types_all', 'filter_allowed_block_types_when_post_provided', 10, 2 );
+add_filter( 'allowed_block_types_all', 'wpdocs_filter_allowed_block_types_when_post_provided', 10, 2 );
 ```
 
 ## Managing block categories
@@ -374,7 +374,7 @@ It is possible to filter the list of default block categories using the `block_c
 <?php
 // my-plugin.php
 
-function filter_block_categories_when_post_provided( $block_categories, $editor_context ) {
+function wpdocs_filter_block_categories_when_post_provided( $block_categories, $editor_context ) {
 	if ( ! empty( $editor_context->post ) ) {
 		array_push(
 			$block_categories,
@@ -388,7 +388,7 @@ function filter_block_categories_when_post_provided( $block_categories, $editor_
 	return $block_categories;
 }
 
-add_filter( 'block_categories_all', 'filter_block_categories_when_post_provided', 10, 2 );
+add_filter( 'block_categories_all', 'wpdocs_filter_block_categories_when_post_provided', 10, 2 );
 ```
 
 ### `wp.blocks.updateCategory`
diff --git a/docs/reference-guides/filters/editor-filters.md b/docs/reference-guides/filters/editor-filters.md
index 59f6d7ef8213f..943e161a1df49 100644
--- a/docs/reference-guides/filters/editor-filters.md
+++ b/docs/reference-guides/filters/editor-filters.md
@@ -84,14 +84,14 @@ _Example:_
 <?php
 // my-plugin.php
 
-function filter_block_editor_settings_when_post_provided( $editor_settings, $editor_context ) {
+function wpdocs_filter_block_editor_settings_when_post_provided( $editor_settings, $editor_context ) {
 	if ( ! empty( $editor_context->post ) ) {
 		$editor_settings['maxUploadFileSize'] = 12345;
 	}
 	return $editor_settings;
 }
 
-add_filter( 'block_editor_settings_all', 'filter_block_editor_settings_when_post_provided', 10, 2 );
+add_filter( 'block_editor_settings_all', 'wpdocs_filter_block_editor_settings_when_post_provided', 10, 2 );
 ```
 
 #### `block_editor_rest_api_preload_paths`
@@ -104,14 +104,14 @@ _Example:_
 <?php
 // my-plugin.php
 
-function filter_block_editor_rest_api_preload_paths_when_post_provided( $preload_paths, $editor_context ) {
+function wpdocs_filter_block_editor_rest_api_preload_paths_when_post_provided( $preload_paths, $editor_context ) {
 	if ( ! empty( $editor_context->post ) ) {
 		array_push( $preload_paths, array( '/wp/v2/blocks', 'OPTIONS' ) );
 	}
 	return $preload_paths;
 }
 
-add_filter( 'block_editor_rest_api_preload_paths', 'filter_block_editor_rest_api_preload_paths_when_post_provided', 10, 2 );
+add_filter( 'block_editor_rest_api_preload_paths', 'wpdocs_filter_block_editor_rest_api_preload_paths_when_post_provided', 10, 2 );
 ```
 
 ### Available default editor settings
diff --git a/docs/reference-guides/filters/global-styles-filters.md b/docs/reference-guides/filters/global-styles-filters.md
index 7d3b6be95768b..59bbbfcd5921d 100644
--- a/docs/reference-guides/filters/global-styles-filters.md
+++ b/docs/reference-guides/filters/global-styles-filters.md
@@ -14,7 +14,7 @@ _Example:_
 This is how to pass a new color palette for the theme and disable the text color UI:
 
 ```php
-function filter_theme_json_theme( $theme_json ){
+function wpdocs_filter_theme_json_theme( $theme_json ){
 	$new_data = array(
 		'version'  => 2,
 		'settings' => array(
@@ -38,5 +38,5 @@ function filter_theme_json_theme( $theme_json ){
 
 	return $theme_json->update_with( $new_data );
 }
-add_filter( 'wp_theme_json_data_theme', 'filter_theme_json_theme' );
+add_filter( 'wp_theme_json_data_theme', 'wpdocs_filter_theme_json_theme' );
 ```
diff --git a/docs/reference-guides/filters/parser-filters.md b/docs/reference-guides/filters/parser-filters.md
index 3acfb2489182d..7adc68cc0bf7e 100644
--- a/docs/reference-guides/filters/parser-filters.md
+++ b/docs/reference-guides/filters/parser-filters.md
@@ -26,11 +26,11 @@ class EmptyParser {
   }
 }
 
-function my_plugin_select_empty_parser( $prev_parser_class ) {
+function wpdocs_select_empty_parser( $prev_parser_class ) {
     return 'EmptyParser';
 }
 
-add_filter( 'block_parser_class', 'my_plugin_select_empty_parser', 10, 1 );
+add_filter( 'block_parser_class', 'wpdocs_select_empty_parser', 10, 1 );
 ```
 
 > **Note**: At the present time it's not possible to replace the client-side parser.