Overview

Namespaces

  • Varunsridharan
    • WordPress

Classes

  • Post
  • Overview
  • Namespace
  • Class

Class Post

Class Post

Namespace: Varunsridharan\WordPress
Package: Varunsridharan\WordPress
Author: Varun Sridharan varunsridharan23@gmail.com
Since: 1.0
Located at src/Post.php
Methods summary
public
# __construct( integer|string $post = '' )

VS_WP_Post constructor.

VS_WP_Post constructor.

Parameters

$post
protected
# set_post( $post )

Sets Post Data.

Sets Post Data.

Parameters

$post
public boolean|mixed
# __get( $name )

Parameters

$name

Returns

boolean|mixed
public
# __set( $name, $value )

Sets A Value to $data array

Sets A Value to $data array

Parameters

$name
$value

Uses

\VS_WP_Post::$data
public null
# id( )

Returns Post ID.

Returns Post ID.

Returns

null
public null
# post( )

Returns Post Object.

Returns Post Object.

Returns

null
public boolean
# has_featured_image( )

Checks If Post Has Featured Image.

Checks If Post Has Featured Image.

Returns

boolean
public boolean|integer|mixed|string
# featured_image_id( )

Returns Featured Image ID.

Returns Featured Image ID.

Returns

boolean|integer|mixed|string
public false|string
# featured_image_url( string $size = 'thumbnail', string $default = '' )

Returns Featured Image URL.

Returns Featured Image URL.

Parameters

$size
$default

Returns

false|string
public false|string
# permalink( )

Returns Post Permalink.

Returns Post Permalink.

Returns

false|string
public boolean
# author( boolean|boolean $only_id = true )

Returns Post Author.

Returns Post Author.

Parameters

$only_id

Returns

boolean
public boolean
# has_content( )

Checks if post has content.

Checks if post has content.

Returns

boolean
public boolean
# has_excerpt( )

Checks if post has post_excerpt.

Checks if post has post_excerpt.

Returns

boolean
public mixed
# title( )

Returns Post Title.

Returns Post Title.

Returns

mixed
public string
# slug( )

Returns Post Slug.

Returns Post Slug.

Returns

string
public integer
# parent( boolean $only_id = true )

Returns Post Parent.

Returns Post Parent.

Parameters

$only_id

Returns

integer
public string
# type( )

Returns Current Post Type.

Returns Current Post Type.

Returns

string
public string
# page_template( )

Returns Page Template.

Returns Page Template.

Returns

string
public mixed
# excerpt( )

Returns Post post_excerpt.

Returns Post post_excerpt.

Returns

mixed
public string
# content( )

Returns Post Content.

Returns Post Content.

Returns

string
public mixed
# status( )

Returns Post Status.

Returns Post Status.

Returns

mixed
public boolean
# is_status( string $status = 'publish' )

Checks if given status is post status.

Checks if given status is post status.

Parameters

$status

Returns

boolean
public mixed
# get_meta( string $meta_key = '', string $default = '' )

Gets Post Meta For the given meta key.

Gets Post Meta For the given meta key.

Parameters

$meta_key
$default

Returns

mixed
public boolean|integer
# update_meta( string $meta_key = '', string $values = '', string $prev_values = '' )

Updates Post Meta.

Updates Post Meta.

Parameters

$meta_key
$values
$prev_values

Returns

boolean|integer
public boolean|integer
# add_meta( string $meta_key = '', string $values = '', boolean|boolean $unique = false )

Adds Post Meta.

Adds Post Meta.

Parameters

$meta_key
$values
$unique

Returns

boolean|integer
public boolean
# delete_meta( string $meta_key = '', mixed $values = '' )

Deletes A Post Meta.

Deletes A Post Meta.

Parameters

$meta_key
$values

Returns

boolean
public array
# taxonomies( )

Returns All Post Taxonomies.

Returns All Post Taxonomies.

Returns

array
public array|WP_Error
# get_terms( string $taxonomy = '', array $args = array() )

Returns All Terms From Post.

Returns All Terms From Post.

Parameters

$taxonomy
$args

Returns

array|WP_Error
public array|false|WP_Error
# set_terms( array $terms = array(), string $taxonomy = '', boolean $append = false )

Sets Given Terms With Tax To The Current Post.

Sets Given Terms With Tax To The Current Post.

Parameters

$terms
$taxonomy
$append

Returns

array|false|WP_Error
public boolean|string
# in( string $key = '', string $data = '', boolean $default = false )

Checks if given key is in array

Checks if given key is in array

Parameters

$key
$data
$default

Returns

boolean|string

Uses

\in_array()
\VS_WP_Post

Example

in('somekey','post_category','no') post_category will be taken from post data.
in('somekey',array('somekey' => 'somekey'), will be used the given array.
Properties summary
public string $version

Post Version

Post Version

# '1.0'
protected null $id

Post id

Post id

# null
protected null|WP_Post $post

Post Object.

Post Object.

# null
protected array $taxes

Returns All Taxonomies.

Returns All Taxonomies.

# array()
protected array $data

All Post Data.

All Post Data.

# array()
API documentation generated by ApiGen