_deprecated_function( string $function_name, string $version, string $replacement = '' )

Description

Parameters

$function_namestring

The function that was called.

$versionstring

The version of WordPress that deprecated the function.

$replacementstringoptional

The function that should have been called. Default empty string.Default: ''

Hooks fired · 2

2 hooks fire while _deprecated_function() runs, in this order:

1. 1
   do_action( deprecated_function_run )actionline 5552 (+11 into the body)

   Fires when a deprecated function is called.

2. 2
   apply_filters( deprecated_function_trigger_error )filterline 5561 (+20 into the body)

   Filters whether to trigger an error for deprecated functions.

Uses · 4

• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.

Used by · 50

• Custom_Image_Header::create_attachment_object()Creates an attachment 'object'.
• Services_JSON::__construct()constructs a new JSON instance
• Services_JSON::_encode()PRIVATE CODE that does the work of encodes an arbitrary variable into JSON format
• Services_JSON::decode()decodes a JSON string into appropriate variable
• Services_JSON::encode()encodes an arbitrary variable into JSON format (and sends JSON Header)
• Services_JSON::encodeUnsafe()encodes an arbitrary variable into JSON format without JSON Header - warning - may allow XSS!!!!)
• Services_JSON::isError()
• Services_JSON::name_value()array-walking function for use in generating JSON-formatted name-value pairs
• Services_JSON::reduce_string()reduce a string by removing leading and trailing comments and whitespace
• Services_JSON::strlen8()Calculates length of string in bytes
• Services_JSON::substr8()Returns part of a string, interpreting $start and $length as number of bytes.
• Services_JSON::utf162utf8()convert a string from one UTF-16 char to one UTF-8 char

Source

View on Trac ↗View on GitHub ↗

5541function _deprecated_function( $function_name, $version, $replacement = '' ) {5542 5543	/**5544	 * Fires when a deprecated function is called.5545	 *5546	 * @since 2.5.05547	 *5548	 * @param string $function_name The function that was called.5549	 * @param string $replacement   The function that should have been called.5550	 * @param string $version       The version of WordPress that deprecated the function.5551	 */5552	do_action( 'deprecated_function_run', $function_name, $replacement, $version );5553 5554	/**5555	 * Filters whether to trigger an error for deprecated functions.5556	 *5557	 * @since 2.5.05558	 *5559	 * @param bool $trigger Whether to trigger the error for deprecated functions. Default true.5560	 */5561	if ( WP_DEBUG && apply_filters( 'deprecated_function_trigger_error', true ) ) {5562		if ( function_exists( '__' ) ) {5563			if ( $replacement ) {5564				$message = sprintf(5565					/* translators: 1: PHP function name, 2: Version number, 3: Alternative function name. */5566					__( 'Function %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),5567					$function_name,5568					$version,5569					$replacement5570				);5571			} else {5572				$message = sprintf(5573					/* translators: 1: PHP function name, 2: Version number. */5574					__( 'Function %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ),5575					$function_name,5576					$version5577				);5578			}5579		} else {5580			if ( $replacement ) {5581				$message = sprintf(5582					'Function %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',5583					$function_name,5584					$version,5585					$replacement5586				);5587			} else {5588				$message = sprintf(5589					'Function %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.',5590					$function_name,5591					$version5592				);5593			}5594		}5595 5596		wp_trigger_error( '', $message, E_USER_DEPRECATED );5597	}5598}

History

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.