Eine auf WordPress spezialiserte Suchmaschine für Entwickler und Theme-Autoren



get_metadata_default ›

Seit5.5.0
Veraltetn/v
get_metadata_default ( $meta_type, $object_id, $meta_key, $single = false )
Parameter: (4)
  • (string) $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
    Erforderlich: Ja
  • (int) $object_id ID of the object metadata is for.
    Erforderlich: Ja
  • (string) $meta_key Metadata key.
    Erforderlich: Ja
  • (bool) $single Optional. If true, return only the first value of the specified meta_key. This parameter has no effect if meta_key is not specified. Default false.
    Erforderlich: Nein
    Standard: false
Gibt zurück:
  • (mixed) Single metadata value, or array of values.
Definiert in:
Codex:

Retrieves default metadata value for the specified object.

By default, an empty string is returned if $single is true, or an empty array if it's false.


Quellcode

function get_metadata_default( $meta_type, $object_id, $meta_key, $single = false ) {
	if ( $single ) {
		$value = '';
	} else {
		$value = array();
	}

	/**
	 * Filter the default value for a specified object.
	 *
	 * The dynamic portion of the hook, `$meta_type`, refers to the meta object type
	 * (post, comment, term, user, or any other type with an associated meta table).
	 *
	 * @since 5.5.0
	 *
	 * @param mixed  $value     The value to return, either a single metadata value or an array
	 *                          of values depending on the value of `$single`.
	 * @param int    $object_id ID of the object metadata is for.
	 * @param string $meta_key  Metadata key.
	 * @param bool   $single    Whether to return only the first value of the specified `$meta_key`.
	 * @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user',
	 *                          or any other object type with an associated meta table.
	 */
	$value = apply_filters( "default_{$meta_type}_metadata", $value, $object_id, $meta_key, $single, $meta_type );

	if ( ! $single && ! wp_is_numeric_array( $value ) ) {
		$value = array( $value );
	}

	return $value;
}