WordPress 4.3
[autoinstalls/wordpress.git] / wp-includes / default-filters.php
1 <?php
2 /**
3  * Sets up the default filters and actions for most
4  * of the WordPress hooks.
5  *
6  * If you need to remove a default hook, this file will
7  * give you the priority for which to use to remove the
8  * hook.
9  *
10  * Not all of the default hooks are found in default-filters.php
11  *
12  * @package WordPress
13  */
14
15 // Strip, trim, kses, special chars for string saves
16 foreach ( array( 'pre_term_name', 'pre_comment_author_name', 'pre_link_name', 'pre_link_target', 'pre_link_rel', 'pre_user_display_name', 'pre_user_first_name', 'pre_user_last_name', 'pre_user_nickname' ) as $filter ) {
17         add_filter( $filter, 'sanitize_text_field'  );
18         add_filter( $filter, 'wp_filter_kses'       );
19         add_filter( $filter, '_wp_specialchars', 30 );
20 }
21
22 // Strip, kses, special chars for string display
23 foreach ( array( 'term_name', 'comment_author_name', 'link_name', 'link_target', 'link_rel', 'user_display_name', 'user_first_name', 'user_last_name', 'user_nickname' ) as $filter ) {
24         if ( is_admin() ) {
25                 // These are expensive. Run only on admin pages for defense in depth.
26                 add_filter( $filter, 'sanitize_text_field'  );
27                 add_filter( $filter, 'wp_kses_data'       );
28         }
29         add_filter( $filter, '_wp_specialchars', 30 );
30 }
31
32 // Kses only for textarea saves
33 foreach ( array( 'pre_term_description', 'pre_link_description', 'pre_link_notes', 'pre_user_description' ) as $filter ) {
34         add_filter( $filter, 'wp_filter_kses' );
35 }
36
37 // Kses only for textarea admin displays
38 if ( is_admin() ) {
39         foreach ( array( 'term_description', 'link_description', 'link_notes', 'user_description' ) as $filter ) {
40                 add_filter( $filter, 'wp_kses_data' );
41         }
42         add_filter( 'comment_text', 'wp_kses_post' );
43 }
44
45 // Email saves
46 foreach ( array( 'pre_comment_author_email', 'pre_user_email' ) as $filter ) {
47         add_filter( $filter, 'trim'           );
48         add_filter( $filter, 'sanitize_email' );
49         add_filter( $filter, 'wp_filter_kses' );
50 }
51
52 // Email admin display
53 foreach ( array( 'comment_author_email', 'user_email' ) as $filter ) {
54         add_filter( $filter, 'sanitize_email' );
55         if ( is_admin() )
56                 add_filter( $filter, 'wp_kses_data' );
57 }
58
59 // Save URL
60 foreach ( array( 'pre_comment_author_url', 'pre_user_url', 'pre_link_url', 'pre_link_image',
61         'pre_link_rss', 'pre_post_guid' ) as $filter ) {
62         add_filter( $filter, 'wp_strip_all_tags' );
63         add_filter( $filter, 'esc_url_raw'       );
64         add_filter( $filter, 'wp_filter_kses'    );
65 }
66
67 // Display URL
68 foreach ( array( 'user_url', 'link_url', 'link_image', 'link_rss', 'comment_url', 'post_guid' ) as $filter ) {
69         if ( is_admin() )
70                 add_filter( $filter, 'wp_strip_all_tags' );
71         add_filter( $filter, 'esc_url'           );
72         if ( is_admin() )
73                 add_filter( $filter, 'wp_kses_data'    );
74 }
75
76 // Slugs
77 add_filter( 'pre_term_slug', 'sanitize_title' );
78
79 // Keys
80 foreach ( array( 'pre_post_type', 'pre_post_status', 'pre_post_comment_status', 'pre_post_ping_status' ) as $filter ) {
81         add_filter( $filter, 'sanitize_key' );
82 }
83
84 // Mime types
85 add_filter( 'pre_post_mime_type', 'sanitize_mime_type' );
86 add_filter( 'post_mime_type', 'sanitize_mime_type' );
87
88 // Places to balance tags on input
89 foreach ( array( 'content_save_pre', 'excerpt_save_pre', 'comment_save_pre', 'pre_comment_content' ) as $filter ) {
90         add_filter( $filter, 'convert_invalid_entities' );
91         add_filter( $filter, 'balanceTags', 50 );
92 }
93
94 // Format strings for display.
95 foreach ( array( 'comment_author', 'term_name', 'link_name', 'link_description', 'link_notes', 'bloginfo', 'wp_title', 'widget_title' ) as $filter ) {
96         add_filter( $filter, 'wptexturize'   );
97         add_filter( $filter, 'convert_chars' );
98         add_filter( $filter, 'esc_html'      );
99 }
100
101 // Format WordPress
102 foreach ( array( 'the_content', 'the_title', 'wp_title' ) as $filter )
103         add_filter( $filter, 'capital_P_dangit', 11 );
104 add_filter( 'comment_text', 'capital_P_dangit', 31 );
105
106 // Format titles
107 foreach ( array( 'single_post_title', 'single_cat_title', 'single_tag_title', 'single_month_title', 'nav_menu_attr_title', 'nav_menu_description' ) as $filter ) {
108         add_filter( $filter, 'wptexturize' );
109         add_filter( $filter, 'strip_tags'  );
110 }
111
112 // Format text area for display.
113 foreach ( array( 'term_description' ) as $filter ) {
114         add_filter( $filter, 'wptexturize'      );
115         add_filter( $filter, 'convert_chars'    );
116         add_filter( $filter, 'wpautop'          );
117         add_filter( $filter, 'shortcode_unautop');
118 }
119
120 // Format for RSS
121 add_filter( 'term_name_rss', 'convert_chars' );
122
123 // Pre save hierarchy
124 add_filter( 'wp_insert_post_parent', 'wp_check_post_hierarchy_for_loops', 10, 2 );
125 add_filter( 'wp_update_term_parent', 'wp_check_term_hierarchy_for_loops', 10, 3 );
126
127 // Display filters
128 add_filter( 'the_title', 'wptexturize'   );
129 add_filter( 'the_title', 'convert_chars' );
130 add_filter( 'the_title', 'trim'          );
131
132 add_filter( 'the_content', 'wptexturize'        );
133 add_filter( 'the_content', 'convert_smilies'    );
134 add_filter( 'the_content', 'convert_chars'      );
135 add_filter( 'the_content', 'wpautop'            );
136 add_filter( 'the_content', 'shortcode_unautop'  );
137 add_filter( 'the_content', 'prepend_attachment' );
138
139 add_filter( 'the_excerpt',     'wptexturize'      );
140 add_filter( 'the_excerpt',     'convert_smilies'  );
141 add_filter( 'the_excerpt',     'convert_chars'    );
142 add_filter( 'the_excerpt',     'wpautop'          );
143 add_filter( 'the_excerpt',     'shortcode_unautop');
144 add_filter( 'get_the_excerpt', 'wp_trim_excerpt'  );
145
146 add_filter( 'comment_text', 'wptexturize'            );
147 add_filter( 'comment_text', 'convert_chars'          );
148 add_filter( 'comment_text', 'make_clickable',      9 );
149 add_filter( 'comment_text', 'force_balance_tags', 25 );
150 add_filter( 'comment_text', 'convert_smilies',    20 );
151 add_filter( 'comment_text', 'wpautop',            30 );
152
153 add_filter( 'comment_excerpt', 'convert_chars' );
154
155 add_filter( 'list_cats',         'wptexturize' );
156
157 add_filter( 'wp_sprintf', 'wp_sprintf_l', 10, 2 );
158
159 // RSS filters
160 add_filter( 'the_title_rss',      'strip_tags'                    );
161 add_filter( 'the_title_rss',      'ent2ncr',                    8 );
162 add_filter( 'the_title_rss',      'esc_html'                      );
163 add_filter( 'the_content_rss',    'ent2ncr',                    8 );
164 add_filter( 'the_content_feed',   'wp_staticize_emoji'            );
165 add_filter( 'the_excerpt_rss',    'convert_chars'                 );
166 add_filter( 'the_excerpt_rss',    'ent2ncr',                    8 );
167 add_filter( 'comment_author_rss', 'ent2ncr',                    8 );
168 add_filter( 'comment_text_rss',   'ent2ncr',                    8 );
169 add_filter( 'comment_text_rss',   'esc_html'                      );
170 add_filter( 'comment_text_rss',   'wp_staticize_emoji'            );
171 add_filter( 'bloginfo_rss',       'ent2ncr',                    8 );
172 add_filter( 'the_author',         'ent2ncr',                    8 );
173 add_filter( 'the_guid',           'esc_url'                       );
174
175 // Email filters
176 add_filter( 'wp_mail', 'wp_staticize_emoji_for_email' );
177
178 // Misc filters
179 add_filter( 'option_ping_sites',        'privacy_ping_filter'                 );
180 add_filter( 'option_blog_charset',      '_wp_specialchars'                    ); // IMPORTANT: This must not be wp_specialchars() or esc_html() or it'll cause an infinite loop
181 add_filter( 'option_blog_charset',      '_canonical_charset'                  );
182 add_filter( 'option_home',              '_config_wp_home'                     );
183 add_filter( 'option_siteurl',           '_config_wp_siteurl'                  );
184 add_filter( 'tiny_mce_before_init',     '_mce_set_direction'                  );
185 add_filter( 'teeny_mce_before_init',    '_mce_set_direction'                  );
186 add_filter( 'pre_kses',                 'wp_pre_kses_less_than'               );
187 add_filter( 'sanitize_title',           'sanitize_title_with_dashes',   10, 3 );
188 add_action( 'check_comment_flood',      'check_comment_flood_db',       10, 3 );
189 add_filter( 'comment_flood_filter',     'wp_throttle_comment_flood',    10, 3 );
190 add_filter( 'pre_comment_content',      'wp_rel_nofollow',              15    );
191 add_filter( 'comment_email',            'antispambot'                         );
192 add_filter( 'option_tag_base',          '_wp_filter_taxonomy_base'            );
193 add_filter( 'option_category_base',     '_wp_filter_taxonomy_base'            );
194 add_filter( 'the_posts',                '_close_comments_for_old_posts', 10, 2);
195 add_filter( 'comments_open',            '_close_comments_for_old_post', 10, 2 );
196 add_filter( 'pings_open',               '_close_comments_for_old_post', 10, 2 );
197 add_filter( 'editable_slug',            'urldecode'                           );
198 add_filter( 'editable_slug',            'esc_textarea'                        );
199 add_filter( 'nav_menu_meta_box_object', '_wp_nav_menu_meta_box_object'        );
200 add_filter( 'pingback_ping_source_uri', 'pingback_ping_source_uri'            );
201 add_filter( 'xmlrpc_pingback_error',    'xmlrpc_pingback_error'               );
202 add_filter( 'title_save_pre',           'trim'                                );
203
204 add_filter( 'http_request_host_is_external', 'allowed_http_request_hosts', 10, 2 );
205
206 // Actions
207 add_action( 'wp_head',             '_wp_render_title_tag',            1     );
208 add_action( 'wp_head',             'wp_enqueue_scripts',              1     );
209 add_action( 'wp_head',             'feed_links',                      2     );
210 add_action( 'wp_head',             'feed_links_extra',                3     );
211 add_action( 'wp_head',             'rsd_link'                               );
212 add_action( 'wp_head',             'wlwmanifest_link'                       );
213 add_action( 'wp_head',             'adjacent_posts_rel_link_wp_head', 10, 0 );
214 add_action( 'wp_head',             'locale_stylesheet'                      );
215 add_action( 'publish_future_post', 'check_and_publish_future_post',   10, 1 );
216 add_action( 'wp_head',             'noindex',                          1    );
217 add_action( 'wp_head',             'print_emoji_detection_script',     7    );
218 add_action( 'wp_head',             'wp_print_styles',                  8    );
219 add_action( 'wp_head',             'wp_print_head_scripts',            9    );
220 add_action( 'wp_head',             'wp_generator'                           );
221 add_action( 'wp_head',             'rel_canonical'                          );
222 add_action( 'wp_head',             'wp_shortlink_wp_head',            10, 0 );
223 add_action( 'wp_head',             'wp_site_icon',                    99    );
224 add_action( 'wp_footer',           'wp_print_footer_scripts',         20    );
225 add_action( 'template_redirect',   'wp_shortlink_header',             11, 0 );
226 add_action( 'wp_print_footer_scripts', '_wp_footer_scripts'                 );
227 add_action( 'init',                'check_theme_switched',            99    );
228 add_action( 'after_switch_theme',  '_wp_sidebars_changed'                   );
229 add_action( 'wp_print_styles',     'print_emoji_styles'                     );
230
231 if ( isset( $_GET['replytocom'] ) )
232     add_action( 'wp_head', 'wp_no_robots' );
233
234 // Login actions
235 add_action( 'login_head',          'wp_print_head_scripts',         9     );
236 add_action( 'login_footer',        'wp_print_footer_scripts',       20    );
237 add_action( 'login_init',          'send_frame_options_header',     10, 0 );
238
239 // Feed Generator Tags
240 foreach ( array( 'rss2_head', 'commentsrss2_head', 'rss_head', 'rdf_header', 'atom_head', 'comments_atom_head', 'opml_head', 'app_head' ) as $action ) {
241         add_action( $action, 'the_generator' );
242 }
243
244 // Feed Site Icon
245 add_action( 'atom_head', 'atom_site_icon' );
246 add_action( 'rss2_head', 'rss2_site_icon' );
247
248
249 // WP Cron
250 if ( !defined( 'DOING_CRON' ) )
251         add_action( 'init', 'wp_cron' );
252
253 // 2 Actions 2 Furious
254 add_action( 'do_feed_rdf',                'do_feed_rdf',                             10, 1 );
255 add_action( 'do_feed_rss',                'do_feed_rss',                             10, 1 );
256 add_action( 'do_feed_rss2',               'do_feed_rss2',                            10, 1 );
257 add_action( 'do_feed_atom',               'do_feed_atom',                            10, 1 );
258 add_action( 'do_pings',                   'do_all_pings',                            10, 1 );
259 add_action( 'do_robots',                  'do_robots'                                      );
260 add_action( 'set_comment_cookies',        'wp_set_comment_cookies',                  10, 2 );
261 add_action( 'sanitize_comment_cookies',   'sanitize_comment_cookies'                       );
262 add_action( 'admin_print_scripts',        'print_emoji_detection_script'                   );
263 add_action( 'admin_print_scripts',        'print_head_scripts',                      20    );
264 add_action( 'admin_print_footer_scripts', '_wp_footer_scripts'                             );
265 add_action( 'admin_print_styles',         'print_emoji_styles'                             );
266 add_action( 'admin_print_styles',         'print_admin_styles',                      20    );
267 add_action( 'init',                       'smilies_init',                             5    );
268 add_action( 'plugins_loaded',             'wp_maybe_load_widgets',                    0    );
269 add_action( 'plugins_loaded',             'wp_maybe_load_embeds',                     0    );
270 add_action( 'shutdown',                   'wp_ob_end_flush_all',                      1    );
271 // Create a revision whenever a post is updated.
272 add_action( 'post_updated',               'wp_save_post_revision',                   10, 1 );
273 add_action( 'publish_post',               '_publish_post_hook',                       5, 1 );
274 add_action( 'transition_post_status',     '_transition_post_status',                  5, 3 );
275 add_action( 'transition_post_status',     '_update_term_count_on_transition_post_status', 10, 3 );
276 add_action( 'comment_form',               'wp_comment_form_unfiltered_html_nonce'          );
277 add_action( 'wp_scheduled_delete',        'wp_scheduled_delete'                            );
278 add_action( 'wp_scheduled_auto_draft_delete', 'wp_delete_auto_drafts'                      );
279 add_action( 'admin_init',                 'send_frame_options_header',               10, 0 );
280 add_action( 'importer_scheduled_cleanup', 'wp_delete_attachment'                           );
281 add_action( 'upgrader_scheduled_cleanup', 'wp_delete_attachment'                           );
282 add_action( 'welcome_panel',              'wp_welcome_panel'                               );
283
284 // Navigation menu actions
285 add_action( 'delete_post',                '_wp_delete_post_menu_item'         );
286 add_action( 'delete_term',                '_wp_delete_tax_menu_item',   10, 3 );
287 add_action( 'transition_post_status',     '_wp_auto_add_pages_to_menu', 10, 3 );
288
289 // Post Thumbnail CSS class filtering
290 add_action( 'begin_fetch_post_thumbnail_html', '_wp_post_thumbnail_class_filter_add'    );
291 add_action( 'end_fetch_post_thumbnail_html',   '_wp_post_thumbnail_class_filter_remove' );
292
293 // Redirect Old Slugs
294 add_action( 'template_redirect', 'wp_old_slug_redirect'              );
295 add_action( 'post_updated',      'wp_check_for_changed_slugs', 12, 3 );
296
297 // Nonce check for Post Previews
298 add_action( 'init', '_show_post_preview' );
299
300 // Output JS to reset window.name for previews
301 add_action( 'wp_head', 'wp_post_preview_js', 1 );
302
303 // Timezone
304 add_filter( 'pre_option_gmt_offset','wp_timezone_override_offset' );
305
306 // Admin Color Schemes
307 add_action( 'admin_init', 'register_admin_color_schemes', 1);
308 add_action( 'admin_color_scheme_picker', 'admin_color_scheme_picker' );
309
310 // If the upgrade hasn't run yet, assume link manager is used.
311 add_filter( 'default_option_link_manager_enabled', '__return_true' );
312
313 // This option no longer exists; tell plugins we always support auto-embedding.
314 add_filter( 'default_option_embed_autourls', '__return_true' );
315
316 // Default settings for heartbeat
317 add_filter( 'heartbeat_settings', 'wp_heartbeat_settings' );
318
319 // Check if the user is logged out
320 add_action( 'admin_enqueue_scripts', 'wp_auth_check_load' );
321 add_filter( 'heartbeat_send',        'wp_auth_check' );
322 add_filter( 'heartbeat_nopriv_send', 'wp_auth_check' );
323
324 // Default authentication filters
325 add_filter( 'authenticate', 'wp_authenticate_username_password',  20, 3 );
326 add_filter( 'authenticate', 'wp_authenticate_spam_check',         99    );
327 add_filter( 'determine_current_user', 'wp_validate_auth_cookie'          );
328 add_filter( 'determine_current_user', 'wp_validate_logged_in_cookie', 20 );
329
330 // Split term updates.
331 add_action( 'admin_init',        '_wp_check_for_scheduled_split_terms' );
332 add_action( 'split_shared_term', '_wp_check_split_default_terms',  10, 4 );
333 add_action( 'split_shared_term', '_wp_check_split_terms_in_menus', 10, 4 );
334 add_action( 'split_shared_term', '_wp_check_split_nav_menu_terms', 10, 4 );
335 add_action( 'wp_split_shared_term_batch', '_wp_batch_split_terms' );
336
337 /**
338  * Filters formerly mixed into wp-includes
339  */
340 // Theme
341 add_action( 'wp_loaded', '_custom_header_background_just_in_time' );
342 add_action( 'plugins_loaded', '_wp_customize_include' );
343 add_action( 'admin_enqueue_scripts', '_wp_customize_loader_settings' );
344 add_action( 'delete_attachment', '_delete_attachment_theme_mod' );
345
346 // Calendar widget cache
347 add_action( 'save_post', 'delete_get_calendar_cache' );
348 add_action( 'delete_post', 'delete_get_calendar_cache' );
349 add_action( 'update_option_start_of_week', 'delete_get_calendar_cache' );
350 add_action( 'update_option_gmt_offset', 'delete_get_calendar_cache' );
351
352 // Author
353 add_action( 'transition_post_status', '__clear_multi_author_cache' );
354
355 // Post
356 add_action( 'init', 'create_initial_post_types', 0 ); // highest priority
357 add_action( 'admin_menu', '_add_post_type_submenus' );
358 add_action( 'before_delete_post', '_reset_front_page_settings_for_post' );
359 add_action( 'wp_trash_post',      '_reset_front_page_settings_for_post' );
360
361 // Post Formats
362 add_filter( 'request', '_post_format_request' );
363 add_filter( 'term_link', '_post_format_link', 10, 3 );
364 add_filter( 'get_post_format', '_post_format_get_term' );
365 add_filter( 'get_terms', '_post_format_get_terms', 10, 3 );
366 add_filter( 'wp_get_object_terms', '_post_format_wp_get_object_terms' );
367
368 // KSES
369 add_action( 'init', 'kses_init' );
370 add_action( 'set_current_user', 'kses_init' );
371
372 // Script Loader
373 add_action( 'wp_default_scripts', 'wp_default_scripts' );
374 add_filter( 'wp_print_scripts', 'wp_just_in_time_script_localization' );
375 add_filter( 'print_scripts_array', 'wp_prototype_before_jquery' );
376
377 add_action( 'wp_default_styles', 'wp_default_styles' );
378 add_filter( 'style_loader_src', 'wp_style_loader_src', 10, 2 );
379
380 // Taxonomy
381 add_action( 'init', 'create_initial_taxonomies', 0 ); // highest priority
382
383 // Canonical
384 add_action( 'template_redirect', 'redirect_canonical' );
385 add_action( 'template_redirect', 'wp_redirect_admin_locations', 1000 );
386
387 // Shortcodes
388 add_filter( 'the_content', 'do_shortcode', 11 ); // AFTER wpautop()
389
390 // Media
391 add_action( 'wp_playlist_scripts', 'wp_playlist_scripts' );
392 add_action( 'customize_controls_enqueue_scripts', 'wp_plupload_default_settings' );
393
394 // Nav menu
395 add_filter( 'nav_menu_item_id', '_nav_menu_item_id_use_once', 10, 2 );
396
397 // Widgets
398 add_action( 'init', 'wp_widgets_init', 1 );
399
400 // Admin Bar
401 // Don't remove. Wrong way to disable.
402 add_action( 'template_redirect', '_wp_admin_bar_init', 0 );
403 add_action( 'admin_init', '_wp_admin_bar_init' );
404 add_action( 'wp_footer', 'wp_admin_bar_render', 1000 );
405 add_action( 'in_admin_header', 'wp_admin_bar_render', 0 );
406
407 // Former admin filters that can also be hooked on the front end
408 add_action( 'media_buttons', 'media_buttons' );
409 add_filter( 'image_send_to_editor', 'image_add_caption', 20, 8 );
410 add_filter( 'media_send_to_editor', 'image_media_send_to_editor', 10, 3 );
411
412 unset( $filter, $action );