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
2902  *   trigger or false to not trigger error.
2903  *
2904  * @param string $file The file that was included
2905  * @param string $version The version of WordPress that deprecated the file
2906  * @param string $replacement Optional. The file that should have been included based on ABSPATH
2907  * @param string $message Optional. A message regarding the change
2908  */
2909 function _deprecated_file( $file, $version, $replacement = null, $message = '' ) {
2910
2911      do_action( 'deprecated_file_included', $file, $replacement, $version, $message );
2912
2913      // Allow plugin to filter the output error trigger
2914      if ( WP_DEBUG && apply_filters( 'deprecated_file_trigger_error', true ) ) {
2915           $message = empty( $message ) ? '' : ' ' . $message;
2916           if ( function_exists( '__' ) ) {
2917                if ( ! is_null( $replacement ) )
2918                     trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.'), $file, $version, $replacement ) . $message );
2919                else
2920                     trigger_error( sprintf( __('%1$s is <strong>deprecated</strong> since version %2$s with no alternative available.'), $file, $version ) . $message );