Skip to content

Add Salary Range Field & JobSchema to WPJM #2633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
masteradhoc wants to merge 16 commits into
base: trunk
Choose a base branch
from
Open

Add Salary Range Field & JobSchema to WPJM #2633

Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
63796e0
Add Salary Range Features to WPJM Template
masteradhoc Nov 11, 2023
e19e6d3
add max salary to promoted jobs api
masteradhoc Nov 11, 2023
e8cb9c8
add max salary range to unset at form
masteradhoc Nov 11, 2023
78a54d4
add salaryrange field to posttype
masteradhoc Nov 11, 2023
e05baca
adjust template for salary range / job sumission fixes
masteradhoc Nov 11, 2023
5f2a42b
allow salary range also on job submit form
masteradhoc Nov 11, 2023
035741f
fix lint errors form-submit-job.php
masteradhoc Nov 11, 2023
7937d72
fix lint errors
masteradhoc Nov 11, 2023
c223e59
fix lint error
masteradhoc Nov 11, 2023
31f8686
fix lint
masteradhoc Nov 11, 2023
fe88660
finally fix jobs api lint
masteradhoc Nov 11, 2023
3345f22
fix lint errors
masteradhoc Nov 11, 2023
afb3b91
fix lint errors on class-wp-job-manager-post-types.php
masteradhoc Nov 11, 2023
47b476f
fix lint errors on last file
masteradhoc Nov 11, 2023
4edd900
add job_salary_max field to test class
masteradhoc Nov 11, 2023
5e35747
added argument in the end for backwards compatibility
masteradhoc Nov 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions includes/class-wp-job-manager-post-types.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,6 +700,7 @@ public function job_feed_item() {
$company = get_the_company_name( $post_id );
$job_types = wpjm_get_the_job_types( $post_id );
$salary = get_the_job_salary( $post_id );
$salarymax = get_the_job_salary_max( $post_id );

if ( $location ) {
echo '<job_listing:location><![CDATA[' . esc_html( $location ) . "]]></job_listing:location>\n";
Expand All @@ -714,6 +715,9 @@ public function job_feed_item() {
if ( $salary ) {
echo '<job_listing:salary><![CDATA[' . esc_html( $salary ) . "]]></job_listing:salary>\n";
}
if ( $salarymax ) {
echo '<job_listing:salarymax><![CDATA[' . esc_html( $salarymax ) . "]]></job_listing:salarymax>\n";
}

/**
* Fires at the end of each job RSS feed item.
Expand Down Expand Up @@ -1605,7 +1609,7 @@ public static function get_job_listing_fields() {
'show_in_rest' => true,
],
'_job_salary' => [
'label' => __( 'Salary', 'wp-job-manager' ),
'label' => __( 'Salary / Salary (min)', 'wp-job-manager' ),
'type' => 'text',
'placeholder' => __( 'e.g. 20000', 'wp-job-manager' ),
'priority' => 13,
Expand All @@ -1614,12 +1618,22 @@ public static function get_job_listing_fields() {
'show_in_admin' => (bool) get_option( 'job_manager_enable_salary' ),
'show_in_rest' => true,
],
'_job_salary_max' => [
'label' => __( 'Salary (max)', 'wp-job-manager' ),
'type' => 'text',
'placeholder' => __( 'e.g. 25000', 'wp-job-manager' ),
'priority' => 14,
'description' => __( 'Add a max salary field, this field is optional.', 'wp-job-manager' ),
'data_type' => 'string',
'show_in_admin' => (bool) get_option( 'job_manager_enable_salary' ),
'show_in_rest' => true,
],
'_job_salary_currency' => [
'label' => __( 'Salary Currency', 'wp-job-manager' ),
'type' => 'text',
'data_type' => 'string',
'placeholder' => __( 'e.g. USD', 'wp-job-manager' ),
'priority' => 14,
'priority' => 15,
'description' => __( 'Add a salary currency, this field is optional. Leave it empty to use the default salary currency.', 'wp-job-manager' ),
'default' => '',
'show_in_admin' => get_option( 'job_manager_enable_salary' ) && get_option( 'job_manager_enable_salary_currency' ),
Expand All @@ -1630,7 +1644,7 @@ public static function get_job_listing_fields() {
'type' => 'select',
'data_type' => 'string',
'options' => job_manager_get_salary_unit_options(),
'priority' => 15,
'priority' => 16,
'description' => __( 'Add a salary period unit, this field is optional. Leave it empty to use the default salary unit, if one is defined.', 'wp-job-manager' ),
'default' => '',
'show_in_admin' => get_option( 'job_manager_enable_salary' ) && get_option( 'job_manager_enable_salary_unit' ),
Expand Down
15 changes: 11 additions & 4 deletions includes/forms/class-wp-job-manager-form-submit-job.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,27 +276,34 @@ public function init_fields() {
'priority' => 7,
],
'job_salary' => [
'label' => __( 'Salary', 'wp-job-manager' ),
'label' => __( 'Salary / Salary (min)', 'wp-job-manager' ),
'type' => 'text',
'required' => false,
'placeholder' => __( 'e.g. 20000', 'wp-job-manager' ),
'priority' => 8,
],
'job_salary_max' => [
'label' => __( 'Salary (max)', 'wp-job-manager' ),
'type' => 'text',
'required' => false,
'placeholder' => __( 'e.g. 25000', 'wp-job-manager' ),
'priority' => 9,
],
'job_salary_currency' => [
'label' => __( 'Salary Currency', 'wp-job-manager' ),
'type' => 'text',
'required' => false,
'placeholder' => __( 'e.g. USD', 'wp-job-manager' ),
'description' => __( 'Add a salary currency, this field is optional. Leave it empty to use the default salary currency.', 'wp-job-manager' ),
'priority' => 9,
'priority' => 10,
],
'job_salary_unit' => [
'label' => __( 'Salary Unit', 'wp-job-manager' ),
'type' => 'select',
'options' => job_manager_get_salary_unit_options(),
'description' => __( 'Add a salary period unit, this field is optional. Leave it empty to use the default salary unit, if one is defined.', 'wp-job-manager' ),
'required' => false,
'priority' => 10,
'priority' => 11,
],
],
'company' => [
Expand Down Expand Up @@ -371,7 +378,7 @@ public function init_fields() {
unset( $this->fields['job']['job_salary_unit'] );
}
} else {
unset( $this->fields['job']['job_salary'], $this->fields['job']['job_salary_currency'], $this->fields['job']['job_salary_unit'] );
unset( $this->fields['job']['job_salary'], $this->fields['job']['job_salary_max'], $this->fields['job']['job_salary_currency'], $this->fields['job']['job_salary_unit'] );
}
if ( ! get_option( 'job_manager_enable_remote_position' ) ) {
unset( $this->fields['job']['remote_position'] );
Expand Down
7 changes: 4 additions & 3 deletions includes/promoted-jobs/class-wp-job-manager-promoted-jobs-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,9 +242,10 @@ private function prepare_item_for_response( WP_Post $item ) {
'is_remote' => (bool) get_post_meta( $item->ID, '_remote_position', true ),
'job_type' => $terms_array,
'salary' => [
'amount' => get_post_meta( $item->ID, '_job_salary', true ),
'currency' => get_the_job_salary_currency( $item ),
'unit' => get_the_job_salary_unit_display_text( $item ),
'amount' => get_post_meta( $item->ID, '_job_salary', true ),
'amountmax' => get_post_meta( $item->ID, '_job_salary_max', true ),
'currency' => get_the_job_salary_currency( $item ),
'unit' => get_the_job_salary_unit_display_text( $item ),
],
];
}
Expand Down
6 changes: 3 additions & 3 deletions tests/php/tests/includes/rest-api/test_class.wp-job-manager-job-listings.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ public function test_get_job_listings_success_guest() {
* Tests to make sure public meta fields are exposed to guest users and private meta fields are hidden.
*/
public function test_guest_can_read_only_public_fields() {
$public_fields = [ '_job_location', '_application', '_company_name', '_company_website', '_company_tagline', '_company_twitter', '_company_video', '_filled', '_featured', '_remote_position', '_job_salary', '_job_salary_currency', '_job_salary_unit' ];
$public_fields = [ '_job_location', '_application', '_company_name', '_company_website', '_company_tagline', '_company_twitter', '_company_video', '_filled', '_featured', '_remote_position', '_job_salary', '_job_salary_max', '_job_salary_currency', '_job_salary_unit' ];
$private_fields = [ '_job_expires' ];
$this->logout();
$post_id = $this->get_job_listing();
Expand All @@ -192,7 +192,7 @@ public function test_guest_can_read_only_public_fields() {
}

public function test_same_employer_read_access_to_private_meta_fields() {
$available_fields = [ '_job_location', '_application', '_company_name', '_company_website', '_company_tagline', '_company_twitter', '_company_video', '_filled', '_featured', '_job_expires', '_remote_position', '_job_salary', '_job_salary_currency', '_job_salary_unit' ];
$available_fields = [ '_job_location', '_application', '_company_name', '_company_website', '_company_tagline', '_company_twitter', '_company_video', '_filled', '_featured', '_job_expires', '_remote_position', '_job_salary', '_job_salary_max', '_job_salary_currency', '_job_salary_unit' ];
$this->login_as_employer();
$post_id = $this->get_job_listing();

Expand All @@ -207,7 +207,7 @@ public function test_same_employer_read_access_to_private_meta_fields() {
}

public function test_different_employer_read_access_to_private_meta_fields() {
$public_fields = [ '_job_location', '_application', '_company_name', '_company_website', '_company_tagline', '_company_twitter', '_company_video', '_filled', '_featured', '_remote_position', '_job_salary', '_job_salary_currency', '_job_salary_unit' ];
$public_fields = [ '_job_location', '_application', '_company_name', '_company_website', '_company_tagline', '_company_twitter', '_company_video', '_filled', '_featured', '_remote_position', '_job_salary', '_job_salary_max', '_job_salary_currency', '_job_salary_unit' ];
$private_fields = [ '_job_expires' ];
$this->login_as_employer();
$post_id = $this->get_job_listing();
Expand Down
59 changes: 50 additions & 9 deletions wp-job-manager-template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,10 +418,19 @@ function wpjm_get_job_listing_structured_data( $post = null ) {
}
}

$salary = get_the_job_salary( $post );
$currency = get_the_job_salary_currency( $post );
$unit = get_the_job_salary_unit( $post );
if ( ! empty( $salary ) ) {
$salary = get_the_job_salary( $post );
$salary_max = get_the_job_salary_max( $post );
$currency = get_the_job_salary_currency( $post );
$unit = get_the_job_salary_unit( $post );
if ( ! empty( $salary_max ) ) {
$data['baseSalary'] = [];
$data['baseSalary']['@type'] = 'MonetaryAmount';
$data['baseSalary']['currency'] = $currency;
$data['baseSalary']['value']['@type'] = 'QuantitativeValue';
$data['baseSalary']['value']['minValue'] = $salary;
$data['baseSalary']['value']['maxValue'] = $salary_max;
$data['baseSalary']['value']['unitText'] = $unit;
} elseif ( ! empty( $salary ) ) {
$data['baseSalary'] = [];
$data['baseSalary']['@type'] = 'MonetaryAmount';
$data['baseSalary']['currency'] = $currency;
Expand Down Expand Up @@ -1298,6 +1307,33 @@ function get_the_job_salary( $post = null ) {
return apply_filters( 'the_job_salary', $job_salary, $post );
}

/**
* Gets the max job salary.
*
* @since 1.37.0
* @param int|WP_Post|null $post (default: null).
* @return string|null
*/
function get_the_job_salary_max( $post = null ) {
$post = get_post( $post );
if ( ! $post || 'job_listing' !== $post->post_type ) {
return;
}

$job_salary_max = $post->_job_salary_max;

/**
* Filter the returned max job salary.
*
* @since 1.36.0
*
* @param string $job_salary_max
* @param WP_Post $post
*/
return apply_filters( 'the_job_salary_max', $job_salary_max, $post );
}


/**
* Displays or retrieves the job salary with optional content.
*
Expand All @@ -1309,16 +1345,20 @@ function get_the_job_salary( $post = null ) {
* @return string|void
*/
function the_job_salary( $before = '', $after = '', $echo = true, $post = null ) {
$post = get_post( $post );
$salary = get_the_job_salary( $post );
$currency = get_the_job_salary_currency( $post );
$unit = get_the_job_salary_unit_display_text( $post );
$post = get_post( $post );
$salary = get_the_job_salary( $post );
$salarymax = get_the_job_salary_max( $post );
$currency = get_the_job_salary_currency( $post );
$unit = get_the_job_salary_unit_display_text( $post );

if ( strlen( $salary ) === 0 ) {
return;
}

$job_salary = $before . $salary . ' ' . $currency;
if ( ! empty( $salarymax ) ) {
$job_salary .= ' - ' . $salarymax . ' ' . $currency;
}
if ( ! empty( $unit ) ) {
$job_salary .= ' / ' . $unit;
}
Expand All @@ -1332,11 +1372,12 @@ function the_job_salary( $before = '', $after = '', $echo = true, $post = null )
* @param WP_Post $post
* @param string $before
* @param string $salary
* @param string $salarymax
* @param string $currency
* @param string $unit
* @param string $after
*/
$job_salary = apply_filters( 'the_job_salary_message', $job_salary, $post, $before, $salary, $currency, $unit, $after );
$job_salary = apply_filters( 'the_job_salary_message', $job_salary, $post, $before, $salary, $currency, $salarymax, $unit, $after );
Copy link
Copy Markdown
Contributor

@thedebian thedebian Nov 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might break existing integrations

Copy link
Copy Markdown
Contributor Author

@masteradhoc masteradhoc Nov 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thedebian what do you suggest?

Copy link
Copy Markdown
Contributor

@thedebian thedebian Nov 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question, I don't have an empirical solution to that, it can be anything from adding the param after $after, to changing $salary to be a concatenation of $min . '-' . $max, if it's a salary range .
I'd prefer the second option, as $salary is documented as string, it wouldn't break the contract, @gkaragia do you have an idea ?

Copy link
Copy Markdown
Contributor

@gikaragia gikaragia Nov 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think appending it as an extra argument in the end is the safest.

If we don't add it as an extra argument and concatenate instead, this will break existing sites that use the $after function argument or specify a $unit. In these cases the job salary mind end up with weird values in the filter.


if ( $echo ) {
echo esc_html( $job_salary );
Expand Down