Source View: deprecated_file_included

To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).

Understanding Source Code

The best way to understand what a hook does is to look at where it occurs in the source code.

  • Action hooks look like this: do_action( "hook_name" )
  • Filter hooks look like this: apply_filters( "hook_name", "what_to_filter" ).

Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.

Source View

Line Code
2707  * @uses do_action() Calls 'deprecated_file_included' and passes the file name and what to use instead.
2708  * @uses apply_filters() Calls 'deprecated_file_trigger_error' and expects boolean value of true to do trigger or false to not trigger error.
2709  *
2710  * @param string $file The file that was included
2711  * @param string $version The version of WordPress that deprecated the function
2712  * @param string $replacement Optional. The function that should have been called
2713  */
2714 function _deprecated_file($file, $version, $replacement=null) {
2716      do_action('deprecated_file_included', $file, $replacement);
2718      // Allow plugin to filter the output error trigger
2719      if( defined('WP_DEBUG') && ( true === WP_DEBUG ) && apply_filters( 'deprecated_file_trigger_error', true )) {
2720           if( !is_null($replacement) )
2721                trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) );
2722           else
2723                trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $file, $version ) );
2724      }
2725 }