File "Post_Meta_Interface.php"
Full Path: /home/zcziejy/ryadselyen/plugins/google-site-kit/includes/Core/Storage/Post_Meta_Interface.php
File size: 1.98 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* Interface Google\Site_Kit\Core\Storage\Post_Meta_Interface
*
* @package Google\Site_Kit\Core\Storage
* @copyright 2021 Google LLC
* @license https://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0
* @link https://sitekit.withgoogle.com
*/
namespace Google\Site_Kit\Core\Storage;
/**
* Interface for Post_Meta implementations.
*
* @since 1.33.0
* @access private
* @ignore
*/
interface Post_Meta_Interface {
/**
* Gets post meta.
*
* @since 1.33.0
*
* @param int $post_id Post ID.
* @param string $key Metadata key.
* @param bool $single Whether to return a single value.
* @return mixed Post meta value.
*/
public function get( $post_id, $key, $single = false );
/**
* Updates a post meta field based on the given post ID.
*
* @since 1.33.0
*
* @param int $post_id Post ID.
* @param string $key Metadata key.
* @param mixed $value Metadata value.
* @param mixed $prev_value Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries.
* @return bool TRUE on success, otherwise FALSE.
*/
public function update( $post_id, $key, $value, $prev_value = '' );
/**
* Adds a meta field to the given post.
*
* @since 1.33.0
*
* @param int $post_id Post ID.
* @param string $key Metadata key.
* @param mixed $value Metadata value.
* @param bool $unique Whether the same key should not be added.
* @return int|bool Meta id on success, otherwise FALSE.
*/
public function add( $post_id, $key, $value, $unique = false );
/**
* Deletes a post meta field for the given post ID.
*
* @since 1.33.0
*
* @param int $post_id Post ID.
* @param string $key Metadata key.
* @param mixed $value Metadata value. If provided, rows will only be removed that match the value.
* @return bool TRUE on success, otherwise FALSE.
*/
public function delete( $post_id, $key, $value = '' );
}